Bug 256795 - sockstat man page Synopsis doesn't match Description
Summary: sockstat man page Synopsis doesn't match Description
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Guangyuan Yang
URL:
Keywords: easy, patch
Depends on:
Blocks:
 
Reported: 2021-06-23 19:58 UTC by Nick Reilly
Modified: 2021-11-13 06:16 UTC (History)
4 users (show)

See Also:

Attachments
sockstat.1 patch (494 bytes, patch)
2021-09-30 03:45 UTC, Felix Johnson 		felix.the.red: maintainer-approval? (felix.the.red)
 Details | Diff
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Nick Reilly 2021-06-23 19:58:03 UTC 
Synopsis has [-j jid] but Description has "-j jail".

Synopsis is missing -q.
Comment 1 Felix Johnson 2021-09-30 03:45:45 UTC 
Created attachment 228268 [details]
sockstat.1 patch

Update sockstat(1) so the synopsis includes q (silent mode).
Update the -j argument name in the synopsis to match the description.
Comment 2 commit-hook freebsd_committer freebsd_triage 2021-11-10 20:27:29 UTC 
A commit in branch main references this bug:

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

commit 5504d8394289853e8c065e88a83fb464cb50d934
Author:     Felix Johnson <felix.the.red@gmail.com>
AuthorDate: 2021-11-10 20:22:06 +0000
Commit:     Guangyuan Yang <ygy@FreeBSD.org>
CommitDate: 2021-11-10 20:22:06 +0000

    sockstat(1): Update Synopsis section

    Update sockstat(1) manpage so the Synopsis section includes q (silent
    mode) and the -j argument name is consistent.

    PR:             256795
    MFC after:      3 days
    Reported by:    Nick Reilly <nreilly@blackberry.com>

 usr.bin/sockstat/sockstat.1 | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Comment 3 commit-hook freebsd_committer freebsd_triage 2021-11-13 06:15:16 UTC 
A commit in branch stable/13 references this bug:

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

commit de5334c8c988a1f5859f5b3b2dfe0e002d3a90a1
Author:     Felix Johnson <felix.the.red@gmail.com>
AuthorDate: 2021-11-10 20:22:06 +0000
Commit:     Guangyuan Yang <ygy@FreeBSD.org>
CommitDate: 2021-11-13 06:14:51 +0000

    sockstat(1): Update Synopsis section

    Update sockstat(1) manpage so the Synopsis section includes q (silent
    mode) and the -j argument name is consistent.

    PR:             256795
    Reported by:    Nick Reilly <nreilly@blackberry.com>

    (cherry picked from commit 5504d8394289853e8c065e88a83fb464cb50d934)

 usr.bin/sockstat/sockstat.1 | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)