[Bf-blender-cvs] [ae223ff52be] master: Addons: deprecate 'wiki_url'

[Aaron Carlisle]

Commit: ae223ff52bed52811873c110ecf1045d2da35b9b
Author: Aaron Carlisle
Date:   Thu Mar 5 11:40:05 2020 +1100
Branches: master
https://developer.blender.org/rBae223ff52bed52811873c110ecf1045d2da35b9b

Addons: deprecate 'wiki_url'

When running with debug enabled ('-d' argument),
warnings are printed for add-ons which are not yet updated.

Reminder to name things based on what they do,
not the technologies they use :)

===================================================================

M	doc/python_api/examples/bpy.types.AddonPreferences.1.py
M	intern/cycles/blender/addon/__init__.py
M	release/scripts/modules/addon_utils.py
M	release/scripts/startup/bl_ui/space_userpref.py
M	release/scripts/templates_py/addon_add_object.py

===================================================================

diff --git a/doc/python_api/examples/bpy.types.AddonPreferences.1.py b/doc/python_api/examples/bpy.types.AddonPreferences.1.py
index 95285e8ac0c..0c82ff924de 100644
--- a/doc/python_api/examples/bpy.types.AddonPreferences.1.py
+++ b/doc/python_api/examples/bpy.types.AddonPreferences.1.py
@@ -6,7 +6,7 @@ bl_info = {
     "location": "SpaceBar Search -> Add-on Preferences Example",
     "description": "Example Add-on",
     "warning": "",
-    "wiki_url": "",
+    "doc_url": "",
     "tracker_url": "",
     "category": "Object",
 }
diff --git a/intern/cycles/blender/addon/__init__.py b/intern/cycles/blender/addon/__init__.py
index 6d6f89603fe..3d2a52d0cf6 100644
--- a/intern/cycles/blender/addon/__init__.py
+++ b/intern/cycles/blender/addon/__init__.py
@@ -22,7 +22,7 @@ bl_info = {
     "blender": (2, 80, 0),
     "description": "Cycles renderer integration",
     "warning": "",
-    "wiki_url": "https://docs.blender.org/manual/en/latest/render/cycles/",
+    "doc_url": "https://docs.blender.org/manual/en/latest/render/cycles/",
     "tracker_url": "",
     "support": 'OFFICIAL',
     "category": "Render"}
diff --git a/release/scripts/modules/addon_utils.py b/release/scripts/modules/addon_utils.py
index b58c683dc24..43d62913ff7 100644
--- a/release/scripts/modules/addon_utils.py
+++ b/release/scripts/modules/addon_utils.py
@@ -505,7 +505,7 @@ def module_bl_info(mod, info_basis=None):
             "blender": (),
             "location": "",
             "description": "",
-            "wiki_url": "",
+            "doc_url": "",
             "support": 'COMMUNITY',
             "category": "",
             "warning": "",
@@ -527,5 +527,21 @@ def module_bl_info(mod, info_basis=None):
     if not addon_info["name"]:
         addon_info["name"] = mod.__name__
 
+    # Replace 'wiki_url' with 'doc_url'.
+    doc_url = addon_info.pop("wiki_url", None)
+    if doc_url is not None:
+        # Unlikely, but possible that both are set.
+        if not addon_info["doc_url"]:
+            addon_info["doc_url"] = doc_url
+        if _bpy.app.debug:
+            print(
+                "Warning: add-on \"{addon_name}\": 'wiki_url' in 'bl_info' "
+                "is deprecated please use 'doc_url' instead!\n"
+                "         {addon_path}".format(
+                    addon_name=addon_info['name'],
+                    addon_path=getattr(mod, "__file__", None),
+                )
+            )
+
     addon_info["_init"] = None
     return addon_info
diff --git a/release/scripts/startup/bl_ui/space_userpref.py b/release/scripts/startup/bl_ui/space_userpref.py
index 7e868b21e8a..c3c99ebb826 100644
--- a/release/scripts/startup/bl_ui/space_userpref.py
+++ b/release/scripts/startup/bl_ui/space_userpref.py
@@ -1873,16 +1873,16 @@ class USERPREF_PT_addons(AddOnPanel, Panel):
                         split.label(text="  " + info["warning"], icon='ERROR')
 
                     user_addon = USERPREF_PT_addons.is_user_addon(mod, user_addon_paths)
-                    tot_row = bool(info["wiki_url"]) + bool(user_addon)
+                    tot_row = bool(info["doc_url"]) + bool(user_addon)
 
                     if tot_row:
                         split = colsub.row().split(factor=0.15)
                         split.label(text="Internet:")
                         sub = split.row()
-                        if info["wiki_url"]:
+                        if info["doc_url"]:
                             sub.operator(
                                 "wm.url_open", text="Documentation", icon='HELP',
-                            ).url = info["wiki_url"]
+                            ).url = info["doc_url"]
                         # Only add "Report a Bug" button if tracker_url is set
                         # or the add-on is bundled (use official tracker then).
                         if info.get("tracker_url"):
diff --git a/release/scripts/templates_py/addon_add_object.py b/release/scripts/templates_py/addon_add_object.py
index 47997069cbb..05a713b76b0 100644
--- a/release/scripts/templates_py/addon_add_object.py
+++ b/release/scripts/templates_py/addon_add_object.py
@@ -6,7 +6,7 @@ bl_info = {
     "location": "View3D > Add > Mesh > New Object",
     "description": "Adds a new Mesh Object",
     "warning": "",
-    "wiki_url": "",
+    "doc_url": "",
     "category": "Add Mesh",
 }