mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager
synced 2024-11-05 19:03:31 +00:00
f4fbc59a16
Gtkdoc comments are used, among other things, to generate the various nm-setting-* manual pages. When a constant is referenced in a gtkdoc comment (i.e. `%NM_IP_TUNNEL_MODE_IPIP`) it is expanded to show the C name and the value (i.e. `NM_IP_TUNNEL_MODE_IPIP (1)`). To generate the nm-setting-* manual pages, we don't use gtkdoc, but we process this data with the custom script tools/generate-docs-nm-settings-docs-gir.py. This script was expanding the constants in the same way than gtkdoc. Showing the constants in that way in nm-setting-* manual pages makes little sense, because users are not going to use the C identifiers. Let's show them with a more appropriate format. Additionally, the different nm-setting-* pages might require different formats than the other. For example, for nm-setting-nmcli a format like `"ipip" (1)` is prefered, but for nm-setting-dbus it's better `1 (ipip)`. Let's generate different nm-settings-docs-gir-*.xml files for nmcli, dbus, keyfile and ifcfg-rh, using the right format for each one. |
||
|---|---|---|
| .. | ||
| nm-guest-data | ||
| check-compare-generated.sh | ||
| check-config-options.sh | ||
| check-docs.sh | ||
| check-exports.sh | ||
| check-gitlab-ci.sh | ||
| check-nm-autoptr.sh | ||
| check-tree.sh | ||
| check-vapi.sh | ||
| create-exports-NetworkManager.sh | ||
| debug-helper.py | ||
| enums-to-docbook.pl | ||
| generate-docs-nm-property-infos.py | ||
| generate-docs-nm-settings-docs-gir.py | ||
| generate-docs-nm-settings-docs-merge.py | ||
| generate-docs-settings-docs.py | ||
| meson-post-install.sh | ||
| nm-in-container | ||
| nm-in-vm | ||
| run-nm-test.sh | ||
| test-build.sh | ||
| test-cloud-meta-mock.py | ||
| test-networkmanager-service.py | ||
| test-sudo-wrapper.sh | ||