fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-05-08 15:58:03 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: fix escaping XML in "tools/generate-docs-nm-settings-docs-gir.py"

Browse source 
The gtk-doc text that the tool receives is not XML, it's a plain text.
When setting the plain text as XML attribute, we need to properly escape
it. The previous XML escape code was naive, and didn't cover for a
plain ampersand.

[thaller@redhat.com: adjusted patch during backport from nm-1-26 to nm-1-24]

(cherry picked from commit 1641cc1d03)
(cherry picked from commit 5b7d39f8e1)
This commit is contained in:
Thomas Haller 2020-06-26 10:18:49 +02:00
parent 7c46ff24e5
commit 5c50280bc6
No known key found for this signature in database
GPG key ID: 29C2366E4DFC5728
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
libnm/generate-setting-docs.py
View file

@ -8,6 +8,8 @@ from __future__ import print_function
import os import os
import gi import gi
import xml.sax.saxutils as saxutils
gi.require_version('GIRepository', '2.0') gi.require_version('GIRepository', '2.0')
from gi.repository import GIRepository from gi.repository import GIRepository
import argparse, datetime, re, sys import argparse, datetime, re, sys
@ -163,8 +165,8 @@ def settings_sort_key(x):
# always sort NMSettingConnection first # always sort NMSettingConnection first
return (x_prefix != "setting_connection", x_prefix); return (x_prefix != "setting_connection", x_prefix);
def escape(val): def xml_quoteattr(val):
return str(val).replace('"', '"') return saxutils.quoteattr(str(val))
def usage(): def usage():
print("Usage: %s --gir FILE --output FILE" % sys.argv[0]) print("Usage: %s --gir FILE --output FILE" % sys.argv[0])
@ -256,11 +258,11 @@ for settingxml in settings:
raise Exception("%s.%s needs a documentation description" % (setting.props.name, prop)) raise Exception("%s.%s needs a documentation description" % (setting.props.name, prop))
if default_value is not None: if default_value is not None:
outfile.write(" <property name=\"%s\" name_upper=\"%s\" type=\"%s\" default=\"%s\" description=\"%s\" />\n" % outfile.write(" <property name=\"%s\" name_upper=\"%s\" type=\"%s\" default=%s description=%s />\n" %
(prop, prop_upper, value_type, escape(default_value), escape(value_desc))) (prop, prop_upper, value_type, xml_quoteattr(default_value), xml_quoteattr(value_desc)))
else: else:
outfile.write(" <property name=\"%s\" name_upper=\"%s\" type=\"%s\" description=\"%s\" />\n" % outfile.write(" <property name=\"%s\" name_upper=\"%s\" type=\"%s\" description=%s />\n" %
(prop, prop_upper, value_type, escape(value_desc))) (prop, prop_upper, value_type, xml_quoteattr(value_desc)))
outfile.write(" </setting>\n") outfile.write(" </setting>\n")