Network config arrays are now split by embedded new lines instead of being evaled into space separated values. This makes it easier to read, maintain and document as discussed on gentoo-dev.

1 files changed, 66 insertions, 59 deletions

diff --git a/conf.d.Linux/net.example b/conf.d.Linux/net.example
index 584000e2..ed69d13d 100644
--- a/conf.d.Linux/net.example
+++ b/conf.d.Linux/net.example
@@ -27,14 +27,15 @@
 # OLD
 # config_eth0=( "192.168.0.24 netmask 255.255.255.0" "192.168.0.25/24" )
 # NEW
-# config_eth0="'192.168.0.24 netmask 255.255.255.0' 192.168.0.25/24"
+# config_eth0="192.168.0.24 netmask 255.255.255.0
+# 192.168.0.25/24"
 # INVALID
-# config_eth0='192.168.0.24 netmask 255.255.255.0'
+# config_eth0="192.168.0.24 netmask 255.255.255.0 192.168.0.25/24"
+# INVALID
+# config_eth0="192.168.0.24 netmask 255.255.255.0 \n 192.168.0.25/24"
 #
-# As the 1st value has spaces in it, it needs additional quoting. The 2nd
-# value has no spaces, therefore no additional quoting is required.
-# The last statement is invalid because when it is evaluated, it only has one
-# set of quotes.
+# Basically if array elements may need spaces in their values then we separate
+# on a hard coded new line.
 
 ##############################################################################
 # MODULES
@@ -80,27 +81,29 @@
 # For a static configuration, use something like this
 # (They all do exactly the same thing btw)
 #config_eth0="192.168.0.2/24"
-#config_eth0="'192.168.0.2 netmask 255.255.255.0'"
+#config_eth0="192.168.0.2 netmask 255.255.255.0"
 
 # We can also specify a broadcast
-#config_eth0="'192.168.0.2/24 brd 192.168.0.255'"
-#config_eth0="'192.168.0.2 netmask 255.255.255.0 broadcast 192.168.0.255'"
+#config_eth0="192.168.0.2/24 brd 192.168.0.255"
+#config_eth0="192.168.0.2 netmask 255.255.255.0 broadcast 192.168.0.255"
 
 # If you need more than one address, you can use something like this
 # NOTE: ifconfig creates an aliased device for each extra IPv4 address
 #       (eth0:1, eth0:2, etc)
 #       iproute2 does not do this as there is no need to
-#config_eth0="'192.168.0.2/24' '192.168.0.3/24' '192.168.0.4/24'"
+#config_eth0="192.168.0.2/24
+#192.168.0.3/24
+#192.168.0.4/24"
 # Or you can use sequence expressions
-#config_eth0="192.168.0.{2..4}/24" # FIXME - does it work?
+#config_eth0="192.168.0.{2..4}/24"
 # which does the same as above. Be careful though as if you use this and
 # fallbacks, you have to ensure that both end up with the same number of
 # values otherwise your fallback won't work correctly.
 
 # You can also use IPv6 addresses
 # (you should always specify a prefix length with IPv6 here)
-#config_eth0="192.168.0.2/24 \
-#4321:0:1:2:3:4:567:89ab/64 \
+#config_eth0="192.168.0.2/24
+#4321:0:1:2:3:4:567:89ab/64
 #4321:0:1:2:3:4:567:89ac/64"
 #)
 
@@ -109,23 +112,22 @@
 # are no addresses assigned, then we move onto the next step (default dhcp)
 # This is useful when configuring your interface with a kernel command line
 # or similar
-#config_eth0="noop 192.168.0.2/24"
+#config_eth0="noop
+#192.168.0.2/24"
 
 # If you don't want ANY address (only useful when calling for advanced stuff)
 #config_eth0="null"
 
 # Here's how to do routing if you need it
 # We add an IPv4 default route, IPv4 subnet route and an IPv6 unicast route
-#routes_eth0=" \
-#	'default via 192.168.0.1' \
-#	'10.0.0.0/8 via 192.168.0.1' \
-#	'::/0' \
-#"
+#routes_eth0="default via 192.168.0.1
+#10.0.0.0/8 via 192.168.0.1
+#::/0"
 
 # If a specified module fails (like dhcp - see below), you can specify a
 # fallback like so
-#fallback_eth0="'192.168.0.2 netmask 255.255.255.0'"
-#fallback_route_eth0="'default via 192.168.0.1'"
+#fallback_eth0="192.168.0.2 netmask 255.255.255.0"
+#fallback_route_eth0="default via 192.168.0.1"
 
 # NOTE: fallback entry must match the entry location in config_eth0
 # As such you can only have one fallback route.
