Commit c7341c98 authored by Dan Winship's avatar Dan Winship Committed by Dan Winship

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.
parent e43ba45f
...@@ -42,7 +42,7 @@ ...@@ -42,7 +42,7 @@
<entry><screen><xsl:value-of select="@name"/></screen></entry> <entry><screen><xsl:value-of select="@name"/></screen></entry>
<entry><screen><xsl:value-of select="@type"/></screen></entry> <entry><screen><xsl:value-of select="@type"/></screen></entry>
<entry><screen><xsl:value-of select="@default"/></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> </row>
</xsl:template> </xsl:template>
......
...@@ -3568,6 +3568,7 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) ...@@ -3568,6 +3568,7 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class)
/* ---ifcfg-rh--- /* ---ifcfg-rh---
* property: password-flags * property: password-flags
* variable: IEEE_8021X_PASSWORD_FLAGS(+) * variable: IEEE_8021X_PASSWORD_FLAGS(+)
* format: NMSettingSecretFlags
* description: Password flags for IEEE_8021X_PASSWORD password. * description: Password flags for IEEE_8021X_PASSWORD password.
* ---end--- * ---end---
*/ */
...@@ -3699,6 +3700,7 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) ...@@ -3699,6 +3700,7 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class)
/* ---ifcfg-rh--- /* ---ifcfg-rh---
* property: private-key-password-flags * property: private-key-password-flags
* variable: IEEE_8021X_PRIVATE_KEY_PASSWORD_FLAGS(+) * variable: IEEE_8021X_PRIVATE_KEY_PASSWORD_FLAGS(+)
* format: NMSettingSecretFlags
* description: Password flags for IEEE_8021X_PRIVATE_KEY_PASSWORD password. * description: Password flags for IEEE_8021X_PRIVATE_KEY_PASSWORD password.
* ---end--- * ---end---
*/ */
...@@ -3784,6 +3786,7 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) ...@@ -3784,6 +3786,7 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class)
/* ---ifcfg-rh--- /* ---ifcfg-rh---
* property: phase2-private-key-password-flags * property: phase2-private-key-password-flags
* variable: IEEE_8021X_INNER_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. * description: Password flags for IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD password.
* ---end--- * ---end---
*/ */
......
...@@ -1569,6 +1569,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting ...@@ -1569,6 +1569,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting
/* ---ifcfg-rh--- /* ---ifcfg-rh---
* property: wep-key-flags * property: wep-key-flags
* variable: WEP_KEY_FLAGS(+) * variable: WEP_KEY_FLAGS(+)
* format: NMSettingSecretFlags
* description: Password flags for KEY<i>, KEY_PASSPHRASE<i> password. * description: Password flags for KEY<i>, KEY_PASSPHRASE<i> password.
* ---end--- * ---end---
*/ */
...@@ -1613,6 +1614,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting ...@@ -1613,6 +1614,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting
/* ---ifcfg-rh--- /* ---ifcfg-rh---
* property: psk-flags * property: psk-flags
* variable: WPA_PSK_FLAGS(+) * variable: WPA_PSK_FLAGS(+)
* format: NMSettingSecretFlags
* description: Password flags for WPA_PSK_FLAGS. * description: Password flags for WPA_PSK_FLAGS.
* example: WPA_PSK_FLAGS=user * example: WPA_PSK_FLAGS=user
* ---end--- * ---end---
...@@ -1655,6 +1657,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting ...@@ -1655,6 +1657,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting
/* ---ifcfg-rh--- /* ---ifcfg-rh---
* property: leap-password-flags * property: leap-password-flags
* variable: IEEE_8021X_PASSWORD_FLAGS(+) * variable: IEEE_8021X_PASSWORD_FLAGS(+)
* format: NMSettingSecretFlags
* description: Password flags for IEEE_8021X_PASSWORD_FLAGS. * description: Password flags for IEEE_8021X_PASSWORD_FLAGS.
* ---end--- * ---end---
*/ */
......
...@@ -368,7 +368,7 @@ DEVICETYPE=TeamPort ...@@ -368,7 +368,7 @@ DEVICETYPE=TeamPort
</entry> </entry>
<entry align="left"><xsl:value-of select="@default"/></entry> <entry align="left"><xsl:value-of select="@default"/></entry>
<entry align="left"> <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)"> <xsl:if test="string-length(@example)">
<emphasis role="bold"> <emphasis role="bold">
......
...@@ -155,7 +155,7 @@ ...@@ -155,7 +155,7 @@
<entry align="left"><xsl:value-of select="@name"/></entry> <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="@type"/></entry>
<entry align="left"><xsl:value-of select="@default"/></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> </row>
</xsl:template> </xsl:template>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment