Bug 276554

Summary: [patch] nvmecontrol(8) has wrong pi-switch in format synopsis
Product: Documentation Reporter: Stefan Schlosser <bsdcode>
Component: Manual PagesAssignee: Gordon Bergling <gbe>
Status: Closed FIXED    
Severity: Affects Some People CC: doc, gbe, ralphrobbins92
Priority: ---    
Version: Latest   
Hardware: Any   
OS: Any   
See Also: https://reviews.freebsd.org/D44099
Attachments:
Description Flags
fix pi-switch in synopsis
none
patch none

Description Stefan Schlosser 2024-01-23 12:58:27 UTC
Created attachment 247887 [details]
fix pi-switch in synopsis

Manpage nvmecontrol(8) lists:

nvmecontrol format [-f fmt] [-m mset] [-o pi] [-l pil] [-E] [-C] <device-id | namespace-id>

The correct switch for the pi option is -p according to sbin/nvmecontrol/format.c:

OPT("pi", 'p', arg_uint32, opt, pi, "Protective information")

Patch fixes the format synopsis.
Comment 1 Stefan Schlosser 2024-02-21 15:35:07 UTC
Created attachment 248660 [details]
patch

use real name in patch
Comment 2 commit-hook freebsd_committer freebsd_triage 2024-02-28 08:27:51 UTC
A commit in branch main references this bug:

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

commit 77f6c0ce92888d047d91e87b931242403764902b
Author:     Stefan Schlosser <bsdcode@disroot.org>
AuthorDate: 2024-02-28 08:26:20 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2024-02-28 08:26:20 +0000

    nvmecontrol.8: Fix the SYNOPSIS section

    The manpage of nvmecontrol(8) has the following SYNOPSIS:

    nvmecontrol format [-f fmt] [-m mset] [-o pi] [-l pil] [-E]
    [-C] <device-id | namespace-id>

    The correct switch for the pi option is -p according
    to sbin/nvmecontrol/format.c:

    OPT("pi", 'p', arg_uint32, opt, pi, "Protective information")

    So correct the SYNOPSIS section accordingly.

    PR:     276554
    Reviewed by:    imp
    MFC after:      3 days
    Differential Revision:  https://reviews.freebsd.org/D44099

 sbin/nvmecontrol/nvmecontrol.8 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Comment 3 commit-hook freebsd_committer freebsd_triage 2024-03-03 17:49:43 UTC
A commit in branch stable/14 references this bug:

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

commit ee0ffe0e3e366d3fc919bc4320e5514a44852a76
Author:     Stefan Schlosser <bsdcode@disroot.org>
AuthorDate: 2024-02-28 08:26:20 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2024-03-03 17:48:51 +0000

    nvmecontrol.8: Fix the SYNOPSIS section

    The manpage of nvmecontrol(8) has the following SYNOPSIS:

    nvmecontrol format [-f fmt] [-m mset] [-o pi] [-l pil] [-E]
    [-C] <device-id | namespace-id>

    The correct switch for the pi option is -p according
    to sbin/nvmecontrol/format.c:

    OPT("pi", 'p', arg_uint32, opt, pi, "Protective information")

    So correct the SYNOPSIS section accordingly.

    PR:     276554
    Reviewed by:    imp
    Differential Revision:  https://reviews.freebsd.org/D44099

    (cherry picked from commit 77f6c0ce92888d047d91e87b931242403764902b)

 sbin/nvmecontrol/nvmecontrol.8 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Comment 4 Gordon Bergling freebsd_committer freebsd_triage 2024-03-11 21:30:05 UTC
Committed to main and stable/14.

Thanks for the patch.
Comment 5 Roryan 2024-11-29 04:56:10 UTC
(In reply to commit-hook from comment #3)
A commit in branch stable/14 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=ee0ffe0e3e366d3fc919bc4320e5514a44852a76 https://motox3m-game.com/

commit ee0ffe0e3e366d3fc919bc4320e5514a44852a76
Author:     Stefan Schlosser <bsdcode@disroot.org>
AuthorDate: 2024-02-28 08:26:20 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2024-03-03 17:48:51 +0000

Oh I see