Page MenuHomeFreeBSD
Differential D9968

lib/libcam/cam_cdbparse.3: fix manpage warnings
ClosedPublic
Actions

Authored by ngie on Mar 12 2017, 5:45 AM.
Tags
None
Referenced Files
Unknown Object (File)
Feb 22 2024, 2:08 AM
Unknown Object (File)
Jan 28 2024, 5:21 PM
Unknown Object (File)
Jan 1 2024, 7:14 AM
Unknown Object (File)
Aug 24 2023, 1:12 AM
Unknown Object (File)
Aug 23 2023, 6:43 PM
Unknown Object (File)
Aug 12 2023, 4:13 PM
Unknown Object (File)
Jul 2 2023, 6:51 PM
Unknown Object (File)
Jul 1 2023, 2:56 AM
View All 18 Files
Subscribers
bjk
imp
ken
wblock

Details

Reviewers
imp
Group Reviewers
manpages
Commits
rS315202: lib/libcam/cam_cdbparse.3: fix manpage warnings
Summary

lib/libcam/cam_cdbparse.3: fix manpage warnings

  • Add comma before and after 'e.g.'; remove surrounding parentheses that were unnecessary after this change [1].
  • Add .Mt when referencing ken and Peter Dufault's email addresses [2].
  • Sprinkle around .An use where proper [2].

Bump .Dd for the change

MFC after: 1 week
Reported by: igor [1], make manlint [2]
Sponsored by: Dell EMC Isilon

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

ngie created this revision.Mar 12 2017, 5:45 AM
Herald added a reviewer: manpages. · View Herald TranscriptMar 12 2017, 5:45 AM
Herald added a subscriber: imp. · View Herald Transcript
ngie edited the summary of this revision. (Show Details)Mar 12 2017, 5:46 AM
ngie updated this revision to Diff 26170.Mar 12 2017, 5:48 AM

Add period to paragraph to terminate AUTHORS section properly.

Harbormaster completed remote builds in B8003: Diff 26169.Mar 12 2017, 6:50 AM
Harbormaster completed remote builds in B8004: Diff 26170.Mar 12 2017, 7:31 AM
ngie added a comment.Mar 13 2017, 4:17 PM

Ping: could someone please review this?

imp accepted this revision.Mar 13 2017, 4:32 PM

Generally looks good, modulo some of the text. But it's not a text cleanup, per se, so I'm good with this going in.

lib/libcam/cam_cdbparse.3
64 ↗(On Diff #26170)

That's a big date bump :)

533 ↗(On Diff #26170)

Nobody has known the name in over 15 years it seems....

This revision is now accepted and ready to land.Mar 13 2017, 4:32 PM
ngie marked an inline comment as done.Mar 13 2017, 5:34 PM
ngie added inline comments.
lib/libcam/cam_cdbparse.3
525 ↗(On Diff #26170)

I accidentally removed a period here.

533 ↗(On Diff #26170)

I looked for him, and I seem to have found someone on LinkedIn, who may or may not be the author. I'll try contacting him... if I fail to reach him for whatever reason, I'll send out another PR to prune his stale email references.

ngie marked 4 inline comments as done.Mar 13 2017, 5:34 PM
ngie added inline comments.
lib/libcam/cam_cdbparse.3
64 ↗(On Diff #26170)

Indeed!!!

Closed by commit rS315202: lib/libcam/cam_cdbparse.3: fix manpage warnings (authored by ngie). · Explain WhyMar 13 2017, 5:36 PM
This revision was automatically updated to reflect the committed changes.
ngie marked an inline comment as done.
ngie mentioned this in rS315202: lib/libcam/cam_cdbparse.3: fix manpage warnings.
ngie marked an inline comment as done.Mar 13 2017, 5:36 PM
wblock added a subscriber: wblock.Mar 17 2017, 3:48 PM
wblock added inline comments.
head/lib/libcam/cam_cdbparse.3
173

Pretty sure the \& is not necessary. Not sure why the original had it.

When possible, it's preferable to replace Latin abbreviations with English phrases. Except for "Romanes eunt domus".

ngie marked an inline comment as done.Mar 17 2017, 11:13 PM
ngie added inline comments.
head/lib/libcam/cam_cdbparse.3
173

Yeah, I'll remove the \& part -- funny why it was added.

e.g./i.e. are fairly common abbreviations though, but depending on the reader's comprehension/technical matter being discussed, I agree using "for example"/"such that" instead might make more sense.

bjk added a subscriber: bjk.Mar 17 2017, 11:51 PM
bjk added inline comments.
head/lib/libcam/cam_cdbparse.3
173

It seems highly likely that this "e.g.," was once an "e.g.", in which case there might be some value in the zero-width space, to prevent treatment of the dot as a full stop.

Revision Contents
Changeset List

PathSize
head/
lib/
libcam/
29 lines

Diff 26228

View Options

head/lib/libcam/cam_cdbparse.3

Loading...