-
Story
-
Resolution: Won't Do
-
Minor
-
None
-
None
The manual page nm-setting-dbus is using a table layout that is not very useful and takes lot of vertical space. Change the layout to one similar to nm-setting-nmcli's.
Additionally, not all DBUS exposed properties appear. Make sure that they do.
Also, improve how values' types are shown, including the official DBUS types (i.e. `i` for `int32`). For properties that accept a limited set of values and/or special values, show them.
Acceptance criteria:
Given:
- The nm-settings-dbus man page
When: the manual is shown
Then: the layout of the page must be similar to nmcli’s, and not use table layout
Then: all the dbus exposed properties must be shown (i.e. ethtool.feature-l2-fwd-offload is missing)
When: there is a property of any type
Then: the type must be shown by pretty name but by DBUS spec too (i.e “i” for “int32”)
When: there is a property with a set or range of accepted values
Then: show the accepted values in a similar way than in nm-settings-nmcli
When: there is any property
Then: the default value should only be shown if there is any (this needs layout change first)
When: there is a value of the enum marked as “internal”
Then: the value is not shown in the autogenerated documentation
Definition of done:
- The nm-setting-dbus documentation must show the information required by the acceptance criteria