Page MenuHomeFreeBSD
Differential D25198

split(1): Add EXAMPLES section
ClosedPublic
Actions

Authored by fernape on Jun 9 2020, 3:32 PM.
Tags
None
Referenced Files
F106047553: D25198.id72913.diff
Tue, Dec 24, 11:28 AM
Unknown Object (File)
Fri, Dec 20, 11:31 AM
Unknown Object (File)
Fri, Dec 20, 10:08 AM
Unknown Object (File)
Fri, Dec 20, 5:02 AM
Unknown Object (File)
Thu, Nov 28, 2:28 AM
Unknown Object (File)
Oct 6 2024, 8:58 PM
Unknown Object (File)
Oct 2 2024, 4:29 AM
Unknown Object (File)
Sep 30 2024, 6:43 PM
View All 49 Files
Subscribers
0mp
bcr
imp
Contributor Reviews (src)

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 - subversion
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 31584
Build 29178: arc lint + arc unit

Event Timeline

fernape created this revision.Jun 9 2020, 3:32 PM
Herald added a reviewer: manpages. · View Herald TranscriptJun 9 2020, 3:32 PM
Herald added subscribers: Contributor Reviews (src), imp. · View Herald Transcript
Harbormaster completed remote builds in B31584: Diff 72860.Jun 9 2020, 3:32 PM
fernape requested review of this revision.Jun 9 2020, 3:32 PM
fernape updated this revision to Diff 72913.Jun 10 2020, 6:20 AM

Typo.

Replace ; with :

Harbormaster completed remote builds in B31603: Diff 72913.Jun 10 2020, 6:20 AM
bcr accepted this revision as: manpages.Jun 10 2020, 9:23 AM
bcr added a subscriber: bcr.

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

fernape added a comment.Jun 18 2020, 10:02 AM
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

Is the space between ( and size of necessary?

130

Missing dot.

This revision now requires changes to proceed.Jun 18 2020, 10:20 AM
0mp added inline comments.Jun 18 2020, 10:26 AM
split/split.1
174

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

Is .No needed here?

196

Is .No needed here?

198

Is .No needed here?

fernape updated this revision to Diff 73263.Jun 18 2020, 12:25 PM

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 marked 6 inline comments as done.Jun 18 2020, 12:26 PM
fernape added inline comments.
split/split.1
174

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

0mp added a comment.Jun 18 2020, 1:02 PM
In D25198#558679, @fernape wrote:

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.

0mp accepted this revision.Jun 18 2020, 1:15 PM

One last comment regarding use of Em.

Otherwise, LGTM.

split/split.1
194

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
Closed by commit rS362328: split(1): Add EXAMPLES section (authored by fernape). · Explain WhyJun 18 2020, 3:14 PM
This revision was automatically updated to reflect the committed changes.
fernape marked an inline comment as done.
fernape added a commit: rS362328: split(1): Add EXAMPLES section.
fernape added a comment.Jun 18 2020, 3:15 PM
In D25198#558707, @0mp wrote:

One last comment regarding use of Em.

Otherwise, LGTM.

I finally did it with .Dq.

Thanks for reviewing this!

0mp added a comment.Jun 18 2020, 6:42 PM
In D25198#558771, @fernape wrote:
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!

Revision Contents
Changeset List

PathSize
split/
35 lines

Diff 72860

View Options

split/split.1

Loading...