Bug 237725

Summary: Spelling in share/man/man4/bridge.4
Product: Documentation Reporter: Tom Marcoen <tom.marcoen>
Component: Manual PagesAssignee: Guangyuan Yang <ygy>
Status: Closed FIXED    
Severity: Affects Only Me CC: bcr, doc, felix.the.red, tom.marcoen, trhodes, ygy
Priority: --- Keywords: patch
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
svn diff > ~/doc-fix-spelling.diff
none
New diff after running igor on the file.
none
New diff after comments from Tom Rhodes none

Description Tom Marcoen 2019-05-03 10:39:54 UTC
Created attachment 204182 [details]
svn diff > ~/doc-fix-spelling.diff

Some spelling fixes, e.g. add missing articles.
Comment 1 Tom Marcoen 2019-05-03 11:14:57 UTC
Created attachment 204183 [details]
New diff after running igor on the file.
Comment 2 Tom Rhodes freebsd_committer freebsd_triage 2019-05-03 14:12:41 UTC
Hi Tom,

Thanks for the patch.  Just a few things I see:

-.Dd October 16, 2017
+.Dd May 3, 2019

We only bump the document date on content changes, unless that policy changed and I missed it, we do not need to change it here.

 The TOE, TSO, TXCSUM and TXCSUM6 capabilities on all interfaces added to the
-bridge are disabled if any of the interfaces doesn't support/enable them.
+bridge are disabled if any of the interfaces don't support/enable them.

We do our best to avoid contractions, perhaps in this case "interfaces will not support or enable them."?


-All the capabilities are restored when the interface is removed from bridge.
-Changing capabilities in run time may cause NIC reinit and the link flap.
+All the capabilities are restored when the interface is removed from the
+bridge.
+Changing capabilities in run time may cause the NIC to reinitialize and
+the link to flap.
 .Pp
 The bridge supports

This seems to move some words down onto a new line but, at least at a quick look, there is still white space at EOL.  This might be my browser so please let me know if I'm just crazy.  Thanks for the patch!
Comment 3 Tom Marcoen 2019-05-03 17:12:47 UTC
1. I'll change the date back to the original date. I was not aware of the policy but igor(1) complained about the date not being today's date so I modified it.

2. The original had a contraction so I kept that, only changed plurar to singular. But I will modify it to "do not" as I believe that to be more correct than "will not" but I am not a native English speaker so I might be incorrect.

3. I do not understand what you mean here. I added a few articles (`the', `a', `an') and tried to get the width of the lines max 72 characters and starting a new line after a period. Are you referring to the output (in the man page)?
Comment 4 Tom Marcoen 2019-05-03 18:09:32 UTC
Created attachment 204197 [details]
New diff after comments from Tom Rhodes
Comment 5 Tom Rhodes freebsd_committer freebsd_triage 2019-05-06 15:58:22 UTC
Hi Tom,

Yes, thank you.  The concern over whitespace was just the " " at the end of sentences which may or may not be related to the web interface that I am currently using.  I'll review this patch sometime this week and follow back up.  Thanks for all your help on this!
Comment 6 Benedict Reuschling freebsd_committer freebsd_triage 2019-06-09 13:49:35 UTC
Any progress on this, Tom?
Comment 7 Felix Johnson freebsd_triage 2021-10-16 13:17:30 UTC
This patch looks like it would apply cleanly.
Can we get it committed and close the PR?
Comment 8 Guangyuan Yang freebsd_committer freebsd_triage 2021-10-18 19:13:57 UTC
This patch looks good to my eye - I will wait a few days for everyone here to review and respond, and have it committed soon.
Comment 9 commit-hook freebsd_committer freebsd_triage 2021-11-17 17:52:48 UTC
A commit in branch main references this bug:

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

commit 8406182dbeb972698775e2468902bc5f6e593d72
Author:     Tom Marcoen <tom.marcoen@gmail.com>
AuthorDate: 2021-11-17 17:47:33 +0000
Commit:     Guangyuan Yang <ygy@FreeBSD.org>
CommitDate: 2021-11-17 17:52:30 +0000

    bridge(4): Fix spelling

    PR:             237725
    MFC after:      3 days

 share/man/man4/bridge.4 | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)
Comment 10 commit-hook freebsd_committer freebsd_triage 2021-11-20 01:09:15 UTC
A commit in branch stable/13 references this bug:

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

commit ffc00e9db94dce45d332651ec538672f211760c3
Author:     Tom Marcoen <tom.marcoen@gmail.com>
AuthorDate: 2021-11-17 17:47:33 +0000
Commit:     Guangyuan Yang <ygy@FreeBSD.org>
CommitDate: 2021-11-20 01:08:14 +0000

    bridge(4): Fix spelling

    PR:             237725

    (cherry picked from commit 8406182dbeb972698775e2468902bc5f6e593d72)

 share/man/man4/bridge.4 | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)