From 125cbf5737d0e140c09147338d9cbc8ea6b5d600 Mon Sep 17 00:00:00 2001
From: Thomas Haller <thaller@redhat.com>
Date: Fri, 12 Jun 2020 14:01:26 +0200
Subject: [PATCH] docs: show aliases for settings in `man nm-settings-nmcli`

---
 clients/cli/generate-docs-nm-settings-nmcli.c | 8 ++++++--
 man/nm-settings-nmcli.xsl                     | 5 +++++
 tools/generate-docs-nm-settings-docs-merge.py | 1 +
 3 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/clients/cli/generate-docs-nm-settings-nmcli.c b/clients/cli/generate-docs-nm-settings-nmcli.c
index 4cff97063f..caf941d7c6 100644
--- a/clients/cli/generate-docs-nm-settings-nmcli.c
+++ b/clients/cli/generate-docs-nm-settings-nmcli.c
@@ -33,10 +33,14 @@ main (int argc, char *argv[])
 	g_print ("<nm-setting-docs>\n");
 	for (i_sett_infos = 0; i_sett_infos < G_N_ELEMENTS (nm_meta_setting_infos_editor); i_sett_infos++) {
 		const NMMetaSettingInfoEditor *sett_info = &nm_meta_setting_infos_editor[i_sett_infos];
-		gs_free char *tmp1 = NULL;
+		gs_free char *tmp_s1 = NULL;
+		gs_free char *tmp_s2 = NULL;
 
 		g_print ("%s<setting", _indent_level (INDENT));
-		g_print (" name=%s >\n", tmp1 = _xml_escape_attribute (sett_info->general->setting_name));
+		g_print (" name=%s", tmp_s1 = _xml_escape_attribute (sett_info->general->setting_name));
+		if (sett_info->alias)
+			g_print ("\n%salias=%s", _indent_level (INDENT + 9), tmp_s2 = _xml_escape_attribute (sett_info->alias));
+		g_print (" >\n");
 
 		for (i_property = 0; i_property < sett_info->properties_num; i_property++) {
 			const NMMetaPropertyInfo *prop_info = sett_info->properties[i_property];
diff --git a/man/nm-settings-nmcli.xsl b/man/nm-settings-nmcli.xsl
index 809c762d4a..a31922a570 100644
--- a/man/nm-settings-nmcli.xsl
+++ b/man/nm-settings-nmcli.xsl
@@ -120,6 +120,11 @@
   <xsl:template match="setting">
     <refsect2>
       <title><xsl:value-of select="@name"/> setting</title>
+      <xsl:if test="@alias">
+        <para>
+          Alias: <xsl:value-of select="@alias"/>
+        </para>
+      </xsl:if>
       <para><xsl:value-of select="@description"/>.</para>
       <para>
         Properties:
diff --git a/tools/generate-docs-nm-settings-docs-merge.py b/tools/generate-docs-nm-settings-docs-merge.py
index 9115b61b22..bf58669819 100755
--- a/tools/generate-docs-nm-settings-docs-merge.py
+++ b/tools/generate-docs-nm-settings-docs-merge.py
@@ -145,6 +145,7 @@ for setting_name in iter_keys_of_dicts(settings_roots, key_fcn_setting_name):
 
     node_set_attr(setting_node, 'description', settings)
     node_set_attr(setting_node, 'name_upper', settings)
+    node_set_attr(setting_node, 'alias', settings)
 
     for property_name in iter_keys_of_dicts(properties):