add backport info and fix wrong permission

thunderbird · Jan 28, 2021 · 009d936 · 009d936
1 parent 5b64ff1
commit 009d936
Show file tree

Hide file tree

Showing 13 changed files with 52 additions and 38 deletions.
diff --git a/accounts.rst b/accounts.rst
@@ -93,7 +93,7 @@ Returns details of the requested account, or null if it doesn't exist.
 getDefault()
 ------------
 
-.. api-section-annotation-hack:: -- [Added in TB 85]
+.. api-section-annotation-hack:: -- [Added in TB 85, backported to TB 78.7]
 
 Returns the default account, or null if it is not defined.
 
@@ -135,7 +135,7 @@ Sets the default identity for an account.
 getDefaultIdentity(accountId)
 -----------------------------
 
-.. api-section-annotation-hack:: -- [Added in TB 85]
+.. api-section-annotation-hack:: -- [Added in TB 85, backported to TB 78.7]
 
 Returns the default identity for an account, or null if it is not defined.
 

diff --git a/browserAction.rst b/browserAction.rst
@@ -45,7 +45,7 @@ Manifest file properties
    .. api-member::
       :name: [``default_label``]
       :type: (string)
-      :annotation: -- [Added in TB 84.0b3]
+      :annotation: -- [Added in TB 84.0b3, backported to TB 78.6.1]
 
 
    .. api-member::
@@ -134,7 +134,7 @@ Gets the title of the toolbar action.
 setLabel(details)
 -----------------
 
-.. api-section-annotation-hack:: -- [Added in TB 84.0b3]
+.. api-section-annotation-hack:: -- [Added in TB 84.0b3, backported to TB 78.6.1]
 
 Sets the label of the toolbar action, defaults to its title. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback.
 
@@ -159,7 +159,7 @@ Sets the label of the toolbar action, defaults to its title. Can be set to an em
 getLabel(details)
 -----------------
 
-.. api-section-annotation-hack:: -- [Added in TB 84.0b3]
+.. api-section-annotation-hack:: -- [Added in TB 84.0b3, backported to TB 78.6.1]
 
 Gets the label of the toolbar action.
 

diff --git a/compose.rst b/compose.rst
@@ -41,7 +41,7 @@ Open a new message compose window. If the provided ComposeDetails object does no
    .. api-member::
       :name: [``messageId``]
       :type: (integer)
-      :annotation: -- [Added in TB 84]
+      :annotation: -- [Added in TB 84, backported to TB 78.7]
 
       If specified, the message or template to edit as a new message.
 

diff --git a/composeAction.rst b/composeAction.rst
@@ -50,7 +50,7 @@ Manifest file properties
    .. api-member::
       :name: [``default_label``]
       :type: (string)
-      :annotation: -- [Added in TB 84.0b3]
+      :annotation: -- [Added in TB 84.0b3, backported to TB 78.6.1]
 
 
    .. api-member::
@@ -139,7 +139,7 @@ Gets the title of the toolbar action.
 setLabel(details)
 -----------------
 
-.. api-section-annotation-hack:: -- [Added in TB 84.0b3]
+.. api-section-annotation-hack:: -- [Added in TB 84.0b3, backported to TB 78.6.1]
 
 Sets the label of the toolbar action, defaults to its title. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback.
 
@@ -164,7 +164,7 @@ Sets the label of the toolbar action, defaults to its title. Can be set to an em
 getLabel(details)
 -----------------
 
-.. api-section-annotation-hack:: -- [Added in TB 84.0b3]
+.. api-section-annotation-hack:: -- [Added in TB 84.0b3, backported to TB 78.6.1]
 
 Gets the label of the toolbar action.
 

diff --git a/composeScripts.rst b/composeScripts.rst
@@ -19,16 +19,6 @@ __ https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/co
 
 .. role:: permission
 
-.. rst-class:: api-main-section
-
-Permissions
-===========
-
-.. api-member::
-   :name: :permission:`messagesModify`
-
-   Read and modify your email messages as they are displayed to you
-
 .. rst-class:: api-permission-info
 
 .. note::

diff --git a/messageDisplayAction.rst b/messageDisplayAction.rst
@@ -43,7 +43,7 @@ Manifest file properties
    .. api-member::
       :name: [``default_label``]
       :type: (string)
-      :annotation: -- [Added in TB 84.0b3]
+      :annotation: -- [Added in TB 84.0b3, backported to TB 78.6.1]
 
 
    .. api-member::
@@ -132,7 +132,7 @@ Gets the title of the toolbar action.
 setLabel(details)
 -----------------
 
-.. api-section-annotation-hack:: -- [Added in TB 84.0b3]
+.. api-section-annotation-hack:: -- [Added in TB 84.0b3, backported to TB 78.6.1]
 
 Sets the label of the toolbar action, defaults to its title. Can be set to an empty string to not display any label. If the containing toolbar is configured to display text only, the title will be used as fallback.
 
@@ -157,7 +157,7 @@ Sets the label of the toolbar action, defaults to its title. Can be set to an em
 getLabel(details)
 -----------------
 
