am 56bf2f67: Merge "Clarify FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET usage" into klp-modular-dev
* commit '56bf2f670c800f569fc72102e79fd555b6102677':
Clarify FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET usage
diff --git a/core/java/android/content/Intent.java b/core/java/android/content/Intent.java
index 3c66b68..11ac15f 100644
--- a/core/java/android/content/Intent.java
+++ b/core/java/android/content/Intent.java
@@ -3538,6 +3538,11 @@
* it will be finished so that the user does not return to them, but
* instead returns to whatever activity preceeded it.
*
+ * <p>When this flag is assigned to the root activity all activities up
+ * to, but not including the root activity, will be cleared. This prevents
+ * this flag from being used to finish all activities in a task and thereby
+ * ending the task.
+ *
* <p>This is useful for cases where you have a logical break in your
* application. For example, an e-mail application may have a command
* to view an attachment, which launches an image view activity to