Correct docs about what is ignored in full-data backup

am: c5be8f8a4b

* commit 'c5be8f8a4b9946f26f43201a06e7ec3f9b34857e':
  Correct docs about what is ignored in full-data backup

Change-Id: If70b6d247126758dcc82ec7780060ad99253a32d
This commit is contained in:
Christopher Tate
2016-05-05 22:31:54 +00:00
committed by android-build-merger

View File

@@ -488,9 +488,11 @@ public abstract class BackupAgent extends ContextWrapper {
* to place it with the proper location and permissions on the device where the
* data is restored.
*
* <p class="note">It is safe to explicitly back up files underneath your application's
* {@link #getNoBackupFilesDir()} directory, and they will be restored to that
* location correctly.
* <p class="note">Attempting to back up files in directories that are ignored by
* the backup system will have no effect. For example, if the app calls this method
* with a file inside the {@link #getNoBackupFilesDir()} directory, it will be ignored.
* See {@link #onFullBackup(FullBackupDataOutput) for details on what directories
* are excluded from backups.
*
* @param file The file to be backed up. The file must exist and be readable by
* the caller.