From 09c730b19743a133effb432f7f2bd33d601ee4cd Mon Sep 17 00:00:00 2001
From: Jiyong Park <jiyong@google.com>
Date: Sat, 21 Sep 2019 14:03:09 +0900
Subject: [PATCH] Add documentation for *.sysprop

Bug: 141246285
Test: N/A
Change-Id: Ia90dd8fc75a9caa3b90c4e3adfb1252a5b1c19c4
---
 core/java/android/os/SystemProperties.java | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/core/java/android/os/SystemProperties.java b/core/java/android/os/SystemProperties.java
index 45384105cc8fe..606d6cd905f0b 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