colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: preserve paraghraphs in nmcli man pages

Browse Source 
Improve documentation by preserving paragraphs in the
nm-settings-nmcli man pages.

To do that structure of src/libnm-client-impl/nm-settings-docs-gir.xml
was changed to have "description" as subnode to property node instead
of attribute of property node. Another subnode "description-docbook"
was added - this node is then used when generating man pages.

tools/generate-docs-nm-settings-docs-gir.py and man/nm-settings-dbus.xsl
were also changed to accomodate for changes mentioned above.

Replace xsltproc tool with python script when generating
./src/libnmc-setting/settings-docs.h.

Deleted settings-docs.xsl since it was replaced by python script.

Change src/libnmc-setting/settings-docs.h.in accodring to newly
generated src/libnmc-setting/settings-docs.h

https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/issues/661

https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/1260
This commit is contained in:
Vojtech Bubela
2022-06-16 21:09:33 +02:00
committed by Thomas Haller
parent ff5541d875
commit 5e4632f021
8 changed files with 252 additions and 162 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
tools/generate-docs-nm-settings-docs-merge.py
View File

@@ -186,6 +186,12 @@ for setting_name in iter_keys_of_dicts(settings_roots, key_fcn_setting_name):
if p_attr is not None
)
description = find_first_not_none(
p_attr.find("description")
for p_attr in properties_attrs
if p_attr is not None
)
if gl_only_from_first and properties_attrs[0] is None:
dbg("> > > > skip (only-from-first")
continue
@@ -203,10 +209,16 @@ for setting_name in iter_keys_of_dicts(settings_roots, key_fcn_setting_name):
node_set_attr(property_node, "type", properties_attrs)
node_set_attr(property_node, "default", properties_attrs)
node_set_attr(property_node, "description", properties_attrs)
desc_value = node_get_attr(properties_attrs, "description")
node_set_attr(property_node, "alias", properties_attrs)
if description_docbook is not None:
property_node.insert(0, description_docbook)
if desc_value:
description = ET.Element("description")
description.text = desc_value
property_node.append(description)
elif description is not None:
property_node.append(description)
ET.ElementTree(root_node).write(gl_output_xml_file)