Bug 237725 - Spelling in share/man/man4/bridge.4
Summary: Spelling in share/man/man4/bridge.4
Status: In Progress
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: freebsd-bugs (Nobody)
URL:
Keywords: patch
Depends on:
Blocks:
 
Reported: 2019-05-03 10:39 UTC by Tom Marcoen
Modified: 2019-06-09 13:49 UTC (History)
4 users (show)

See Also:


Attachments
svn diff > ~/doc-fix-spelling.diff (1.75 KB, patch)
2019-05-03 10:39 UTC, Tom Marcoen
no flags Details | Diff
New diff after running igor on the file. (2.01 KB, patch)
2019-05-03 11:14 UTC, Tom Marcoen
no flags Details | Diff
New diff after comments from Tom Rhodes (2.39 KB, patch)
2019-05-03 18:09 UTC, Tom Marcoen
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
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 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 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 2019-06-09 13:49:35 UTC
Any progress on this, Tom?