Bug 291759 - fix typo in camcontrol/camcontrol.8
Summary: fix typo in camcontrol/camcontrol.8
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Alexander Ziaee
URL: https://reviews.freebsd.org/D54285
Keywords:
Depends on:
Blocks:
 
Reported: 2025-12-18 04:47 UTC by devnull
Modified: 2026-01-01 19:09 UTC (History)
4 users (show)

See Also:


Attachments
patch file (813 bytes, patch)
2025-12-18 04:47 UTC, devnull
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description devnull freebsd_committer freebsd_triage 2025-12-18 04:47:29 UTC
Created attachment 266317 [details]
patch file

Fix a small typo in camcontrol/camcontrol.8
Comment 1 Maxim Konovalov freebsd_committer freebsd_triage 2025-12-18 05:13:29 UTC
Hi Chris,

Thank for the patch.  However, it still sounds strange (I am a non-native speaker, bear with me).

Should it be simple like that instead:

"This command can be used on an SSD drive to restore it to factory default write performance"

Thank,

Maxim
Comment 2 Alexander Ziaee freebsd_committer freebsd_triage 2025-12-18 12:39:14 UTC
Thank you for reporting this.

It should actually be even simpler, EXAMPLES takes the imperative tone. It needs to say "Restore a solid state drive (SSD) to factory performance:".

I will commit this fix today.
Comment 3 devnull freebsd_committer freebsd_triage 2025-12-18 22:18:02 UTC
No longer my original work
Comment 4 commit-hook freebsd_committer freebsd_triage 2025-12-23 13:41:08 UTC
A commit in branch main references this bug:

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

commit fbc321b9cdceecd3c97742868da5d500423cf484
Author:     Alexander Ziaee <ziaee@FreeBSD.org>
AuthorDate: 2025-12-23 13:36:49 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2025-12-23 13:40:29 +0000

    camcontrol.8: Descriptions before examples

    This page has a lot of examples, so having them in the previous order
    can be confusing. Rewrite to the normal order where the descriptions
    come before the command, followed by a colon, which is still clear even
    jumping to the middle of the section.

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

 sbin/camcontrol/camcontrol.8 | 349 ++++++++++++++++++-------------------------
 1 file changed, 148 insertions(+), 201 deletions(-)
Comment 5 commit-hook freebsd_committer freebsd_triage 2026-01-01 18:06:35 UTC
A commit in branch stable/15 references this bug:

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

commit baef11e8e9b327dbe634edc01fef332a59ba9790
Author:     Alexander Ziaee <ziaee@FreeBSD.org>
AuthorDate: 2025-12-23 13:36:49 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2026-01-01 18:05:05 +0000

    camcontrol.8: Descriptions before examples

    This page has a lot of examples, so having them in the previous order
    can be confusing. Rewrite to the normal order where the descriptions
    come before the command, followed by a colon, which is still clear even
    jumping to the middle of the section.

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

    (cherry picked from commit fbc321b9cdceecd3c97742868da5d500423cf484)

 sbin/camcontrol/camcontrol.8 | 349 ++++++++++++++++++-------------------------
 1 file changed, 148 insertions(+), 201 deletions(-)
Comment 6 commit-hook freebsd_committer freebsd_triage 2026-01-01 19:09:52 UTC
A commit in branch stable/14 references this bug:

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

commit 74c8530c214cbc6eb01af00f12aa1d204c65ab26
Author:     Alexander Ziaee <ziaee@FreeBSD.org>
AuthorDate: 2025-12-23 13:36:49 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2026-01-01 19:05:58 +0000

    camcontrol.8: Descriptions before examples

    This page has a lot of examples, so having them in the previous order
    can be confusing. Rewrite to the normal order where the descriptions
    come before the command, followed by a colon, which is still clear even
    jumping to the middle of the section.

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

    (cherry picked from commit fbc321b9cdceecd3c97742868da5d500423cf484)

 sbin/camcontrol/camcontrol.8 | 349 ++++++++++++++++++-------------------------
 1 file changed, 148 insertions(+), 201 deletions(-)