@@ -217,11 +219,9 @@
 # the iwpriv $iface. If you use the rt2500 driver (not the rt2x00 one) then
 # you can set WPA here, below is an example.
 #iwpriv_eth0=""
-#iwpriv_SSID=" \
-#	'set AuthMode=WPAPSK' \
-#	'set EncrypType=TKIP' \
-#	'set WPAPSK=yourpasskey' \
-#"
+#iwpriv_SSID="set AuthMode=WPAPSK
+#set EncrypType=TKIP
+#set WPAPSK=yourpasskey"
 #NOTE: Even though you can use WPA like so, you may have to set a WEP key
 #if your driver claims the AP is encrypted. The WEP key itself will not be
 #used though.
@@ -326,10 +326,12 @@
 # Surround each SSID with the " character and seperate them with a space
 # If the first SSID isn't found then it moves onto the next
 # If this isn't defined then it connects to the first one found
-#preferred_aps="'SSID 1' 'SSID 2'"
+#preferred_aps="SSID 1
+#SSID 2"
 
 # You can also define a preferred_aps list per interface
-#preferred_aps_eth0="'SSID 3' 'SSID 4'"
+#preferred_aps_eth0="SSID 3
+#SSID 4'"
 
 # You can also say whether we only connect to preferred APs or not
 # Values are "any", "preferredonly", "forcepreferred", "forcepreferredonly" and "forceany"
@@ -346,8 +348,10 @@
 #associate_order_eth0="any"
 
 # You can define blacklisted Access Points in the same way
-#blacklist_aps="'SSID 1' 'SSID 2'"
-#blacklist_aps_eth0="'SSID 3' 'SSID 4'"
+#blacklist_aps="SSID 1
+#SSID 2"
+#blacklist_aps_eth0="SSID 3
+#SSID 4"
 
 # If you have more than one wireless card, you can say if you want
 # to allow each card to associate with the same Access Point or not
@@ -508,7 +512,7 @@
 #
 #gateways_eth0="192.168.0.1 10.0.0.1"
 #config_192168000001="192.168.0.2/24"
-#routes_192168000001="'default via 192.168.0.1'"
+#routes_192168000001="default via 192.168.0.1"
 #dns_servers_192168000001="192.168.0.1"
 #config_010000000001="10.0.0.254/8"
 #routes_010000000001="default via 10.0.0.1"
@@ -560,10 +564,11 @@
 #config_eth0="null"
 
 # You can also configure the VLAN - see for vconfig man page for more details
-#vconfig_eth0="'set_name_type VLAN_PLUS_VID_NO_PAD'"
-#vconfig_vlan1="'set_flag 1' 'set_egress_map 2 6'"
-#config_vlan1="'172.16.3.1 netmask 255.255.254.0'"
-#config_vlan2="'172.16.2.1 netmask 255.255.254.0'"
+#vconfig_eth0="set_name_type VLAN_PLUS_VID_NO_PAD"
+#vconfig_vlan1="set_flag 1
+#set_egress_map 2 6"
+#config_vlan1="172.16.3.1 netmask 255.255.254.0"
+#config_vlan2="172.16.2.1 netmask 255.255.254.0"
 
 # NOTE: Vlans can be configured with a . in their interface names
 # When configuring vlans with this name type, you need to replace . with a _
@@ -602,7 +607,7 @@
 
 # Ensure that you have /etc/atmsigd.conf setup correctly
 # Now setup each clip interface like so
-#clip_atm0="'peer_ip [if.]vpi.vci [opts]'"
+#clip_atm0="peer_ip [if.]vpi.vci [opts],"
 #  where "peer_ip" is the IP address of a PVC peer (in case of an ATM connection
 #  with your ISP, your only peer is usually the ISP gateway closest to you),
 #  "if" is the number of the ATM interface which will carry the PVC, "vpi.vci"
@@ -610,7 +615,7 @@
 #  qos, pcr, and the like (see "atmarp -s" for further reference). Please also
 #  note quoting: it is meant to distinguish the VCs you want to create. You may,
 #  in example, create an atm0 interface to more peers, like this:
-#clip_atm0="'1.1.1.254 0.8.35' 1.1.1.253 1.8.35'"
+#clip_atm0="1.1.1.254,0.8.35 1.1.1.253,1.8.35"
 
 #  By default, the PVC will use the LLC/SNAP encapsulation. If you rather need a
 #  null encapsulation (aka "VC mode"), please add the keyword "null" to opts.
@@ -652,38 +657,38 @@
 # and may seem daunting, it is recommended that you read the pppd man page
 # before enabling any of them
 #pppd_ppp0="
-#	'maxfail 0'	# WARNING: It's not recommended you use this
+#	maxfail 0	# WARNING: It's not recommended you use this
 #			# if you don't specify maxfail then we assume 0
-#	'updetach' 	# If not set, "/etc/init.d/net.ppp0 start" will return
+#	updetach 	# If not set, "/etc/init.d/net.ppp0 start" will return
 #			# immediately,  without waiting the link to come up
 #			# for the first time.
 #			# Do not use it for dial-on-demand links!
-#	'debug' 	# Enables syslog debugging
-#	'noauth'	# Do not require the peer to authenticate itself
-#	'defaultroute'	# Make this PPP interface the default route
-#	'usepeerdns'	# Use the DNS settings provided by PPP
+#	debug 	# Enables syslog debugging
+#	noauth	# Do not require the peer to authenticate itself
+#	defaultroute	# Make this PPP interface the default route
+#	usepeerdns		# Use the DNS settings provided by PPP
 #
 # On demand options
-#	'demand'		# Enable dial on demand
-#	'idle 30'		# Link goes down after 30 seconds of inactivity
-#	'10.112.112.112:10.112.112.113'	# Phony IP addresses
-#	'ipcp-accept-remote'	# Accept the peers idea of remote address
-#	'ipcp-accept-local'	# Accept the peers idea of local address
-#	'holdoff 3' 	# Wait 3 seconds after link dies before re-starting
+#	demand		# Enable dial on demand
+#	idle 30		# Link goes down after 30 seconds of inactivity
+#	10.112.112.112:10.112.112.113	# Phony IP addresses
+#	ipcp-accept-remote	# Accept the peers idea of remote address
+#	ipcp-accept-local	# Accept the peers idea of local address
+#	holdoff 3 	# Wait 3 seconds after link dies before re-starting
 #
 # Dead peer detection
-#	'lcp-echo-interval 15'	# Send a LCP echo every 15 seconds
-#	'lcp-echo-failure 3'	# Make peer dead after 3 consective
+#	lcp-echo-interval 15	# Send a LCP echo every 15 seconds
+#	lcp-echo-failure 3	# Make peer dead after 3 consective
 #				# echo-requests
 #	
 # Compression options - use these to completely disable compression
 #	noaccomp noccp nobsdcomp nodeflate nopcomp novj novjccomp
 #
 # Dial-up settings
-#	'lock'				# Lock serial port
-#	'115200'			# Set the serial port baud rate
-#	'modem crtscts'			# Enable hardware flow control
-#	'192.168.0.1:192.168.0.2'	# Local and remote IP addresses
+#	lock				# Lock serial port
+#	115200			# Set the serial port baud rate
+#	modem crtscts			# Enable hardware flow control
+#	192.168.0.1:192.168.0.2	# Local and remote IP addresses
 #"
 #
 # Dial-up PPP users need to specify at least one telephone number
@@ -814,7 +819,9 @@
 
 # Below is an example of configuring the bridge
 # Consult "man brctl" for more details
-#brctl_br0="'setfd 0' 'sethello 0' 'stp off'"
+#brctl_br0="setfd 0
+#sethello 0
+#stp off"
 
 #-----------------------------------------------------------------------------
 # RFC 2684 Bridge Support 
@@ -844,8 +851,8 @@
 #iptunnel_vpn0="mode ipip remote 207.170.82.2 ttl 255"
 
 # To configure the interface
-#config_vpn0="'192.168.0.2 pointopoint 192.168.1.2'"	# ifconfig style
-#config_vpn0="'192.168.0.2 peer 192.168.1.1'"		# iproute2 style
+#config_vpn0="192.168.0.2 pointopoint 192.168.1.2"	# ifconfig style
+#config_vpn0="192.168.0.2 peer 192.168.1.1"		# iproute2 style
 
 # 6to4 Tunnels allow IPv6 to work over IPv4 addresses, provided you
 # have a non-private address configured on an interface.
@@ -876,7 +883,7 @@
 #dns_domain_eth0="your.domain"
 #dns_servers_eth0="192.168.0.2 192.168.0.3"
 #dns_search_eth0="this.domain that.domain"
-#dns_options_eth0="'timeout:1' rotate"
+#dns_options_eth0="timeout:1 rotate"
 #dns_sortlist_eth0="130.155.160.0/255.255.240.0 130.155.0.0"
 # See the man page for resolv.conf for details about the options and sortlist
 # directives