Merge some comments from server.conf into "man NetworkManager.conf"

The latter should have the full+canonical description, and the config
file comments should be very brief, and link to it for more info.

2 files changed, 33 insertions, 40 deletions

diff --git a/data/server.conf.in b/data/server.conf.in
index f96cec9f9d..df3397b572 100644
--- a/data/server.conf.in
+++ b/data/server.conf.in
@@ -1,41 +1,15 @@
 # This is a sample configuration file that could be edited and
 # dropped into @sysconfdir@/NetworkManager/conf.d to disable certain
 # bits of automatic behavior that might not be wanted on servers.
-
-[main]
-
-# Normally, if there is an ethernet device that is not matched by any
-# existing configured connection, NetworkManager will create a
-# "default" connection for that device, using automatic (DHCP/SLAAC)
-# IP configuration. You can use no-auto-default to disable this
-# behavior for individual devices or for all devices on the system
 #
-# Note that if you delete an existing "default" connection, NM will
-# remember this by adding the device's hardware address to
-# @localstatedir@/run/NetworkManager/no-auto-default.state; the devices
-# indicated in this file will be appended to the value of the
-# no-auto-default key.
-
-#no-auto-default=eth0,eth1
-#no-auto-default=11:22:33:44:55:66
-#no-auto-default=*
+# See "man NetworkManager.conf" for more information about these
+# individual keys.
 
+[main]
+# Do not do automatic (DHCP/SLAAC) configuration on ethernet devices
+# with no other matching connections.
+no-auto-default=*
 
-# Normally, for device types that support carrier-detect, such as
-# Ethernet and InfiniBand, NetworkManager will only allow a connection
-# to be activated on the device if carrier is present (ie, a cable is
-# plugged in). You can set ignore-carrier to disable this behavior,
-# for individual devices or for all devices on the system.
-#
-# Note that the "carrier" property of NMDevices and device D-Bus
-# interfaces will still reflect the actual device state; it's just
-# that NetworkManager will not make use of that information.
-#
-# You should probably not set this to apply to devices where you are
-# doing automatic IP config, since they will eventually fail if there
-# is no actual network connectivity, and NetworkManager won't retry
-# them right away when carrier comes back up (since it's ignoring it).
-
-#ignore-carrier=eth0,ib0
-#ignore-carrier=aa:bb:cc:dd:ee:ff
-#ignore-carrier=*
+# Ignore the carrier (cable plugged in) state when attempting to
+# activate connections.
+ignore-carrier=*
diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml
index fa87a0c593..d735cfe330 100644
--- a/man/NetworkManager.conf.xml
+++ b/man/NetworkManager.conf.xml
@@ -145,11 +145,30 @@ Copyright (C) 2010 - 2013 Red Hat, Inc.
 
       <varlistentry>
 	<term><varname>ignore-carrier</varname></term>
-	<listitem><para>Set devices for which NetworkManager should
-	ignore device carrier state when deciding whether to
-	activate or deactivate connections.  May have the special
-	value <literal>*</literal> to apply to all
-	devices.</para></listitem>
+	<listitem>
+	  <para>
+	    Comma-separated list of devices for which
+	    NetworkManager will ignore the carrier (cable plugged in)
+	    state.  Normally, for device types that support
+	    carrier-detect, such as Ethernet and InfiniBand,
+	    NetworkManager will only allow a connection to be activated on
+	    the device if carrier is present (ie, a cable is plugged in).
+	    List a device here to allow attempting to activate a
+	    connection anyways.  May have the special value
+	    <literal>*</literal> to apply to all devices.
+	  </para>
+	  <para>
+	    Note that the "carrier" property of NMDevices and device D-Bus
+	    interfaces will still reflect the actual device state; it's just
+	    that NetworkManager will not make use of that information.
+	  </para>
+	  <para>
+	    You should probably not set this to apply to devices where you are
+	    doing automatic IP config, since they will eventually fail if there
+	    is no actual network connectivity, and NetworkManager won't retry
+	    them right away when carrier comes back up (since it's ignoring it).
+	  </para>
+	</listitem>
       </varlistentry>
 
       <varlistentry>