summary refs log tree commit diff
path: root/src/nmcli/gen-metadata-nm-settings-nmcli.c
diff options
context:
space:
mode:
authorMichael Biebl <biebl@debian.org>2023-08-09 21:55:35 +0200
committerMichael Biebl <biebl@debian.org>2023-08-09 21:55:35 +0200
commit05e4a733f2141995181a551854d5df929f084adf (patch)
tree83bb937740a6667525ba0df046748ecaa829c269 /src/nmcli/gen-metadata-nm-settings-nmcli.c
parent14b0f3a9dc9ea90d60a3b057350fd4d637dc021a (diff)
New upstream version 1.44.0 upstream/1.44.0
Diffstat (limited to 'src/nmcli/gen-metadata-nm-settings-nmcli.c')
-rw-r--r--src/nmcli/gen-metadata-nm-settings-nmcli.c16
1 files changed, 14 insertions, 2 deletions
diff --git a/src/nmcli/gen-metadata-nm-settings-nmcli.c b/src/nmcli/gen-metadata-nm-settings-nmcli.c
index 196e4d35..8e5831ac 100644
--- a/src/nmcli/gen-metadata-nm-settings-nmcli.c
+++ b/src/nmcli/gen-metadata-nm-settings-nmcli.c
@@ -57,10 +57,22 @@ main(int argc, char *argv[])
                 g_print("\n%salias=%s",
                         _indent_level(2 * INDENT + 10),
                         tmp3 = _xml_escape_attribute(prop_info->property_alias));
-            if (prop_info->describe_doc)
-                g_print("\n%sdescription=%s",
+            if (prop_info->describe_doc) {
+                /* These descriptions are used by interactive nmcli modes. For the most part,
+                 * they are themselves generated (see "settings-docs.h"). Some of them are instead
+                 * explicitly (manually) set.
+                 *
+                 * In any case, they serve little purpose outside of nmcli's interactive mode,
+                 * because their formatting/wording would not be suitable.
+                 *
+                 * We generate this XML mainly to generate `man nm-settings-nmcli`, but the
+                 * descriptions in "describe_doc" field are not suitable there.
+                 *
+                 * Name them something else ("<nmcli-description>") which isn't actually used. */
+                g_print("\n%snmcli-description=%s",
                         _indent_level(2 * INDENT + 10),
                         tmp4 = _xml_escape_attribute(prop_info->describe_doc));
+            }
             g_print(" />\n");
         }