[PATCH iproute2 1/4] man: drop references to Debian-specific paths

[PATCH iproute2 1/4] man: drop references to Debian-specific paths

[Luca Boccassi]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=UTF-8, Size: 1699 bytes --]

Documentation should be distribution-agnostic - any specific quirks
should be handled by downstream maintainers, if necessary.
Remove mentions of Debian paths and package names.

Signed-off-by: Luca Boccassi <bluca@debian.org>
---
 man/man8/lnstat.8 | 3 +--
 man/man8/ss.8     | 3 +--
 2 files changed, 2 insertions(+), 4 deletions(-)

diff --git a/man/man8/lnstat.8 b/man/man8/lnstat.8
index acd5f4a2..b98241bf 100644
--- a/man/man8/lnstat.8
+++ b/man/man8/lnstat.8
@@ -254,8 +254,7 @@ Number of hash table list traversals for output traffic. Deprecated since IP
 route cache removal, therefore always zero.
 
 .SH SEE ALSO
-.BR ip (8),
-and /usr/share/doc/iproute-doc/README.lnstat (package iproute-doc on Debian)
+.BR ip (8)
 .br
 .SH AUTHOR
 lnstat was written by Harald Welte <laforge@gnumonks.org>.
diff --git a/man/man8/ss.8 b/man/man8/ss.8
index 0d526734..973afbe0 100644
--- a/man/man8/ss.8
+++ b/man/man8/ss.8
@@ -327,7 +327,7 @@ Read filter information from FILE.
 Each line of FILE is interpreted like single command line option. If FILE is - stdin is used.
 .TP
 .B FILTER := [ state STATE-FILTER ] [ EXPRESSION ]
-Please take a look at the official documentation (Debian package iproute-doc) for details regarding filters.
+Please take a look at the official documentation for details regarding filters.
 
 .SH STATE-FILTER
 
@@ -382,7 +382,6 @@ Find all local processes connected to X server.
 List all the tcp sockets in state FIN-WAIT-1 for our apache to network 193.233.7/24 and look at their timers.
 .SH SEE ALSO
 .BR ip (8),
-.BR /usr/share/doc/iproute-doc/ss.html " (package iproute­doc)",
 .br
 .BR RFC " 793 "
 - https://tools.ietf.org/rfc/rfc793.txt (TCP states)
-- 
2.14.2

[PATCH iproute2 2/4] man: add more keywords to ip.8 short description

[Luca Boccassi]

A Debian user suggested adding more network-related keywords to the
ip manpage, so that manpage-scraping and indexing software like
apropos can do a better job of categorizing the programs.

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=877983

Suggested-by: Lynoure Braakman <lynoure@gmail.com>
Signed-off-by: Luca Boccassi <bluca@debian.org>
---
 man/man8/ip.8 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man8/ip.8 b/man/man8/ip.8
index ae018fdf..94e64319 100644
--- a/man/man8/ip.8
+++ b/man/man8/ip.8
@@ -1,6 +1,6 @@
 .TH IP 8 "20 Dec 2011" "iproute2" "Linux"
 .SH NAME
-ip \- show / manipulate routing, devices, policy routing and tunnels
+ip \- show / manipulate routing, network devices, policy routing, interfaces (ethernet and more) and tunnels
 .SH SYNOPSIS
 
 .ad l
-- 
2.14.2

Re: [PATCH iproute2 2/4] man: add more keywords to ip.8 short description

[Stephen Hemminger]

On Fri, 29 Dec 2017 23:01:23 +0100
Luca Boccassi <bluca@debian.org> wrote:

> A Debian user suggested adding more network-related keywords to the
> ip manpage, so that manpage-scraping and indexing software like
> apropos can do a better job of categorizing the programs.
> 
> https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=877983
> 
> Suggested-by: Lynoure Braakman <lynoure@gmail.com>
> Signed-off-by: Luca Boccassi <bluca@debian.org>
> ---
>  man/man8/ip.8 | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/man/man8/ip.8 b/man/man8/ip.8
> index ae018fdf..94e64319 100644
> --- a/man/man8/ip.8
> +++ b/man/man8/ip.8
> @@ -1,6 +1,6 @@
>  .TH IP 8 "20 Dec 2011" "iproute2" "Linux"
>  .SH NAME
> -ip \- show / manipulate routing, devices, policy routing and tunnels
> +ip \- show / manipulate routing, network devices, policy routing, interfaces (ethernet and more) and tunnels

Let's just keep it short and drop out policy routing (since that is part of routing anyway
and drop the (ethernet and more).

Re: [PATCH iproute2 2/4] man: add more keywords to ip.8 short description

[Luca Boccassi]

