From 7ead660da136cbfd56a63a960a0eaead64b3f819 Mon Sep 17 00:00:00 2001

From: Thomas Haller <thaller@redhat.com>

Date: Fri, 19 Aug 2016 10:58:53 +0200

Subject: [PATCH 1/1] patch documentation with the proper default values

We don't regenerate the documentation for RHEL builds, but

the docs from the tarball are generated with a certain set

of defaults.

Patch the man pages with the proper values.

---

 docs/api/html/NetworkManager.conf.html              | 21 ++++++++++++++++-----

 ...gdbus-org.freedesktop.NetworkManager.Device.html | 15 +++++++++++++++

 man/NetworkManager.conf.5                           | 19 ++++++++++++++-----

 3 files changed, 45 insertions(+), 10 deletions(-)

diff --git a/docs/api/html/NetworkManager.conf.html b/docs/api/html/NetworkManager.conf.html

index b43f5ac56..a57e46ebe 100644

--- a/docs/api/html/NetworkManager.conf.html

+++ b/docs/api/html/NetworkManager.conf.html

@@ -183,7 +183,7 @@ plugins-=remove-me

         clients to be installed. The internal

         option uses a built-in DHCP client which is not currently as

         featureful as the external clients.

-
If this key is missing, it defaults to internal.

+
If this key is missing, it defaults to dhclient.

         It the chosen plugin is not available, clients are looked for

         in this order: dhclient, dhcpcd,

         internal.

@@ -338,7 +338,7 @@ no-auto-default=*

 
Set the resolv.conf

         management mode. The default value depends on NetworkManager build

         options, and this version of NetworkManager was build with a default of

-        "symlink".

+        "file".

         Regardless of this setting, NetworkManager will

         always write resolv.conf to its runtime state directory

         /var/run/NetworkManager/resolv.conf.

@@ -396,6 +396,17 @@ no-auto-default=*

             times.

+

+
slaves-order

+

+            This key specifies in which order slave connections are

+            auto-activated on boot or when the master activates

+            them. Allowed values are name (order

+            connection by interface name, the default), or

+            index (order slaves by their kernel

+            index).

+          

+

@@ -601,7 +612,7 @@ ipv6.ip6-privacy=0

 
ethernet.cloned-mac-address

-
If left unspecified, it defaults to "preserve".

+
If left unspecified, it defaults to "permanent".

 
ethernet.generate-mac-address-mask

@@ -609,7 +620,7 @@ ipv6.ip6-privacy=0

 
ethernet.mtu

-
If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or a default of 1500.

+
If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or the MTU is not reconfigured during activation.

 
ethernet.wake-on-lan

@@ -652,7 +663,7 @@ ipv6.ip6-privacy=0

 
wifi.cloned-mac-address

-
If left unspecified, it defaults to "preserve".

+
If left unspecified, it defaults to "permanent".

 
wifi.generate-mac-address-mask

diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html

index b46b05ed6..229f11b40 100644

--- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html

+++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html

@@ -250,6 +250,9 @@ Udi  readable   s

         for a way to track a specific piece of hardware across reboot or hotplug,

         use a MAC address or USB serial number.

+
        Note that non-UTF-8 characters are backslash escaped. Use g_strcompress()

+        to obtain the true (non-UTF-8) string.

+

@@ -258,6 +261,9 @@ Udi  readable   s

 Interface  readable   s

 
        The name of the device's control (and often data) interface.

+        Note that non UTF-8 characters are backslash escaped, so the

+        resulting name may be longer then 15 characters. Use g_strcompress()

+        to revert the escaping.

@@ -270,6 +276,9 @@ IpInterface  readable   s

         not refer to the actual data interface until the device has successfully

         established a data connection, indicated by the device's State becoming

         ACTIVATED.

+        Note that non UTF-8 characters are backslash escaped, so the

+        resulting name may be longer then 15 characters. Use g_strcompress()

+        to revert the escaping.

@@ -279,6 +288,8 @@ IpInterface  readable   s

 Driver  readable   s

 
        The driver handling the device.

+        Non-UTF-8 sequences are backslash escaped. Use g_strcompress()

+        to revert.

@@ -288,6 +299,8 @@ Driver  readable   s

 DriverVersion  readable   s

 
        The version of the driver handling the device.

+        Non-UTF-8 sequences are backslash escaped. Use g_strcompress()

+        to revert.

@@ -297,6 +310,8 @@ DriverVersion  readable   s

 FirmwareVersion  readable   s

 
        The firmware version for the device.

+        Non-UTF-8 sequences are backslash escaped. Use g_strcompress()

+        to revert.

diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5

index 339a106de..3809de066 100644

--- a/man/NetworkManager.conf.5

+++ b/man/NetworkManager.conf.5

@@ -144,7 +144,7 @@ internal

 option uses a built\-in DHCP client which is not currently as featureful as the external clients\&.

 .sp

 If this key is missing, it defaults to

-internal\&. It the chosen plugin is not available, clients are looked for in this order:

+dhclient\&. It the chosen plugin is not available, clients are looked for in this order:

 dhclient,

 dhcpcd,

 internal\&.

@@ -252,7 +252,7 @@ rc\-manager\ \&unmanaged

 .RS 4

 Set the

 resolv\&.conf

-management mode\&. The default value depends on NetworkManager build options, and this version of NetworkManager was build with a default of "symlink"\&. Regardless of this setting, NetworkManager will always write resolv\&.conf to its runtime state directory

+management mode\&. The default value depends on NetworkManager build options, and this version of NetworkManager was build with a default of "file"\&. Regardless of this setting, NetworkManager will always write resolv\&.conf to its runtime state directory

 /var/run/NetworkManager/resolv\&.conf\&.

 .sp

 symlink: If

@@ -295,6 +295,15 @@ The number of times a connection activation should be automatically tried before

 connection\&.autoconnect\-retries

 property set to \-1\&. If not specified, connections will be retried 4 times\&.

 .RE

+.PP

+\fIslaves\-order\fR

+.RS 4

+This key specifies in which order slave connections are auto\-activated on boot or when the master activates them\&. Allowed values are

+name

+(order connection by interface name, the default), or

+index

+(order slaves by their kernel index)\&.

+.RE

 .SH "KEYFILE SECTION"

 .PP

 This section contains keyfile\-plugin\-specific options, and is normally only used when you are not using any other distro\-specific plugin\&.

@@ -584,7 +593,7 @@ for details)\&. A default value is only consulted if the corresponding per\-conn

 .PP

 \fIethernet\&.cloned\-mac\-address\fR

 .RS 4

-If left unspecified, it defaults to "preserve"\&.

+If left unspecified, it defaults to "permanent"\&.

 .RE

 .PP

 \fIethernet\&.generate\-mac\-address\-mask\fR

@@ -593,7 +602,7 @@ If left unspecified, it defaults to "preserve"\&.

 .PP

 \fIethernet\&.mtu\fR

 .RS 4

-If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints\&. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or a default of 1500\&.

+If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints\&. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or the MTU is not reconfigured during activation\&.

 .RE

 .PP

 \fIethernet\&.wake\-on\-lan\fR

@@ -641,7 +650,7 @@ If left unspecified, default value of 60 seconds is used\&.

 .PP

 \fIwifi\&.cloned\-mac\-address\fR

 .RS 4

-If left unspecified, it defaults to "preserve"\&.

+If left unspecified, it defaults to "permanent"\&.

 .RE

 .PP

 \fIwifi\&.generate\-mac\-address\-mask\fR

-- 

2.13.0