summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--core/java/android/app/backup/BackupAgent.java8
1 files changed, 5 insertions, 3 deletions
diff --git a/core/java/android/app/backup/BackupAgent.java b/core/java/android/app/backup/BackupAgent.java
index 8e515e2b579c..bc8280681e4a 100644
--- a/core/java/android/app/backup/BackupAgent.java
+++ b/core/java/android/app/backup/BackupAgent.java
@@ -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.