summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorValentin David <valentin.david@codethink.co.uk>2020-09-08 17:15:30 +0200
committerThomas Haller <thaller@redhat.com>2020-09-29 14:40:24 +0200
commit2899343bfd4dceac5d0be2a52ce91566eb145278 (patch)
treef308ed483edd419d3fd756d4dd0b9133f02f8c7b
parent5c50280bc600db8c38cfbfce824974cf72ef15a4 (diff)
downloadNetworkManager-2899343bfd4dceac5d0be2a52ce91566eb145278.tar.gz
build/docs: fix generated XML syntax in tools/generate-docs-nm-settings-docs-gir.py
Class description may contains double quotes which is not valid as XML attribute value. [thaller@redhat.com: adjust original patch to reformat code with python black] [thaller@redhat.com: adjusted patch during backport from nm-1-26 to nm-1-24] https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/620 (cherry picked from commit 54e25f23f53af889703dfc50d51a8afeeea8a439) (cherry picked from commit 7d26773138dd4270c45e131761d4e6be58f64d12)
-rwxr-xr-xlibnm/generate-setting-docs.py9
1 files changed, 8 insertions, 1 deletions
diff --git a/libnm/generate-setting-docs.py b/libnm/generate-setting-docs.py
index 6f8a03700d..ccc58f5bd7 100755
--- a/libnm/generate-setting-docs.py
+++ b/libnm/generate-setting-docs.py
@@ -218,7 +218,14 @@ for settingxml in settings:
class_desc = get_docs(settingxml)
if class_desc is None:
raise Exception("%s needs a gtk-doc block with one-line description" % setting.props.name)
- outfile.write(" <setting name=\"%s\" description=\"%s\" name_upper=\"%s\" >\n" % (setting.props.name, class_desc, get_setting_name_define (settingxml)))
+ outfile.write(
+ ' <setting name="%s" description=%s name_upper="%s" >\n'
+ % (
+ setting.props.name,
+ xml_quoteattr(class_desc),
+ get_setting_name_define(settingxml),
+ )
+ )
setting_properties = { prop.name: prop for prop in GObject.list_properties(setting) if prop.name != 'name' }
if args.overrides is None: