Bug 162354

Summary: Improve wording in rc.conf(5) regarding network-interfaces.
Product: Documentation Reporter: Moritz Wilhelmy <moritz>
Component: Books & ArticlesAssignee: Glen Barber <gjb>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Moritz Wilhelmy 2011-11-07 19:00:22 UTC
	According to rc.conf(5), ifconfig_<interface>_alias<n> is deprecated,
	because it fails if <n> is not continuously increasing (i.e. if a number is
	missing, the rc-scripts abort the search for bigger values of <n>.)
	It isn't specified what should be used instead; I guessed
	ipv4_addrs_<interface>, but Marco Steinbach brought
	/etc/start_if.<interface> to my attention, which is mentioned in the same
	paragraph. This is confusing. Could someone please clarify which one of
	these is supposed to be used in place of the deprecated
	ifconfig_<interface>_alias<n>, especially since ipv4_addrs_<interface> seems
	not to have an equivalent ipv6_* variable?
Comment 1 Glen Barber freebsd_committer freebsd_triage 2011-12-09 02:40:38 UTC
Responsible Changed
From-To: freebsd-doc->gjb

I'll look into this.
Comment 2 moritz 2013-08-31 16:20:41 UTC
Any updates on this? I think it's still there.
Comment 3 John Baldwin freebsd_committer freebsd_triage 2013-09-03 19:26:34 UTC
I don't think ifconfig_IF_aliasN is depreated, though you can now use
ifconfig_IF_aliases as an alternate.  Also, both ifconfig_IF_aliases
and ifconfig_IF_aliasN handle both IPv4 and IPv6.  See this commit for more
details:

http://svnweb.freebsd.org/base?view=revision&revision=252015

-- 
John Baldwin
Comment 4 Hiroki Sato freebsd_committer freebsd_triage 2013-09-04 05:22:35 UTC
----Security_Multipart(Wed_Sep__4_13_22_35_2013_678)--
Content-Type: Text/Plain; charset=us-ascii
Content-Transfer-Encoding: 7bit

John Baldwin <jhb@freebsd.org> wrote
  in <201309031426.34775.jhb@freebsd.org>:

jh> On Monday, November 07, 2011 12:09:36 pm moritz@wzff.de wrote:
jh> >
jh> > >Number:         162354
jh> > >Category:       docs
jh> > >Synopsis:       Improve wording in rc.conf(5) regarding network-interfaces.
jh> > >Confidential:   no
jh> > >Severity:       non-critical
jh> > >Priority:       low
jh> > >Responsible:    freebsd-doc
jh> > >State:          open
jh> > >Quarter:
jh> > >Keywords:
jh> > >Date-Required:
jh> > >Class:          doc-bug
jh> > >Submitter-Id:   current-users
jh> > >Arrival-Date:   Mon Nov 07 19:00:22 UTC 2011
jh> > >Closed-Date:
jh> > >Last-Modified:
jh> > >Originator:     Moritz Wilhelmy
jh> > >Release:        FreeBSD 9.0-RC1 amd64
jh> > >Organization:
jh> > >Environment:
jh> > >Description:
jh> > 	According to rc.conf(5), ifconfig_<interface>_alias<n> is deprecated,
jh> > 	because it fails if <n> is not continuously increasing (i.e. if a number
jh> is
jh> > 	missing, the rc-scripts abort the search for bigger values of <n>.)
jh> > 	It isn't specified what should be used instead; I guessed
jh> > 	ipv4_addrs_<interface>, but Marco Steinbach brought
jh> > 	/etc/start_if.<interface> to my attention, which is mentioned in the same
jh> > 	paragraph. This is confusing. Could someone please clarify which one of
jh> > 	these is supposed to be used in place of the deprecated
jh> > 	ifconfig_<interface>_alias<n>, especially since ipv4_addrs_<interface>
jh> seems
jh> > 	not to have an equivalent ipv6_* variable?
jh>
jh> I don't think ifconfig_IF_aliasN is depreated, though you can now use
jh> ifconfig_IF_aliases as an alternate.  Also, both ifconfig_IF_aliases
jh> and ifconfig_IF_aliasN handle both IPv4 and IPv6.  See this commit for more
jh> details:
jh>
jh> http://svnweb.freebsd.org/base?view=revision&revision=252015

 The sentence "Due to this difficult to manage behavior, the
 ifconfig_IF_aliasN form is deprecated." was added back in 2005, when
 ipv4_addrs_IF was added.  I guess it was considered that
 ipv4_addrs_IF was the replacement of ifconfig_IF_aliasN.

 I refactored it in a AF-independent manner and used
 ifconfig_IF_aliases as the successor, but I did not change that part
 in rc.conf(5) manual page.  I think we can think both
 ifconfig_IF_aliasN and ifconfig_IF_aliases are currently supported.
 There is no immediate plan to remove ifconfig_IF_aliasN, at least.

 Is it reasonable to remove the sentence?

