diff mbox series

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

Message ID 20171229220125.13579-3-bluca@debian.org
State Changes Requested, archived
Delegated to: stephen hemminger
Headers show
Series None | expand

Commit Message

Luca Boccassi Dec. 29, 2017, 10:01 p.m. UTC
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(+)

Comments

Stephen Hemminger Dec. 30, 2017, 4:04 a.m. UTC | #1
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.
Luca Boccassi Dec. 30, 2017, 10:32 a.m. UTC | #2
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
diff mbox series

Patch

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"