fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-05-16 14:08:12 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Improve documentation of ip-tunnel.mode property

Browse source 
Use the new "expand enumvals" feature of the doc generation scripts
to document the accepted values more accurately. This way, all
possible values are shown.

New generated text for dbus man page:
The tunneling mode, valid values: NM_IP_TUNNEL_MODE_IPIP (1), NM_IP_TUNNEL_MODE_GRE (2), NM_IP_TUNNEL_MODE_SIT (3), NM_IP_TUNNEL_MODE_ISATAP (4), NM_IP_TUNNEL_MODE_VTI (5), NM_IP_TUNNEL_MODE_IP6IP6 (6), NM_IP_TUNNEL_MODE_IPIP6 (7), NM_IP_TUNNEL_MODE_IP6GRE (8), NM_IP_TUNNEL_MODE_VTI6 (9), NM_IP_TUNNEL_MODE_GRETAP (10), NM_IP_TUNNEL_MODE_IP6GRETAP (11)

New generated text for nmcli, both for interactive mode and for the
man page:
The tunneling mode, valid values: ipip (1), gre (2), sit (3), isatap (4), vti (5), ip6ip6 (6), ipip6 (7), ip6gre (8), vti6 (9), gretap (10), ip6gretap (11)

In this case, the "enumvals with docs expansion" hasn't been used
because the option names are self explanatory and their explanations don't
add additional value.
This commit is contained in:
Íñigo Huguet 2023-08-11 15:58:43 +02:00
parent 5fee7be1d1
commit 4da7c13d93
2 changed files with 11 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/libnm-core-impl/nm-setting-ip-tunnel.c
View file

@ -593,11 +593,15 @@ nm_setting_ip_tunnel_class_init(NMSettingIPTunnelClass *klass)
/**
* NMSettingIPTunnel:mode:
*
* The tunneling mode, for example %NM_IP_TUNNEL_MODE_IPIP or
* %NM_IP_TUNNEL_MODE_GRE.
* The tunneling mode, valid values: #NMIPTunnelMode.
*
* Since: 1.2
**/
/* ---nmcli,dbus---
* property: mode
* description: The tunneling mode, valid values: #NMIPTunnelMode:*
* ---end---
*/
_nm_setting_property_define_direct_uint32(properties_override,
obj_properties,
NM_SETTING_IP_TUNNEL_MODE,

5
src/libnm-core-public/nm-dbus-interface.h
View file

@ -943,6 +943,11 @@ typedef enum /*< flags >*/ {
* Since: 1.2
*/
typedef enum {
/**
* NM_IP_TUNNEL_MODE_UNKNOWN: (attributes NM.internal=1)
*
* Unknown/unset tunnel mode
*/
NM_IP_TUNNEL_MODE_UNKNOWN = 0,
NM_IP_TUNNEL_MODE_IPIP = 1,
NM_IP_TUNNEL_MODE_GRE = 2,