man, docs: add the secret flags notes non-hackishly

Since libnm-core secret-flags properties are now enum-typed rather
than just being uints, we can now actually recognize them when
generating docs, rather than just assuming that every property whose
name ends in '-flags', but isn't in NMSettingDcb, is a secret-flags
property.

diff --git a/docs/api/settings-spec.xsl b/docs/api/settings-spec.xsl
index 14163e2..04feb39 100644 (file)
--- a/docs/api/settings-spec.xsl
+++ b/docs/api/settings-spec.xsl
@@ -42,7 +42,7 @@
       <entry><screen><xsl:value-of select="@name"/></screen></entry>
       <entry><screen><xsl:value-of select="@type"/></screen></entry>
       <entry><screen><xsl:value-of select="@default"/></screen></entry>
-      <entry><xsl:value-of select="@description"/><xsl:if test="contains(@name,'-flags') and $setting_name != 'dcb'"> (see <xref linkend="secrets-flags"/> for flag values)</xsl:if></entry>
+      <entry><xsl:value-of select="@description"/><xsl:if test="@type = 'NMSettingSecretFlags'"> (see <xref linkend="secrets-flags"/> for flag values)</xsl:if></entry>
     </row>
   </xsl:template>
 

diff --git a/libnm-core/nm-setting-8021x.c b/libnm-core/nm-setting-8021x.c
index 546a2c4..7f07ecc 100644 (file)
--- a/libnm-core/nm-setting-8021x.c
+++ b/libnm-core/nm-setting-8021x.c
@@ -3568,6 +3568,7 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class)
        /* ---ifcfg-rh---
         * property: password-flags
         * variable: IEEE_8021X_PASSWORD_FLAGS(+)
+        * format: NMSettingSecretFlags
         * description: Password flags for IEEE_8021X_PASSWORD password.
         * ---end---
         */
@@ -3699,6 +3700,7 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class)
        /* ---ifcfg-rh---
         * property: private-key-password-flags
         * variable: IEEE_8021X_PRIVATE_KEY_PASSWORD_FLAGS(+)
+        * format: NMSettingSecretFlags
         * description: Password flags for IEEE_8021X_PRIVATE_KEY_PASSWORD password.
         * ---end---
         */
@@ -3784,6 +3786,7 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class)
        /* ---ifcfg-rh---
         * property: phase2-private-key-password-flags
         * variable: IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD_FLAGS(+)
+        * format: NMSettingSecretFlags
         * description: Password flags for IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD password.
         * ---end---
         */

diff --git a/libnm-core/nm-setting-wireless-security.c b/libnm-core/nm-setting-wireless-security.c
index b3ca0a0..c95f924 100644 (file)
--- a/libnm-core/nm-setting-wireless-security.c
+++ b/libnm-core/nm-setting-wireless-security.c
@@ -1569,6 +1569,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting
        /* ---ifcfg-rh---
         * property: wep-key-flags
         * variable: WEP_KEY_FLAGS(+)
+        * format: NMSettingSecretFlags
         * description: Password flags for KEY<i>, KEY_PASSPHRASE<i> password.
         * ---end---
         */
@@ -1613,6 +1614,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting
        /* ---ifcfg-rh---
         * property: psk-flags
         * variable: WPA_PSK_FLAGS(+)
+        * format: NMSettingSecretFlags
         * description: Password flags for WPA_PSK_FLAGS.
         * example: WPA_PSK_FLAGS=user
         * ---end---
@@ -1655,6 +1657,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting
        /* ---ifcfg-rh---
         * property: leap-password-flags
         * variable: IEEE_8021X_PASSWORD_FLAGS(+)
+        * format: NMSettingSecretFlags
         * description: Password flags for IEEE_8021X_PASSWORD_FLAGS.
         * ---end---
         */

diff --git a/man/nm-settings-ifcfg-rh.xsl b/man/nm-settings-ifcfg-rh.xsl
index f069828..ca4292f 100644 (file)
--- a/man/nm-settings-ifcfg-rh.xsl
+++ b/man/nm-settings-ifcfg-rh.xsl
@@ -368,7 +368,7 @@ DEVICETYPE=TeamPort
       </entry>
       <entry align="left"><xsl:value-of select="@default"/></entry>
       <entry align="left">
-        <xsl:value-of select="@description"/><xsl:if test="contains(@name,'-flags') and $setting_name != 'dcb'"> (see <xref linkend="secrets-flags"/> for _FLAGS values)</xsl:if>
+        <xsl:value-of select="@description"/><xsl:if test="@format = 'NMSettingSecretFlags'"> (see <xref linkend="secrets-flags"/> for _FLAGS values)</xsl:if>
 
         <xsl:if test="string-length(@example)">
         <emphasis role="bold">

diff --git a/man/nm-settings.xsl b/man/nm-settings.xsl
index ae8e416..24e4153 100644 (file)
--- a/man/nm-settings.xsl
+++ b/man/nm-settings.xsl
@@ -155,7 +155,7 @@
       <entry align="left"><xsl:value-of select="@name"/></entry>
       <entry align="left"><xsl:value-of select="@type"/></entry>
       <entry align="left"><xsl:value-of select="@default"/></entry>
-      <entry><xsl:value-of select="@description"/><xsl:if test="contains(@name,'-flags') and $setting_name != 'dcb'"> (see <xref linkend="secrets-flags"/> for flag values)</xsl:if></entry>
+      <entry><xsl:value-of select="@description"/><xsl:if test="@type = 'NMSettingSecretFlags (uint32)'"> (see <xref linkend="secrets-flags"/> for flag values)</xsl:if></entry>
     </row>
   </xsl:template>