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 :)
This commit is contained in:
Aaron Carlisle
2020-03-05 11:40:05 +11:00
committed by Campbell Barton
parent 3da2dc8213
commit ae223ff52b
5 changed files with 23 additions and 7 deletions

View File

@@ -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",
}

View File

@@ -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"}

View File

@@ -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

View File

@@ -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"):

View File

@@ -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",
}