Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit c5be8f8a authored by Christopher Tate's avatar Christopher Tate Committed by Chris Tate
Browse files

Correct docs about what is ignored in full-data backup

You can't back up content in e.g. getNoBackupFilesDir() even if your
app explicitly tries to.

Bug 28321431

Change-Id: Ifa2a4bc518de03aba4c8809e60d8bb90fce767f8
parent 47384f90
Loading
Loading
Loading
Loading
+5 −3
Original line number Diff line number Diff line
@@ -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.