Bug 231579

Summary: [ROUTE(8)] improvements
Product: Documentation Reporter: Pekka Järvinen <pekka.jarvinen>
Component: Manual PagesAssignee: Gordon Bergling <gbe>
Status: Closed FIXED    
Severity: Affects Only Me CC: doc, felix.the.red, gbe
Priority: ---    
Version: Latest   
Hardware: Any   
OS: Any   
See Also: https://reviews.freebsd.org/D29702

Description Pekka Järvinen 2018-09-22 10:42:40 UTC
Hello!

Common question: how do I list routes? 

Not mentioned in man page. 

Answer: netstat -r

netstat not referenced in man page.
Comment 1 Gordon Bergling freebsd_committer freebsd_triage 2021-04-11 11:33:01 UTC
I created a differential for the issue.
Comment 2 commit-hook freebsd_committer freebsd_triage 2021-04-13 04:48:19 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=bc54f5f1cd5c01aa5f941234034839fb0b8f54ed

commit bc54f5f1cd5c01aa5f941234034839fb0b8f54ed
Author:     Gordon Bergling <gbe@FreeBSD.org>
AuthorDate: 2021-04-13 04:44:04 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2021-04-13 04:45:22 +0000

    route(8): Add an example how to print the routing tables

    The manual page currently doesn't show an example how to print
    the routing table, so add one and .Xr netstat while here.

    PR:             231579
    Reported by:    Pekka Järvinen <pekka dot jarvinen at gmail dot com>
    Reviewed by:    debdrup
    MFC after:      5 days
    Differential Revision:  https://reviews.freebsd.org/D29702

 sbin/route/route.8 | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
Comment 3 Felix Johnson freebsd_triage 2021-10-01 20:47:09 UTC
Was the commit in comment #2 MFC'd?

Can this PR be closed?
Comment 4 commit-hook freebsd_committer freebsd_triage 2023-03-13 08:03:20 UTC
A commit in branch stable/13 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=43a51b8bfdf004236a7c7f980c5e29c07b208de4

commit 43a51b8bfdf004236a7c7f980c5e29c07b208de4
Author:     Gordon Bergling <gbe@FreeBSD.org>
AuthorDate: 2021-04-13 04:44:04 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2023-03-13 08:01:24 +0000

    route(8): Add an example how to print the routing tables

    The manual page currently doesn't show an example how to print
    the routing table, so add one and .Xr netstat while here.

    PR:             231579
    Reported by:    Pekka Järvinen <pekka dot jarvinen at gmail dot com>
    Reviewed by:    debdrup
    Differential Revision:  https://reviews.freebsd.org/D29702

    (cherry picked from commit bc54f5f1cd5c01aa5f941234034839fb0b8f54ed)

 sbin/route/route.8 | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
Comment 5 commit-hook freebsd_committer freebsd_triage 2023-03-14 10:54:32 UTC
A commit in branch releng/13.2 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=5b99fbfb72891a058838bf1485f88d8c5bb3e1e0

commit 5b99fbfb72891a058838bf1485f88d8c5bb3e1e0
Author:     Gordon Bergling <gbe@FreeBSD.org>
AuthorDate: 2021-04-13 04:44:04 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2023-03-14 10:49:16 +0000

    route(8): Add an example how to print the routing tables

    The manual page currently doesn't show an example how to print
    the routing table, so add one and .Xr netstat while here.

    PR:             231579
    Reported by:    Pekka Järvinen <pekka dot jarvinen at gmail dot com>
    Reviewed by:    debdrup
    Approved by:    re (cperciva)
    Differential Revision:  https://reviews.freebsd.org/D29702

    (cherry picked from commit bc54f5f1cd5c01aa5f941234034839fb0b8f54ed)

 sbin/route/route.8 | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
Comment 6 commit-hook freebsd_committer freebsd_triage 2023-03-14 13:57:10 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=21f268182838f072f96234c727778d5603a580e3

commit 21f268182838f072f96234c727778d5603a580e3
Author:     Gordon Bergling <gbe@FreeBSD.org>
AuthorDate: 2023-03-14 13:55:28 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2023-03-14 13:55:28 +0000

    route.8: Don't reference an external command in EXAMPLES

    It is better to mention the externel command for showing
    the routing table as using an explicit command.

    PR:     231579
    Suggested by:   karels
    Reviewed by:    karles, gbe
    MFC after:      3 days
    Differential Revision:  https://reviews.freebsd.org/D39075

 sbin/route/route.8 | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
Comment 7 commit-hook freebsd_committer freebsd_triage 2023-03-16 13:14:29 UTC
A commit in branch releng/13.2 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=61dad7633cd3eeacd734cdb0338331b751bd6ab0

commit 61dad7633cd3eeacd734cdb0338331b751bd6ab0
Author:     Gordon Bergling <gbe@FreeBSD.org>
AuthorDate: 2023-03-14 13:55:28 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2023-03-16 13:13:03 +0000

    route.8: Don't reference an external command in EXAMPLES

    It is better to mention the externel command for showing
    the routing table as using an explicit command.

    PR:     231579
    Suggested by:   karels
    Reviewed by:    karles, gbe
    Approved by:    re (cperciva)
    Differential Revision:  https://reviews.freebsd.org/D39075

    (cherry picked from commit 21f268182838f072f96234c727778d5603a580e3)

 sbin/route/route.8 | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
Comment 8 commit-hook freebsd_committer freebsd_triage 2023-03-17 06:31:13 UTC
A commit in branch stable/13 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=15d683c334f9434f7d3253ca4189f8e70f4fbf9a

commit 15d683c334f9434f7d3253ca4189f8e70f4fbf9a
Author:     Gordon Bergling <gbe@FreeBSD.org>
AuthorDate: 2023-03-14 13:55:28 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2023-03-17 06:30:26 +0000

    route.8: Don't reference an external command in EXAMPLES

    It is better to mention the externel command for showing
    the routing table as using an explicit command.

    PR:     231579
    Suggested by:   karels
    Reviewed by:    karles, gbe
    Differential Revision:  https://reviews.freebsd.org/D39075

    (cherry picked from commit 21f268182838f072f96234c727778d5603a580e3)

 sbin/route/route.8 | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
Comment 9 Gordon Bergling freebsd_committer freebsd_triage 2023-03-17 06:32:24 UTC
Thanks for the report, a fix is committed to all relevant branches.