Document the "key" value in the extension manifest.

BUG=40101

Review URL: http://codereview.chromium.org/2870008

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@50118 0039d316-1c4b-4281-b951-d872f2087c98

4 files changed, 65 insertions, 3 deletions

diff --git a/chrome/common/extensions/docs/manifest.html b/chrome/common/extensions/docs/manifest.html
index d86ab9f..de824f0 100644
--- a/chrome/common/extensions/docs/manifest.html
+++ b/chrome/common/extensions/docs/manifest.html
@@ -218,6 +218,8 @@
                 </li><li>
                   <a href="#default_locale">default_locale</a>
                 </li><li>
+                  <a href="#key">key</a>
+                </li><li>
                   <a href="#minimum_chrome_version">minimum_chrome_version</a>
                 </li><li>
                   <a href="#name">name</a>
@@ -308,6 +310,7 @@ are <b>name</b> and <b>version</b>.
   "<a href="background_pages.html">background_page</a>": "<em>aFile</em>.html",
   "<a href="override.html">chrome_url_overrides</a>": {...},
   "<a href="content_scripts.html">content_scripts</a>": [...],
+  "<a href="#key">key</a>": "<em>publicKey</em>",
   "<a href="#minimum_chrome_version">minimum_chrome_version</a>": "<em>versionString</em>",
   "<a href="options.html">options_page</a>": "<em>aFile</em>.html",
   "<a href="#permissions">permissions</a>": [...],
@@ -410,6 +413,35 @@ For details, see
 <a href="i18n.html">Internationalization</a>.
 </p>
 
+<h3 id="key">key</h3>
+
+<p>
+This value can be used to control
+the unique ID of an extension when
+it is loaded during development.
+</p>
+
+<p class="note">
+<b>Note:</b> Most extensions should not need to
+use this value. Instead, write your
+code so that the key value doesn't matter
+by using <a href="overview.html#relative-urls">relative paths</a>
+and <a href="extension.html#method-getURL">chrome.extension.getURL()</a>.
+</p>
+
+<p>
+To get a suitable key value, first
+install your extension from a <code>.crx</code> file
+(you may need to
+<a href="hosting.html#gallery">upload your extension to the gallery</a>,
+or <a href="packaging.html">package it manually</a>).
+Then, in your
+<a href="http://www.chromium.org/user-experience/user-data-directory">user
+data directory</a>, look in the file
+<code>Default/Extensions/<em>&lt;extensionId&gt;</em>/<em>&lt;versionString&gt;</em>/manifest.json</code>.
+You will see the key value filled in there.
+</p>
+
 <h3 id="minimum_chrome_version">minimum_chrome_version</h3>
 
 <p>
diff --git a/chrome/common/extensions/docs/overview.html b/chrome/common/extensions/docs/overview.html
index 9fb7d8d..8ec378e 100644
--- a/chrome/common/extensions/docs/overview.html
+++ b/chrome/common/extensions/docs/overview.html
@@ -212,7 +212,7 @@
               <a href="#files">Files</a>
               <ol>
                 <li>
-                  <a href="#H3-2">Referring to files</a>
+                  <a href="#relative-urls">Referring to files</a>
                 </li><li>
                   <a href="#H3-3">The manifest file</a>
                 </li>
@@ -372,7 +372,7 @@ see <a href="hosting.html">Hosting</a>.
 </p>
 
 
-<a name="H3-2"></a><h3>Referring to files</h3>
+<h3 id="relative-urls">Referring to files</h3>
 
 <p>
 You can put any file you like into an extension,
diff --git a/chrome/common/extensions/docs/static/manifest.html b/chrome/common/extensions/docs/static/manifest.html
index 3746c0c..6b1f004 100644
--- a/chrome/common/extensions/docs/static/manifest.html
+++ b/chrome/common/extensions/docs/static/manifest.html
@@ -37,6 +37,7 @@ are <b>name</b> and <b>version</b>.
   "<a href="background_pages.html">background_page</a>": "<em>aFile</em>.html",
   "<a href="override.html">chrome_url_overrides</a>": {...},
   "<a href="content_scripts.html">content_scripts</a>": [...],
+  "<a href="#key">key</a>": "<em>publicKey</em>",
   "<a href="#minimum_chrome_version">minimum_chrome_version</a>": "<em>versionString</em>",
   "<a href="options.html">options_page</a>": "<em>aFile</em>.html",
   "<a href="#permissions">permissions</a>": [...],
@@ -140,6 +141,35 @@ For details, see
 <a href="i18n.html">Internationalization</a>.
 </p>
 
+<h3 id="key">key</h3>
+
+<p>
+This value can be used to control
+the unique ID of an extension when
+it is loaded during development.
+</p>
+
+<p class="note">
+<b>Note:</b> Most extensions should not need to
+use this value. Instead, write your
+code so that the key value doesn't matter
+by using <a href="overview.html#relative-urls">relative paths</a>
+and <a href="extension.html#method-getURL">chrome.extension.getURL()</a>.
+</p>
+
+<p>
+To get a suitable key value, first
+install your extension from a <code>.crx</code> file
+(you may need to
+<a href="hosting.html#gallery">upload your extension to the gallery</a>,
+or <a href="packaging.html">package it manually</a>).
+Then, in your
+<a href="http://www.chromium.org/user-experience/user-data-directory">user
+data directory</a>, look in the file
+<code>Default/Extensions/<em>&lt;extensionId&gt;</em>/<em>&lt;versionString&gt;</em>/manifest.json</code>.
+You will see the key value filled in there.
+</p>
+
 <h3 id="minimum_chrome_version">minimum_chrome_version</h3>
 
 <p>
diff --git a/chrome/common/extensions/docs/static/overview.html b/chrome/common/extensions/docs/static/overview.html
index 6b0a1df..aa370f7 100644
--- a/chrome/common/extensions/docs/static/overview.html
+++ b/chrome/common/extensions/docs/static/overview.html
@@ -80,7 +80,7 @@ see <a href="hosting.html">Hosting</a>.
 </p>
 
 
-<h3>Referring to files</h3>
+<h3 id="relative-urls">Referring to files</h3>
 
 <p>
 You can put any file you like into an extension,