Docserver: fix bug where we were overriding hand-written descriptions of

Docserver: fix bug where we were overriding hand-written descriptions of
permissions by automatically generated ones for declare_permissions.html.
Add docs for the tabs permission. Remove the unused tabCapture docs.
Fix some missed cases where we didn't change "module" terminology to "API".

R=jyasskin@chromium.org
NOTRY=true

Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=220644

[Jeffrey Yasskin, 2013-08-30 19:55:47]

lgtm after considering the below comments.

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
File chrome/common/extensions/docs/server2/permissions_data_source.py (left):

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
chrome/common/extensions/docs/server2/permissions_data_source.py:28: if
'description' in permission or not permission['platforms']:
Do "description" keys never appear in the permission dictionary? (This is one
reason it would be nicer to use classes for storing data rather than
dictionaries.)
If "description" keys do appear in the dictionary, where should I look for the
test covering them?

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
File chrome/common/extensions/docs/server2/permissions_data_source_test.py
(right):

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
chrome/common/extensions/docs/server2/permissions_data_source_test.py:21:
file_system = TestFileSystem({
This file system is odd. It's rooted at a mixture of
chrome/common/extensions/docs/templates/json/ and chrome/common/extensions/api/?
And chrome/common/extensions/api/permissions.json exists, but isn't the one
being filled in here?

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
File
chrome/common/extensions/docs/templates/private/permissions/sync_file_system.html
(right):

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/private/permissions/sync_file_system.html:1:
Required if the app uses the <a
href="syncFileSystem.html">chrome.syncFileSystem</a> API to save and synchronize
data on Google Drive.
Also mention this terminology change.

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
File
chrome/common/extensions/docs/templates/private/permissions/tab_capture.html
(left):

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/private/permissions/tab_capture.html:1:
Required if the extension uses the <a
href="tabCapture.html">chrome.tabCapture</a> module.
Could you mention this removal in the CL description along with why it's right?

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
File chrome/common/extensions/docs/templates/private/permissions/tabs.html
(right):

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/private/permissions/tabs.html:1: Gives
your {{platform}} access to privileged fields of the <code>$ref:[tabs.Tab
Tab]</code> type from the $ref:[tabs chrome.tabs] API. In many circumstances,
your {{platform}} will not need to declare the <code>"tabs"</code> permission.
Is there anything from the chrome.windows API that this controls?

[not at google - send to devlin, 2013-08-30 20:35:32]

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
File chrome/common/extensions/docs/server2/permissions_data_source.py (left):

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
chrome/common/extensions/docs/server2/permissions_data_source.py:28: if
'description' in permission or not permission['platforms']:
On 2013/08/30 19:55:47, Jeffrey Yasskin wrote:
> Do "description" keys never appear in the permission dictionary? (This is one
> reason it would be nicer to use classes for storing data rather than
> dictionaries.)
> If "description" keys do appear in the dictionary, where should I look for the
> test covering them?

Nope, no description. The "partial" key has a string value, the name of the
partial. We add a "description" key which links to the partial named.

Less confusing would be for "partial" to be called "partial_name" and
"description" to be called "partial", but these things come from hindsight and
don't seem a big enough pain to fix.

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
File chrome/common/extensions/docs/server2/permissions_data_source_test.py
(right):

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
chrome/common/extensions/docs/server2/permissions_data_source_test.py:21:
file_system = TestFileSystem({
On 2013/08/30 19:55:47, Jeffrey Yasskin wrote:
> This file system is odd. It's rooted at a mixture of
> chrome/common/extensions/docs/templates/json/ and
chrome/common/extensions/api/?
> And chrome/common/extensions/api/permissions.json exists, but isn't the one
> being filled in here?

It might look odd but it makes the most sense.
- it's an arbitrary file system, we give PermissionsDataSource the paths into
the file system
- it uses actual file names rather than metasyntactic file names because that's
less confusing to read

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
File
chrome/common/extensions/docs/templates/private/permissions/sync_file_system.html
(right):

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/private/permissions/sync_file_system.html:1:
Required if the app uses the <a
href="syncFileSystem.html">chrome.syncFileSystem</a> API to save and synchronize
data on Google Drive.
On 2013/08/30 19:55:47, Jeffrey Yasskin wrote:
> Also mention this terminology change.

Done.

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
File
chrome/common/extensions/docs/templates/private/permissions/tab_capture.html
(left):

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/private/permissions/tab_capture.html:1:
Required if the extension uses the <a
href="tabCapture.html">chrome.tabCapture</a> module.
On 2013/08/30 19:55:47, Jeffrey Yasskin wrote:
> Could you mention this removal in the CL description along with why it's
right?

Done.

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
File chrome/common/extensions/docs/templates/private/permissions/tabs.html
(right):

https://codereview.chromium.org/23494015/diff/3001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/private/permissions/tabs.html:1: Gives
your {{platform}} access to privileged fields of the <code>$ref:[tabs.Tab
Tab]</code> type from the $ref:[tabs chrome.tabs] API. In many circumstances,
your {{platform}} will not need to declare the <code>"tabs"</code> permission.
On 2013/08/30 19:55:47, Jeffrey Yasskin wrote:
> Is there anything from the chrome.windows API that this controls?

Not really, the sensitive data is all in Tab. But good point, it's worth
mentioning that this permission affects the tabs from all APIs including
windows.

[commit-bot: I haz the power, 2013-08-30 20:39:45]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/kalman@chromium.org/23494015/5001

[commit-bot: I haz the power, 2013-08-30 20:40:13]

Change committed as 220644