-- Hiroki

----Security_Multipart(Wed_Sep__4_13_22_35_2013_678)--
Content-Type: application/pgp-signature
Content-Transfer-Encoding: 7bit

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.13 (FreeBSD)

iEYEABECAAYFAlImtYsACgkQTyzT2CeTzy0JigCfSMqqWcktXh/veI5I+tCRqLdv
abEAnR2kjJIV0Bq4WbnwN8iXywWsrQZh
=KGVH
-----END PGP SIGNATURE-----

----Security_Multipart(Wed_Sep__4_13_22_35_2013_678)----
Comment 5 Moritz Wilhelmy 2013-09-04 08:49:43 UTC
On Wed, Sep 04, 2013 at 13:22:35 +0900, Hiroki Sato wrote:
> John Baldwin <jhb@freebsd.org> wrote
>   in <201309031426.34775.jhb@freebsd.org>:
> jh> I don't think ifconfig_IF_aliasN is depreated, though you can now use
> jh> ifconfig_IF_aliases as an alternate.  Also, both ifconfig_IF_aliases
> jh> and ifconfig_IF_aliasN handle both IPv4 and IPv6.  See this commit for more
> jh> details:
> jh>
> jh> http://svnweb.freebsd.org/base?view=revision&revision=252015

Thanks. Having both IPv6 and IPv4 in the same place with the ability to
just configure an entire subnet sounds like a sane decision.

>  The sentence "Due to this difficult to manage behavior, the
>  ifconfig_IF_aliasN form is deprecated." was added back in 2005, when
>  ipv4_addrs_IF was added.  I guess it was considered that
>  ipv4_addrs_IF was the replacement of ifconfig_IF_aliasN.
> 
>  I refactored it in a AF-independent manner and used
>  ifconfig_IF_aliases as the successor, but I did not change that part
>  in rc.conf(5) manual page.  I think we can think both
>  ifconfig_IF_aliasN and ifconfig_IF_aliases are currently supported.
>  There is no immediate plan to remove ifconfig_IF_aliasN, at least.
> 
>  Is it reasonable to remove the sentence?

I think it is. Thank you!
I see the changes are already in 9.2 so I'm happy for now :)

Moritz
Comment 6 dfilter service freebsd_committer freebsd_triage 2013-09-17 21:20:12 UTC
Author: hrs
Date: Tue Sep 17 20:20:04 2013
New Revision: 255652
URL: http://svnweb.freebsd.org/changeset/base/255652

Log:
  Remove description "ifconfig_IF_aliasN is deprecated".  While this
  sentence was added in 2005, many users still need it.
  
  Approved by:	re (gjb)
  PR:		docs/162354

Modified:
  head/share/man/man5/rc.conf.5

Modified: head/share/man/man5/rc.conf.5
==============================================================================
--- head/share/man/man5/rc.conf.5	Tue Sep 17 20:09:25 2013	(r255651)
+++ head/share/man/man5/rc.conf.5	Tue Sep 17 20:20:04 2013	(r255652)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd July 22, 2013
+.Dd September 10, 2013
 .Dt RC.CONF 5
 .Os
 .Sh NAME
@@ -1192,10 +1192,8 @@ be added since the search would
 stop with the missing
 .Dq Li alias3
 entry.
-Due to this difficult to manage behavior, the
-.Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
-form is deprecated.
-There is
+Because of this difficult to manage behavior,
+there is
 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
 variable, which has the same functionality as
 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"