-.. api-section-annotation-hack:: -- [Added in TB 84.0b3]
+.. api-section-annotation-hack:: -- [Added in TB 84.0b3, backported to TB 78.6.1]
 
 Gets the label of the toolbar action.
 

diff --git a/overlay/accounts.json b/overlay/accounts.json
@@ -98,11 +98,13 @@
       },
       {
         "name": "getDefaultIdentity",
-        "added": "85"
+        "added": "85",
+        "backported": "78.7"
       },
       {
         "name": "getDefault",
-        "added": "85"
+        "added": "85",
+        "backported": "78.7"
       }
     ]
   }

diff --git a/overlay/browserAction.json b/overlay/browserAction.json
@@ -8,7 +8,8 @@
           "browser_action": {
             "properties": {
               "default_label": {
-                "added" : "84.0b3"
+                "added" : "84.0b3",
+                "backported" : "78.6.1"                
               }
             }
           }
@@ -48,11 +49,13 @@
       },
       {
         "name": "setLabel",
-        "added": "84.0b3"
+        "added": "84.0b3",
+        "backported": "78.6.1"
       },
       {
         "name": "getLabel",
-        "added": "84.0b3"
+        "added": "84.0b3",
+        "backported" : "78.6.1"
       }
     ]
   }

diff --git a/overlay/compose.json b/overlay/compose.json
@@ -47,7 +47,8 @@
         "parameters": [
           {
             "name": "messageId",
-            "added": 84
+            "added": 84,
+            "backported": "78.7"
           }
         ],
         "returns": {

diff --git a/overlay/composeAction.json b/overlay/composeAction.json
@@ -8,7 +8,8 @@
           "compose_action": {
             "properties": {
               "default_label": {
-                "added" : "84.0b3"
+                "added": "84.0b3",
+                "backported": "78.6.1"
               }
             }
           }
@@ -48,11 +49,13 @@
       },
       {
         "name": "setLabel",
-        "added": "84.0b3"
+        "added": "84.0b3",
+        "backported": "78.6.1"
       },
       {
         "name": "getLabel",
-        "added": "84.0b3"
+        "added": "84.0b3",
+        "backported": "78.6.1"
       }
     ]    
   }

diff --git a/overlay/extensionScripts.json b/overlay/extensionScripts.json
@@ -0,0 +1,6 @@
+[
+  {
+    "namespace": "composeScripts",
+    "ignore_permissions": ["messagesModify"]
+  }
+]
diff --git a/overlay/messageDisplayAction.json b/overlay/messageDisplayAction.json
@@ -8,7 +8,8 @@
           "message_display_action": {
             "properties": {
               "default_label": {
-                "added" : "84.0b3"
+                "added": "84.0b3",
+                "backported": "78.6.1"
               }
             }
           }
@@ -48,11 +49,13 @@
       },
       {
         "name": "setLabel",
-        "added": "84.0b3"
+        "added": "84.0b3",
+        "backported": "78.6.1"
       },
       {
         "name": "getLabel",
-        "added": "84.0b3"
+        "added": "84.0b3",
+        "backported": "78.6.1"
       }
     ]   
   }

diff --git a/update-docs.py b/update-docs.py
@@ -34,6 +34,11 @@ def merge_objects(a, b):
     elif isinstance(a, dict):
         for [e, f] in a.iteritems():
             if e not in b or e in ["description"]:
+                if (e in b and e in ["description"]):
+                    print("Replacing Description")
+                    print("  comm-central: " + b[e])
+                    print("  overlay file: " + f)
+                    print("")
                 b[e] = f
                 continue
             if e not in ["namespace", "name", "id", "$extend"]:
@@ -639,7 +644,7 @@ def format_namespace(namespace, manifest_namespace=None):
     return "\n".join(lines).encode("utf-8")
 
 
-def format_manifest_namespace(manifest):
+def format_manifest_namespace(manifest, namespace):
     global unique_id
     #unique_id = 1
 
@@ -669,8 +674,9 @@ def format_manifest_namespace(manifest):
         ]:
             for choice in type_["choices"]:
                 for value in choice["enum"]:
-                    description = [permission_strings[value]] if value in permission_strings else None
-                    permission_lines.extend(api_member(name=":permission:`" + value + "`", description=description))
+                    if "ignore_permissions" not in namespace or value not in namespace["ignore_permissions"]:
+                        description = [permission_strings[value]] if value in permission_strings else None
+                        permission_lines.extend(api_member(name=":permission:`" + value + "`", description=description))
 
     if len(permission_lines) > 0:
         permission_lines.append("")
@@ -753,7 +759,7 @@ def format_manifest_namespace(manifest):
             current_namespace_name = namespace["namespace"]
 
             if "manifest" in namespaces:
-                manifest_namespace = format_manifest_namespace(namespaces["manifest"])
+                manifest_namespace = format_manifest_namespace(namespaces["manifest"], namespace)
 
             with open(os.path.join(DEST_DIR, namespace["namespace"] + ".rst"), "w") as fp_output:
                 fp_output.write(format_namespace(namespace, manifest_namespace=manifest_namespace))