[-- Attachment #1: Type: text/plain, Size: 1244 bytes --]

On Fri, 2017-12-29 at 20:02 -0800, Stephen Hemminger wrote:
> On Fri, 29 Dec 2017 23:01:23 +0100
> Luca Boccassi <bluca@debian.org> wrote:
> 
> > A Debian user suggested adding more network-related keywords to the
> > ip manpage, so that manpage-scraping and indexing software like
> > apropos can do a better job of categorizing the programs.
> > 
> > https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=877983
> > 
> > Suggested-by: Lynoure Braakman <lynoure@gmail.com>
> > Signed-off-by: Luca Boccassi <bluca@debian.org>
> > ---
> >  man/man8/ip.8 | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/man/man8/ip.8 b/man/man8/ip.8
> > index ae018fdf..94e64319 100644
> > --- a/man/man8/ip.8
> > +++ b/man/man8/ip.8
> > @@ -1,6 +1,6 @@
> >  .TH IP 8 "20 Dec 2011" "iproute2" "Linux"
> >  .SH NAME
> > -ip \- show / manipulate routing, devices, policy routing and
> > tunnels
> > +ip \- show / manipulate routing, network devices, policy routing,
> > interfaces (ethernet and more) and tunnels
> 
> Let's just keep it short and drop out policy routing (since that is
> part of routing anyway
> and drop the (ethernet and more).

Sure, done in v2

-- 
Kind regards,
Luca Boccassi

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

[PATCH iproute2 3/4] man: ip-address: document 15-char limit for LABEL

[Luca Boccassi]

Trying to set a label longer than 15 characters returns an error:
 RTNETLINK answers: Numerical result out of range

Document the limit in the manpage.

Originally reported as a Debian bug:

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=661886

Reported-by: Gabor Kiss <kissg@ssg.ki.iif.hu>
Signed-off-by: Luca Boccassi <bluca@debian.org>
---
 man/man8/ip-address.8.in | 1 +
 1 file changed, 1 insertion(+)

diff --git a/man/man8/ip-address.8.in b/man/man8/ip-address.8.in
index eaa179c6..e7f14533 100644
--- a/man/man8/ip-address.8.in
+++ b/man/man8/ip-address.8.in
@@ -190,6 +190,7 @@ Each address may be tagged with a label string.
 In order to preserve compatibility with Linux-2.0 net aliases,
 this string must coincide with the name of the device or must be prefixed
 with the device name followed by colon.
+The maximum allowed length is 15 characters.
 
 .TP
 .BI scope " SCOPE_VALUE"
-- 
2.14.2

Re: [PATCH iproute2 3/4] man: ip-address: document 15-char limit for LABEL

[Stephen Hemminger]

On Fri, 29 Dec 2017 23:01:24 +0100
Luca Boccassi <bluca@debian.org> wrote:

> Trying to set a label longer than 15 characters returns an error:
>  RTNETLINK answers: Numerical result out of range
> 
> Document the limit in the manpage.
> 
> Originally reported as a Debian bug:
> 
> https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=661886
> 
> Reported-by: Gabor Kiss <kissg@ssg.ki.iif.hu>
> Signed-off-by: Luca Boccassi <bluca@debian.org>
> ---
>  man/man8/ip-address.8.in | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/man/man8/ip-address.8.in b/man/man8/ip-address.8.in
> index eaa179c6..e7f14533 100644
> --- a/man/man8/ip-address.8.in
> +++ b/man/man8/ip-address.8.in
> @@ -190,6 +190,7 @@ Each address may be tagged with a label string.
>  In order to preserve compatibility with Linux-2.0 net aliases,
>  this string must coincide with the name of the device or must be prefixed
>  with the device name followed by colon.
> +The maximum allowed length is 15 characters.

Since these are aliases, lets be precise:
The maximum allowed total length of label is 15 characters.

Re: [PATCH iproute2 3/4] man: ip-address: document 15-char limit for LABEL

[Luca Boccassi]

[-- Attachment #1: Type: text/plain, Size: 1315 bytes --]

On Fri, 2017-12-29 at 20:04 -0800, Stephen Hemminger wrote:
> On Fri, 29 Dec 2017 23:01:24 +0100
> Luca Boccassi <bluca@debian.org> wrote:
> 
> > Trying to set a label longer than 15 characters returns an error:
> >  RTNETLINK answers: Numerical result out of range
> > 
> > Document the limit in the manpage.
> > 
> > Originally reported as a Debian bug:
> > 
> > https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=661886
> > 
> > Reported-by: Gabor Kiss <kissg@ssg.ki.iif.hu>
> > Signed-off-by: Luca Boccassi <bluca@debian.org>
> > ---
> >  man/man8/ip-address.8.in | 1 +
> >  1 file changed, 1 insertion(+)
> > 
> > diff --git a/man/man8/ip-address.8.in b/man/man8/ip-address.8.in
> > index eaa179c6..e7f14533 100644
> > --- a/man/man8/ip-address.8.in
> > +++ b/man/man8/ip-address.8.in
> > @@ -190,6 +190,7 @@ Each address may be tagged with a label string.
> >  In order to preserve compatibility with Linux-2.0 net aliases,
> >  this string must coincide with the name of the device or must be
> > prefixed
> >  with the device name followed by colon.
> > +The maximum allowed length is 15 characters.
> 
> Since these are aliases, lets be precise:
> The maximum allowed total length of label is 15 characters.

Ok, done in v2, thanks

-- 
Kind regards,
Luca Boccassi

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

[PATCH iproute2 4/4] man: routel/routef: don't mention filesystem paths

[Luca Boccassi]

The filesytem paths to these scripts might be different on various
distros, so don't mention it in the manpages. It is not really useful
information anyway.

Originally submitted as Debian bug:

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=561424

Reported-by: jidanni@jidanni.org
Signed-off-by: Luca Boccassi <bluca@debian.org>
---
 man/man8/routel.8 | 5 -----
 1 file changed, 5 deletions(-)

diff --git a/man/man8/routel.8 b/man/man8/routel.8
index 82d580fb..2270eacb 100644
--- a/man/man8/routel.8
+++ b/man/man8/routel.8
@@ -17,11 +17,6 @@ The routel script will list routes in a format that some might consider easier t
 .br
 The routef script does not take any arguments and will simply flush the routing table down the drain. Beware! This means deleting all routes which will make your network unusable!
 
-.SH "FILES"
-.LP
-\fI/usr/bin/routef\fP
-.br
-\fI/usr/bin/routel\fP
 .SH "AUTHORS"
 .LP
 The routel script was written by Stephen R. van den Berg <srb@cuci.nl>, 1999/04/18 and donated to the public domain.
-- 
2.14.2

Re: [PATCH iproute2 4/4] man: routel/routef: don't mention filesystem paths

[Stephen Hemminger]

On Fri, 29 Dec 2017 23:01:25 +0100
Luca Boccassi <bluca@debian.org> wrote:

> The filesytem paths to these scripts might be different on various
> distros, so don't mention it in the manpages. It is not really useful
> information anyway.
> 
> Originally submitted as Debian bug:
> 
> https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=561424
> 
> Reported-by: jidanni@jidanni.org
> Signed-off-by: Luca Boccassi <bluca@debian.org>
> ---
>  man/man8/routel.8 | 5 -----
>  1 file changed, 5 deletions(-)
> 
> diff --git a/man/man8/routel.8 b/man/man8/routel.8
> index 82d580fb..2270eacb 100644
> --- a/man/man8/routel.8
> +++ b/man/man8/routel.8
> @@ -17,11 +17,6 @@ The routel script will list routes in a format that some might consider easier t
>  .br
>  The routef script does not take any arguments and will simply flush the routing table down the drain. Beware! This means deleting all routes which will make your network unusable!
>  
> -.SH "FILES"
> -.LP
> -\fI/usr/bin/routef\fP
> -.br
> -\fI/usr/bin/routel\fP
>  .SH "AUTHORS"
>  .LP
>  The routel script was written by Stephen R. van den Berg <srb@cuci.nl>, 1999/04/18 and donated to the public domain.

Sure hardcode paths are not good.
Alternative would be generate man page like ipaddress is.

[PATCH iproute2 v2 1/4] man: drop references to Debian-specific paths

[Luca Boccassi]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=UTF-8, Size: 1699 bytes --]

Documentation should be distribution-agnostic - any specific quirks
should be handled by downstream maintainers, if necessary.
Remove mentions of Debian paths and package names.

Signed-off-by: Luca Boccassi <bluca@debian.org>
---
 man/man8/lnstat.8 | 3 +--
 man/man8/ss.8     | 3 +--
 2 files changed, 2 insertions(+), 4 deletions(-)

diff --git a/man/man8/lnstat.8 b/man/man8/lnstat.8
index acd5f4a2..b98241bf 100644
--- a/man/man8/lnstat.8
+++ b/man/man8/lnstat.8
@@ -254,8 +254,7 @@ Number of hash table list traversals for output traffic. Deprecated since IP
 route cache removal, therefore always zero.
 
 .SH SEE ALSO
-.BR ip (8),
-and /usr/share/doc/iproute-doc/README.lnstat (package iproute-doc on Debian)
+.BR ip (8)
 .br
 .SH AUTHOR
 lnstat was written by Harald Welte <laforge@gnumonks.org>.
diff --git a/man/man8/ss.8 b/man/man8/ss.8
index 0d526734..973afbe0 100644
--- a/man/man8/ss.8
+++ b/man/man8/ss.8
@@ -327,7 +327,7 @@ Read filter information from FILE.
 Each line of FILE is interpreted like single command line option. If FILE is - stdin is used.
 .TP
 .B FILTER := [ state STATE-FILTER ] [ EXPRESSION ]
-Please take a look at the official documentation (Debian package iproute-doc) for details regarding filters.
+Please take a look at the official documentation for details regarding filters.
 
 .SH STATE-FILTER
 
@@ -382,7 +382,6 @@ Find all local processes connected to X server.
 List all the tcp sockets in state FIN-WAIT-1 for our apache to network 193.233.7/24 and look at their timers.
 .SH SEE ALSO
 .BR ip (8),
-.BR /usr/share/doc/iproute-doc/ss.html " (package iproute­doc)",
 .br
 .BR RFC " 793 "
 - https://tools.ietf.org/rfc/rfc793.txt (TCP states)
-- 
2.14.2

[PATCH iproute2 v2 2/4] man: add more keywords to ip.8 short description

[Luca Boccassi]

A Debian user suggested adding more network-related keywords to the
ip manpage, so that manpage-scraping and indexing software like
apropos can do a better job of categorizing the programs.

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=877983

Suggested-by: Lynoure Braakman <lynoure@gmail.com>
Signed-off-by: Luca Boccassi <bluca@debian.org>
---
 man/man8/ip.8 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man8/ip.8 b/man/man8/ip.8
index ae018fdf..7f26582d 100644
--- a/man/man8/ip.8
+++ b/man/man8/ip.8
@@ -1,6 +1,6 @@
 .TH IP 8 "20 Dec 2011" "iproute2" "Linux"
 .SH NAME
-ip \- show / manipulate routing, devices, policy routing and tunnels
+ip \- show / manipulate routing, network devices, interfaces and tunnels
 .SH SYNOPSIS
 
 .ad l
-- 
2.14.2

[PATCH iproute2 v2 3/4] man: ip-address: document 15-char limit for LABEL

[Luca Boccassi]

Trying to set a label longer than 15 characters returns an error:
 RTNETLINK answers: Numerical result out of range

Document the limit in the manpage.

Originally reported as a Debian bug:

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=661886

Reported-by: Gabor Kiss <kissg@ssg.ki.iif.hu>
Signed-off-by: Luca Boccassi <bluca@debian.org>
---
 man/man8/ip-address.8.in | 1 +
 1 file changed, 1 insertion(+)

diff --git a/man/man8/ip-address.8.in b/man/man8/ip-address.8.in
index eaa179c6..7ebf0bc9 100644
--- a/man/man8/ip-address.8.in
+++ b/man/man8/ip-address.8.in
@@ -190,6 +190,7 @@ Each address may be tagged with a label string.
 In order to preserve compatibility with Linux-2.0 net aliases,
 this string must coincide with the name of the device or must be prefixed
 with the device name followed by colon.
+The maximum allowed total length of label is 15 characters.
 
 .TP
 .BI scope " SCOPE_VALUE"
-- 
2.14.2

[PATCH iproute2 v2 4/4] man: routel/routef: don't mention filesystem paths

[Luca Boccassi]

The filesytem paths to these scripts might be different on various
distros, so don't mention it in the manpages. It is not really useful
information anyway.

Originally submitted as Debian bug:

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=561424

Reported-by: jidanni@jidanni.org
Signed-off-by: Luca Boccassi <bluca@debian.org>
---
 man/man8/routel.8 | 5 -----
 1 file changed, 5 deletions(-)

diff --git a/man/man8/routel.8 b/man/man8/routel.8
index 82d580fb..2270eacb 100644
--- a/man/man8/routel.8
+++ b/man/man8/routel.8
@@ -17,11 +17,6 @@ The routel script will list routes in a format that some might consider easier t
 .br
 The routef script does not take any arguments and will simply flush the routing table down the drain. Beware! This means deleting all routes which will make your network unusable!
 
-.SH "FILES"
-.LP
-\fI/usr/bin/routef\fP
-.br
-\fI/usr/bin/routel\fP
 .SH "AUTHORS"
 .LP
 The routel script was written by Stephen R. van den Berg <srb@cuci.nl>, 1999/04/18 and donated to the public domain.
-- 
2.14.2

Re: [PATCH iproute2 v2 1/4] man: drop references to Debian-specific paths

[Stephen Hemminger]

On Sat, 30 Dec 2017 11:31:14 +0100
Luca Boccassi <bluca@debian.org> wrote:

> Documentation should be distribution-agnostic - any specific quirks
> should be handled by downstream maintainers, if necessary.
> Remove mentions of Debian paths and package names.
> 
> Signed-off-by: Luca Boccassi <bluca@debian.org>

Applied all of these