Page MenuHomeFreeBSD

split(1): Add EXAMPLES section
ClosedPublic

Authored by fernape on Jun 9 2020, 3:32 PM.

Details

Reviewers
0mp
Group Reviewers
manpages
Commits
rS362328: split(1): Add EXAMPLES section
Summary

Two changes, but I can split (hehe) them if required:

  • Add EXAMPLES covering -d, -n and -p
  • Include small explanation about the size of the chunks for the -n option

    I'm in doubt as if I need to mark the names of the files (xab, etc) somehow in the description of the example.
Test Plan
  • mandoc -Tlint clean
  • aspell happy
  • man ./split.1 renders the page properly

Diff Detail

Repository
rS FreeBSD src repository
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

bcr added a subscriber: bcr.

Good to go! Thanks for another man page with EXAMPLEs.

In D25198#555747, @bcr wrote:

Good to go! Thanks for another man page with EXAMPLEs.

Thanks. The review is in "Needs review" state though. Would it be possible to accept it?

0mp requested changes to this revision.Jun 18 2020, 10:20 AM
0mp added a subscriber: 0mp.
0mp added inline comments.
split/split.1
125 ↗(On Diff #72913)

Is the space between ( and size of necessary?

130 ↗(On Diff #72913)

Missing dot.

This revision now requires changes to proceed.Jun 18 2020, 10:20 AM
split/split.1
174 ↗(On Diff #72913)

I am not a native speaker, but I think there is something missing from this sentence.

How about:

Split input into as many files as needed, so that each file contains at most 2 lines.

While here, I think that the description of the -l flag is not clear, but it could be solved in another patch.

194 ↗(On Diff #72913)

Is .No needed here?

196 ↗(On Diff #72913)

Is .No needed here?

198 ↗(On Diff #72913)

Is .No needed here?

Address comments by 0mp@:

  • Remove spurioius space after parenthesis
  • Rephrase example description to make it clearer
  • Remove unnecessary .No in different places

For some reason I don't understand, I had to generate and update the diff with svn diff split/split.1 >~/split.1.diff because arc diff --update D25198 split/split.1 keeps saying: Usage Exception: There are no changes to generate a diff from!

fernape added inline comments.
split/split.1
174 ↗(On Diff #72913)

Neither am I, but your sentences is much clearer than mine, thanks! :-)

For some reason I don't understand, I had to generate and update the diff with svn diff split/split.1 >~/split.1.diff because arc diff --update D25198 split/split.1 keeps saying: Usage Exception: There are no changes to generate a diff from!

I am not sure but I think it happens when you run arc diff from a different directory than the tree's root directory.

One last comment regarding use of Em.

Otherwise, LGTM.

split/split.1
194 ↗(On Diff #73263)

I think I'd change Em here to Dq.

Dq is much more often used to talk about some literal strings. Also, Em looks very similarly to Ar and Pa, which tend to confuse users (or at least me).

Anyway, if it looks better with Em than with Dq, then leave Em.

This revision is now accepted and ready to land.Jun 18 2020, 1:15 PM
This revision was automatically updated to reflect the committed changes.
fernape marked an inline comment as done.
In D25198#558707, @0mp wrote:

One last comment regarding use of Em.

Otherwise, LGTM.

I finally did it with .Dq.

Thanks for reviewing this!

In D25198#558707, @0mp wrote:

One last comment regarding use of Em.

Otherwise, LGTM.

I finally did it with .Dq.

Thanks for reviewing this!

Thanks a lot for your work on the manual pages!

Cheers!