]> git.proxmox.com Git - mirror_iproute2.git/commit - ip/ipxfrm.c
xfrm: Update documentation
authorDavid Ward <david.ward@ll.mit.edu>
Sat, 11 Jun 2011 16:13:30 +0000 (16:13 +0000)
committerStephen Hemminger <shemminger@vyatta.com>
Mon, 11 Jul 2011 17:12:06 +0000 (10:12 -0700)
commitcbec0219132afd1749e1b8852b8b3729988af841
tree448383ce5f939e5969d50b8a0d3788d897731ad1
parent4f69c63a4b85745898c54f5aee624774f28ca0a2
xfrm: Update documentation

The ip(8) man page and the "ip xfrm [ XFRM-OBJECT ] help" command output
are updated to include missing options, fix errors, and improve grammar.
There are no functional changes made.

The documentation for the ip command has many different meanings for the
same formatting symbols (which really needs to be fixed). This patch makes
consistent use of brackets [ ] to indicate optional parameters, pipes | to
mean "OR", braces { } to group things together, and dashes - instead of
underscores _ inside of parameter names. The parameters are listed in the
order in which they are parsed in the source code.

There are several parameters and options that are still not mentioned or
need to be described more thoroughly in the "COMMAND SYNTAX" section of
the ip(8) man page. I would appreciate help from the developers with this.

Signed-off-by: David Ward <david.ward@ll.mit.edu>
ip/ipxfrm.c
ip/xfrm_monitor.c
ip/xfrm_policy.c
ip/xfrm_state.c
man/man8/ip.8