[iproute PATCH 0/5] Misc minor documentation fixes

[iproute PATCH 0/5] Misc minor documentation fixes

[Phil Sutter]

The following five patches contain minor changes to documentation at
various places. They are all unrelated, but being lazy as I am, I
submit them in one go.

Phil Sutter (5):
  tc: pedit: document branch control in help output
  man: ip-link: Beef up VXLAN csum options a bit
  man: tc-u32: Minor syntax fix
  man: ip-route: Make synopsis consistent with description
  doc, man: ip-rule: Remove incorrect statement about rule 0

 doc/ip-cref.tex        | 3 ---
 man/man8/ip-link.8.in  | 6 +++---
 man/man8/ip-route.8.in | 2 +-
 man/man8/ip-rule.8     | 2 --
 man/man8/tc-u32.8      | 1 +
 tc/m_pedit.c           | 3 ++-
 6 files changed, 7 insertions(+), 10 deletions(-)

-- 
2.7.2

[iproute PATCH 1/5] tc: pedit: document branch control in help output

[Phil Sutter]

This seems to have been a hidden feature, though it's very useful and
necessary at least when combining multiple pedit actions.

Signed-off-by: Phil Sutter <phil@nwl.cc>
---
 tc/m_pedit.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/tc/m_pedit.c b/tc/m_pedit.c
index 4fdd189d7d9c6..86eb0ca3fbb38 100644
--- a/tc/m_pedit.c
+++ b/tc/m_pedit.c
@@ -35,7 +35,7 @@ static int pedit_debug;
 static void
 explain(void)
 {
-	fprintf(stderr, "Usage: ... pedit munge <MUNGE>\n");
+	fprintf(stderr, "Usage: ... pedit munge <MUNGE> [<BRANCH>]\n");
 	fprintf(stderr,
 		"Where: MUNGE := <RAW>|<LAYERED>\n"
 		"\t<RAW>:= <OFFSETC>[ATC]<CMD>\n "
@@ -47,6 +47,7 @@ explain(void)
 		"\t\tCMD:= clear | invert | set <setval>| retain\n "
 		"\t<LAYERED>:= ip <ipdata> | ip6 <ip6data> \n "
 		" \t\t| udp <udpdata> | tcp <tcpdata> | icmp <icmpdata> \n"
+		"\t<BRANCH>:= reclassify | pipe | drop | continue | pass\n"
 		"For Example usage look at the examples directory\n");
 
 }
-- 
2.7.2

[iproute PATCH 2/5] man: ip-link: Beef up VXLAN csum options a bit

[Phil Sutter]

Signed-off-by: Phil Sutter <phil@nwl.cc>
---
 man/man8/ip-link.8.in | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in
index c6a9c862dfda2..2cd93b0ff718e 100644
--- a/man/man8/ip-link.8.in
+++ b/man/man8/ip-link.8.in
@@ -491,15 +491,15 @@ are entered into the VXLAN device forwarding database.
 
 .sp
 .I [no]udpcsum
-- specifies if UDP checksum is filled in
+- specifies if UDP checksum is calculated for transmitted packets over IPv4.
 
 .sp
 .I [no]udp6zerocsumtx
-- specifies if UDP checksum is filled in
+- skip UDP checksum calculation for transmitted packets over IPv6.
 
 .sp
 .I [no]udp6zerocsumrx
-- specifies if UDP checksum is received
+- allow incoming UDP packets over IPv6 with zero checksum field.
 
 .sp
 .BI ageing " SECONDS"
-- 
2.7.2

[iproute PATCH 3/5] man: tc-u32: Minor syntax fix

[Phil Sutter]

Signed-off-by: Phil Sutter <phil@nwl.cc>
---
 man/man8/tc-u32.8 | 1 +
 1 file changed, 1 insertion(+)

