summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Jiyong Park <jiyong@google.com> 2019-09-21 14:03:09 +0900
committer Jiyong Park <jiyong@google.com> 2019-09-24 14:52:36 +0900
commit09c730b19743a133effb432f7f2bd33d601ee4cd (patch)
tree5b118cf6e6c567827b7c36c0313bcb6c11c43513
parent763cb4638a1ed6124569b71307ca9a78373326a1 (diff)
Add documentation for *.sysprop
Bug: 141246285 Test: N/A Change-Id: Ia90dd8fc75a9caa3b90c4e3adfb1252a5b1c19c4
-rw-r--r--core/java/android/os/SystemProperties.java7
1 files changed, 7 insertions, 0 deletions
diff --git a/core/java/android/os/SystemProperties.java b/core/java/android/os/SystemProperties.java
index 45384105cc8f..606d6cd905f0 100644
--- a/core/java/android/os/SystemProperties.java
+++ b/core/java/android/os/SystemProperties.java
@@ -39,6 +39,13 @@ import java.util.HashMap;
* Gives access to the system properties store. The system properties
* store contains a list of string key-value pairs.
*
+ * <p>Use this class only for the system properties that are local. e.g., within
+ * an app, a partition, or a module. For system properties used across the
+ * boundaries, formally define them in <code>*.sysprop</code> files and use the
+ * auto-generated methods. For more information, see <a href=
+ * "https://source.android.com/devices/architecture/sysprops-apis">Implementing
+ * System Properties as APIs</a>.</p>
+ *
* {@hide}
*/
@SystemApi