Page MenuHomeFreeBSD

dtc(1) manpage review
Needs ReviewPublic

Authored by kevans on Jan 11 2018, 6:07 PM.
Tags
None
Referenced Files
Unknown Object (File)
Dec 20 2023, 4:43 AM
Unknown Object (File)
Dec 17 2023, 9:56 AM
Unknown Object (File)
Dec 16 2023, 8:10 PM
Unknown Object (File)
Dec 16 2023, 8:57 AM
Unknown Object (File)
Dec 15 2023, 8:17 PM
Unknown Object (File)
Nov 14 2023, 8:58 AM
Unknown Object (File)
Nov 9 2023, 5:42 AM
Unknown Object (File)
Nov 6 2023, 3:56 PM

Details

Reviewers
None
Group Reviewers
manpages
Summary

We've had dtc.1 in the tree for a while, but I believe it's not been subjected to manpages review. I'd like to request a full review of this manpage (suggested by the author), if this is OK. =)

I should note that this is not the current in-tree version, but the version that will be imported following any editorial comments.

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 14436

Event Timeline

A few suggestions for improvement.

usr.bin/dtc/dtc.1
60

Superfluous space before "It".

99

space after comma. Is the comma really necessary here?

156

no need to have a line break here.

305

Another line break here.

I appreciate your review. =)

usr.bin/dtc/dtc.1
99

Ah, right, so this isn't very clear from looking at it, but "linux,phandle" is literally the name of an attribute that will get set, so the spacing here is important. I'm not sure if we have a better way to denote that, though?

It almost needs a .Va, but that seems a little too much. Perhaps just quoted, unless there's another macro that would fit.

kevans marked 2 inline comments as done.

Address two, potentially three, out of four concerns by @bcr with questions left on the two not-addressed concerns.

usr.bin/dtc/dtc.1
156

I removed the line break and re-wrapped this section to 80-col-- is that correct?

You can check with textproc/igor. I believe it should check for overlong lines in man pages, too.

bjk added inline comments.
usr.bin/dtc/dtc.1
158

The wrapping is correct -- thanks.
I'd add an 'a' in "for a bootloader", though.

248

Should we just say ".Nm
" (including newline) rather than "The utility"?

285

Do we need markup (.Va?) for "overlay"?

324

Ditto about markup for symbols

335

(and here)