Page MenuHomeFreeBSD

Document undocumented indent(1) options badp/nbadp, bs/nbs, and lc.
ClosedPublic

Authored by pfg on Dec 2 2016, 1:41 AM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Nov 19, 9:56 PM
Unknown Object (File)
Sun, Oct 27, 4:55 AM
Unknown Object (File)
Sun, Oct 27, 4:55 AM
Unknown Object (File)
Sun, Oct 27, 4:54 AM
Unknown Object (File)
Sun, Oct 27, 4:54 AM
Unknown Object (File)
Sun, Oct 27, 4:39 AM
Unknown Object (File)
Oct 7 2024, 2:48 PM
Unknown Object (File)
Sep 25 2024, 3:16 AM
Subscribers

Diff Detail

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

Event Timeline

pfg retitled this revision from to Document undocumented indent(1) options badp/nbadp, bs/nbs, and lc..
pfg updated this object.
pfg edited the test plan for this revision. (Show Details)
pfg added a reviewer: wblock.
pfg added a subscriber: pstef.

A few corrections. Running textproc/igor and mandoc -Tlint will find errors in man pages like this.

usr.bin/indent/indent.1
153 ↗(On Diff #22657)

You need a line break after the sentence stop here.

195 ↗(On Diff #22657)

Another line break here.

340 ↗(On Diff #22657)

Another... well, you guessed it. ;-)

pfg marked 2 inline comments as done.
pfg edited edge metadata.

Use a newline when finishing a sentence.

Done, thanks!

usr.bin/indent/indent.1
151 ↗(On Diff #22657)

I am wondering, is it OK to start a line with a comma? Perhaps this comma is also reduntant.

This revision was automatically updated to reflect the committed changes.
bjk added inline comments.
usr.bin/indent/indent.1
151 ↗(On Diff #22657)

Generally the comma would go on the previous line, with a space between "bad" and the comma. I forget whether the version as-committed will end up rendering with a space before the comma. You're also right that this particular comma is not strictly needed.

usr.bin/indent/indent.1
151 ↗(On Diff #22657)

When spoken, it doesn't quite sound right without the pause represented by the comma.

To render correctly, the comma needs to be on the same line as the .Fl macro:

.Fl bad ,

The space before the comma there is a delimiter to the macro. It renders the "bad" as the flag, then adds the comma without a space: bad,

It's hard to think of any time a line beginning with a comma with be rendered correctly.