Bug 266554 - Spelling error iwlwifi man page
Summary: Spelling error iwlwifi man page
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Graham Perrin
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-09-22 20:44 UTC by Sam Shyamani
Modified: 2023-01-11 10:24 UTC (History)
6 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Sam Shyamani 2022-09-22 20:44:30 UTC
Gentlebeings, 

I have found what I believe is a spelling error on the iwlwifi man page. Detailed below

iwlwifi will be a successor to iwm(4) and may superseed that driver in
     the future.

Should read:
iwlwifi will be a successor to iwm(4) and may SUPERCEDE that driver in
     the future.

Caps just to indicate the incorrectly spelled word.
Comment 1 Maxim Konovalov freebsd_committer freebsd_triage 2022-09-22 21:27:27 UTC
Hi Sam,

Indeed, it looks like a common typo. However, it looks like your version is also not entirely correct or wide use:

https://en.wiktionary.org/wiki/supersede#English

We probably need to use "superseded" instead.

Being a non-native speaker, I am definitely not an expert in this area though.

Maxim
Comment 2 Maxim Konovalov freebsd_committer freebsd_triage 2022-09-22 21:31:14 UTC
For the sake of completeness, I c&p a patch here

diff --git a/share/man/man4/iwlwifi.4 b/share/man/man4/iwlwifi.4
index bfb3c00d921..94614b3b15f 100644
--- a/share/man/man4/iwlwifi.4
+++ b/share/man/man4/iwlwifi.4
@@ -186,7 +186,7 @@ Intel(R) Wi-Fi 6 AX204 160MHz
 .Nm
 will be a successor to
 .Xr iwm 4
-and may superseed that driver in the future.
+and may supersede that driver in the future.
 It still complements the
 .Xr iwn 4
 driver which supports older chipsets.
Comment 3 Sam Shyamani 2022-09-22 21:45:26 UTC
Hello Maxim

I appreciate your investigation and agree your recommendation as our probable best solution.

Thank you for your highly prompt attention and response.

Regards,
Sam
Comment 4 commit-hook freebsd_committer freebsd_triage 2022-09-22 22:36:41 UTC
A commit in branch main references this bug:

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

commit 7e58c8aa8245192176ac12961272bcb19dfaeb91
Author:     Maxim Konovalov <maxim@FreeBSD.org>
AuthorDate: 2022-09-22 22:35:16 +0000
Commit:     Maxim Konovalov <maxim@FreeBSD.org>
CommitDate: 2022-09-22 22:35:16 +0000

    iwlwifi.4: typo fixed

    PR:     266554

 share/man/man4/iwlwifi.4 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Comment 5 Graham Perrin freebsd_committer freebsd_triage 2023-01-08 19:59:35 UTC
(In reply to commit-hook from comment #4)

<https://github.com/freebsd/freebsd-src/commit/7e58c8aa8245192176ac12961272bcb19dfaeb91> shows the commit on the main branch, and I see the correction under <https://www.freebsd.org/cgi/man.cgi?query=iwlwifi&sektion=4&manpath=FreeBSD+14.0-CURRENT#DESCRIPTION>. 

For the same correction to become apparent under <https://www.freebsd.org/cgi/man.cgi?query=iwlwifi&sektion=4&manpath=FreeBSD#DESCRIPTION> (currently for 13.1-RELEASE) and <https://www.freebsd.org/cgi/man.cgi?query=iwlwifi&sektion=4&manpath=FreeBSD-STABLE#DESCRIPTION> (for 13.1-STABLE), please, what's required?
Comment 6 Wolfram Schneider freebsd_committer freebsd_triage 2023-01-08 20:21:28 UTC
(In reply to Graham Perrin from comment #5)

First, you have to merge the changes into the stable/13 branch.

Then you have to wait until the next update of the FreeBSD -STABLE manual pages at man.freebsd.org, which usually happens every 3 months.
Comment 7 Maxim Konovalov freebsd_committer freebsd_triage 2023-01-09 00:53:11 UTC
(In reply to Graham Perrin from comment #5)

Hi Graham,

I plan to merge this delta next week unless someone gets ahead of me.

Thanks,

Maxim
Comment 8 Graham Perrin freebsd_committer freebsd_triage 2023-01-09 04:02:09 UTC
(In reply to Maxim Konovalov from comment #7)

Taking, thanks; it'll be an opportunity for my first use of git-cherry-pick(1).

(I asked a simple question in #freebsd-dev a few minutes ago, I don't foresee difficulty.)
Comment 9 commit-hook freebsd_committer freebsd_triage 2023-01-11 09:19:11 UTC
A commit in branch stable/13 references this bug:

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

commit 330448f068c67ddc145d8b81ef4e28995ccccebb
Author:     Maxim Konovalov <maxim@FreeBSD.org>
AuthorDate: 2022-09-22 22:35:16 +0000
Commit:     Graham Perrin <grahamperrin@FreeBSD.org>
CommitDate: 2023-01-11 09:16:26 +0000

    iwlwifi.4: typo fixed

    PR: 266554
    (cherry picked from commit 7e58c8aa8245192176ac12961272bcb19dfaeb91)

 share/man/man4/iwlwifi.4 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Comment 10 Graham Perrin freebsd_committer freebsd_triage 2023-01-11 10:24:06 UTC
Thanks, everyone. 

Re: comment 6, we'll see the correction under <https://www.freebsd.org/cgi/man.cgi?query=iwlwifi&sektion=4&manpath=FreeBSD-STABLE#DESCRIPTION> in due course. 

----

(In reply to Graham Perrin from comment #8)

> … an opportunity for my first use of git-cherry-pick(1). …

I left a post-commit note for myself in GitHub.