From 08e318e5868b4f21a95fd1b5e8b9659e2d830257 Mon Sep 17 00:00:00 2001
From: Jonathan Basseri <misterikkit@google.com>
Date: Fri, 29 May 2015 10:12:23 -0700
Subject: [PATCH] Document procedure for adding carrier config variables.

Readers of CarrierConfigManager.java should find enough info in the
comments to add new variables and override them in either their own
carrier app or the default carrier app.

Change-Id: Ib1d87c24543491ad8b4ef0b1d08148a07fb1ace3
---
 telephony/java/android/telephony/CarrierConfigManager.java | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/telephony/java/android/telephony/CarrierConfigManager.java b/telephony/java/android/telephony/CarrierConfigManager.java
index 7d39efccdfc5c..a37cb3ec008cc 100644
--- a/telephony/java/android/telephony/CarrierConfigManager.java
+++ b/telephony/java/android/telephony/CarrierConfigManager.java
@@ -49,6 +49,10 @@ public class CarrierConfigManager {
     public static final String
             ACTION_CARRIER_CONFIG_CHANGED = "android.telephony.action.CARRIER_CONFIG_CHANGED";
 
+    // Below are the keys used in carrier config bundles. To add a new variable, define the key and
+    // give it a default value in sDefaults. If you need to ship a per-network override in the
+    // system image, that can be added in packages/apps/CarrierConfig.
+
     /**
      * Flag indicating whether the Phone app should ignore EVENT_SIM_NETWORK_LOCKED
      * events from the Sim.