[iproute PATCH 0/2] ip-neighbour: Add missing nud state descriptions

[iproute PATCH 0/2] ip-neighbour: Add missing nud state descriptions

[Phil Sutter]

The following aims at documenting all nud states 'ip neigh' supports, not just
the most common ones. This includes describing them in the relevant man page as
well as extending 'ip neigh help' output.

Phil Sutter (2):
  man: ip-neighbour.8: Document all known nud states
  ipneigh: List all nud states in help output

 ip/ipneigh.c            |  9 +++++----
 man/man8/ip-neighbour.8 | 22 +++++++++++++++++++++-
 2 files changed, 26 insertions(+), 5 deletions(-)

-- 
2.7.2

[iproute PATCH 1/2] man: ip-neighbour.8: Document all known nud states

[Phil Sutter]

Not sure how useful they are in practice, but as 'ip neigh' supports
setting them all, they deserve to be described as well.

While at it, also add a missing layer of indentation to the subordinate
nud state list.

Signed-off-by: Phil Sutter <phil@nwl.cc>
---
 man/man8/ip-neighbour.8 | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/man/man8/ip-neighbour.8 b/man/man8/ip-neighbour.8
index 19c6d9d8bf605..b292e18144950 100644
--- a/man/man8/ip-neighbour.8
+++ b/man/man8/ip-neighbour.8
@@ -35,7 +35,8 @@ ip-neighbour \- neighbour/arp tables management.
 
 .ti -8
 .IR STATE " := {"
-.BR permanent " | " noarp " | " stale " | " reachable " }"
+.BR permanent " | " noarp " | " stale " | " reachable " | " none " |"
+.BR incomplete " | " delay " | " probe " | " failed " }"
 
 .SH DESCRIPTION
 The
@@ -86,6 +87,7 @@ the state of the neighbour entry.
 is an abbreviation for 'Neighbour Unreachability Detection'.
 The state can take one of the following values:
 
+.RS
 .TP
 .B permanent
 the neighbour entry is valid forever and can be only
@@ -105,6 +107,24 @@ This option to
 .B ip neigh
 does not change the neighbour state if it was valid and the address
 is not changed by this command.
+.TP
+.B none
+this is a pseudo state used when initially creating a neighbour entry or after
+trying to remove it before it becomes free to do so.
+.TP
+.B incomplete
+the neighbour entry has not (yet) been validated/resolved.
+.TP
+.B delay
+neighbor entry validation is currently delayed.
+.TP
+.B probe
+neighbor is being probed.
+.TP
+.B failed
+max number of probes exceeded without success, neighbor validation has
+ultimately failed.
+.RE
 .RE
 
 .TP
-- 
2.7.2

[iproute PATCH 2/2] ipneigh: List all nud states in help output

[Phil Sutter]

To not make the output overly confusing, list them in a definition of
the STATE placeholder which is already used in the show/flush syntax but
wasn't explained before.

Signed-off-by: Phil Sutter <phil@nwl.cc>
---
 ip/ipneigh.c | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/ip/ipneigh.c b/ip/ipneigh.c
index 9b1499b08b060..48cca196fa7a8 100644
--- a/ip/ipneigh.c
+++ b/ip/ipneigh.c
@@ -46,10 +46,11 @@ static void usage(void) __attribute__((noreturn));
 
 static void usage(void)
 {
-	fprintf(stderr, "Usage: ip neigh { add | del | change | replace } { ADDR [ lladdr LLADDR ]\n"
-		        "          [ nud { permanent | noarp | stale | reachable } ]\n"
-		        "          | proxy ADDR } [ dev DEV ]\n");
-	fprintf(stderr, "       ip neigh { show | flush } [ proxy ] [ to PREFIX ] [ dev DEV ] [ nud STATE ]\n");
+	fprintf(stderr, "Usage: ip neigh { add | del | change | replace }\n"
+			"                { ADDR [ lladdr LLADDR ] [ nud STATE ] | proxy ADDR } [ dev DEV ]\n");
+	fprintf(stderr, "       ip neigh { show | flush } [ proxy ] [ to PREFIX ] [ dev DEV ] [ nud STATE ]\n\n");
+	fprintf(stderr, "STATE := { permanent | noarp | stale | reachable | none |\n"
+	                "           incomplete | delay | probe | failed }\n");
 	exit(-1);
 }
 
-- 
2.7.2