diff --git a/man/man8/tc-u32.8 b/man/man8/tc-u32.8
index 47c8f2d092ee8..691f53c135cfe 100644
--- a/man/man8/tc-u32.8
+++ b/man/man8/tc-u32.8
@@ -370,6 +370,7 @@ then allows to match various header fields:
 .RS
 .TP
 .BI src " ADDR"
+.TQ
 .BI dst " ADDR"
 Compare Source or Destination Address fields against the value of
 .IR ADDR .
-- 
2.7.2

[iproute PATCH 4/5] man: ip-route: Make synopsis consistent with description

[Phil Sutter]

While the synopsis section contains 'ip route list', it is later
described as 'ip route show'. Make this consistent by replacing 'list'
with 'show' in synopsis.

Signed-off-by: Phil Sutter <phil@nwl.cc>
---
 man/man8/ip-route.8.in | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man8/ip-route.8.in b/man/man8/ip-route.8.in
index c764bfc8ead86..d7fb8fba8bb05 100644
--- a/man/man8/ip-route.8.in
+++ b/man/man8/ip-route.8.in
@@ -16,7 +16,7 @@ ip-route \- routing table management
 
 .ti -8
 .BR "ip route" " { "
-.BR list " | " flush " } "
+.BR show " | " flush " } "
 .I  SELECTOR
 
 .ti -8
-- 
2.7.2

[iproute PATCH 5/5] doc, man: ip-rule: Remove incorrect statement about rule 0

[Phil Sutter]

The documentation is wrong here: it is indeed possible to remove policy
rule 0 and recreate it afterwards. Therefore remove these statements.

Signed-off-by: Phil Sutter <phil@nwl.cc>
---
 doc/ip-cref.tex    | 3 ---
 man/man8/ip-rule.8 | 2 --
 2 files changed, 5 deletions(-)

diff --git a/doc/ip-cref.tex b/doc/ip-cref.tex
index 67094c95b3681..242cc266b7acd 100644
--- a/doc/ip-cref.tex
+++ b/doc/ip-cref.tex
@@ -2049,9 +2049,6 @@ table \verb|local| (ID 255).
 The \verb|local| table is a special routing table containing
 high priority control routes for local and broadcast addresses.
 
-Rule 0 is special. It cannot be deleted or overridden.
-
-
 \item Priority: 32766, Selector: match anything, Action: lookup routing
 table \verb|main| (ID 254).
 The \verb|main| table is the normal routing table containing all non-policy
diff --git a/man/man8/ip-rule.8 b/man/man8/ip-rule.8
index e9fbb3cf1a62d..1774ae3ee1fbb 100644
--- a/man/man8/ip-rule.8
+++ b/man/man8/ip-rule.8
@@ -118,8 +118,6 @@ The
 .B local
 table is a special routing table containing
 high priority control routes for local and broadcast addresses.
-.sp
-Rule 0 is special. It cannot be deleted or overridden.
 
 .TP
 2.
-- 
2.7.2

Re: [iproute PATCH 0/5] Misc minor documentation fixes

[Stephen Hemminger]

On Fri,  4 Mar 2016 12:52:36 +0100
Phil Sutter <phil@nwl.cc> wrote:

> The following five patches contain minor changes to documentation at
> various places. They are all unrelated, but being lazy as I am, I
> submit them in one go.
> 
> Phil Sutter (5):
>   tc: pedit: document branch control in help output
>   man: ip-link: Beef up VXLAN csum options a bit
>   man: tc-u32: Minor syntax fix
>   man: ip-route: Make synopsis consistent with description
>   doc, man: ip-rule: Remove incorrect statement about rule 0
> 
>  doc/ip-cref.tex        | 3 ---
>  man/man8/ip-link.8.in  | 6 +++---
>  man/man8/ip-route.8.in | 2 +-
>  man/man8/ip-rule.8     | 2 --
>  man/man8/tc-u32.8      | 1 +
>  tc/m_pedit.c           | 3 ++-
>  6 files changed, 7 insertions(+), 10 deletions(-)
> 

Applied