Bug 254617
| Summary: | ipfw man page synopsis misses nat show form | ||||||
|---|---|---|---|---|---|---|---|
| Product: | Documentation | Reporter: | Oliver Kiddle <okiddle> | ||||
| Component: | Manual Pages | Assignee: | Lutz Donnerhacke <donner> | ||||
| Status: | Closed FIXED | ||||||
| Severity: | Affects Many People | CC: | doc, donner, ipfw | ||||
| Priority: | --- | Keywords: | patch | ||||
| Version: | Latest | ||||||
| Hardware: | Any | ||||||
| OS: | Any | ||||||
| Attachments: |
|
||||||
Thank you for your kind contribution. Next steps: https://reviews.freebsd.org/D30172 A commit in branch main references this bug: URL: https://cgit.FreeBSD.org/src/commit/?id=c8250c5ada85fec8936e8eb8695d7cb80a3ce8ab commit c8250c5ada85fec8936e8eb8695d7cb80a3ce8ab Author: Lutz Donnerhacke <donner@FreeBSD.org> AuthorDate: 2021-05-10 16:30:42 +0000 Commit: Lutz Donnerhacke <donner@FreeBSD.org> CommitDate: 2021-06-04 10:55:59 +0000 ipfw.8: synopsis misses nat show form Document the existing behavior, which is currently only available by reading third party documentation or the source code itself. PR: 254617 Submitted by: Oliver Kiddle MFC after: 2 weeks Differential Revision: https://reviews.freebsd.org/D30189 sbin/ipfw/ipfw.8 | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) A commit in branch stable/13 references this bug: URL: https://cgit.FreeBSD.org/src/commit/?id=ef84d16e68b2a3f86eeb1b758dc560ec2a4ffcbe commit ef84d16e68b2a3f86eeb1b758dc560ec2a4ffcbe Author: Lutz Donnerhacke <donner@FreeBSD.org> AuthorDate: 2021-05-10 16:30:42 +0000 Commit: Lutz Donnerhacke <donner@FreeBSD.org> CommitDate: 2021-06-18 09:53:26 +0000 ipfw.8: synopsis misses nat show form Document the existing behavior, which is currently only available by reading third party documentation or the source code itself. PR: 254617 Submitted by: Oliver Kiddle Differential Revision: https://reviews.freebsd.org/D30189 (cherry picked from commit c8250c5ada85fec8936e8eb8695d7cb80a3ce8ab) sbin/ipfw/ipfw.8 | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) A commit in branch stable/12 references this bug: URL: https://cgit.FreeBSD.org/src/commit/?id=116fc1b5a07f55c43ac39f04bf9dff5a503d99ba commit 116fc1b5a07f55c43ac39f04bf9dff5a503d99ba Author: Lutz Donnerhacke <donner@FreeBSD.org> AuthorDate: 2021-05-10 16:30:42 +0000 Commit: Lutz Donnerhacke <donner@FreeBSD.org> CommitDate: 2021-06-18 10:00:29 +0000 ipfw.8: synopsis misses nat show form Document the existing behavior, which is currently only available by reading third party documentation or the source code itself. PR: 254617 Submitted by: Oliver Kiddle Differential Revision: https://reviews.freebsd.org/D30189 (cherry picked from commit c8250c5ada85fec8936e8eb8695d7cb80a3ce8ab) sbin/ipfw/ipfw.8 | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) A commit in branch stable/11 references this bug: URL: https://cgit.FreeBSD.org/src/commit/?id=95f8bb6d06d9fb65dc382423485f2f636ec20375 commit 95f8bb6d06d9fb65dc382423485f2f636ec20375 Author: Lutz Donnerhacke <donner@FreeBSD.org> AuthorDate: 2021-05-10 16:30:42 +0000 Commit: Lutz Donnerhacke <donner@FreeBSD.org> CommitDate: 2021-06-18 10:06:42 +0000 ipfw.8: synopsis misses nat show form Document the existing behavior, which is currently only available by reading third party documentation or the source code itself. PR: 254617 Submitted by: Oliver Kiddle Differential Revision: https://reviews.freebsd.org/D30189 (cherry picked from commit c8250c5ada85fec8936e8eb8695d7cb80a3ce8ab) sbin/ipfw/ipfw.8 | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) |
Created attachment 223653 [details] corrections to ipfw.8 man page Found initially by guessing but confirmed with the source code, it is possible to do, e.g. "ipfw nat 1 show config" to examine the nat configuration. This is missing from the man page. I've attached a patch that adds "ipfw nat number show {config | log}" to the IN-KERNEL NAT subsection of SYNOPSIS. Furthermore, under RULE ACTIONS, the nat entry could list the "global" special value which is documented in the later NAT section that this references. Where it is documented, it could be clearer that these are used in rule actions and not amongst the config options that are documented immediately before. "specials value" doesn't really make sense because "specials" is a plural noun and only "special" is an adjective – "special values" is better. A little further on, "examples about" should be "examples of". The attached patch also deals with these.