Page MenuHomeFreeBSD
Differential D25002

killall(1): add EXAMPLES to manpage
ClosedPublic
Actions

Authored by fernape on May 25 2020, 4:20 PM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, May 3, 6:48 PM
Unknown Object (File)
Fri, May 3, 6:48 PM
Unknown Object (File)
Fri, May 3, 6:48 PM
Unknown Object (File)
Thu, May 2, 8:59 AM
Unknown Object (File)
Sun, Apr 28, 3:24 PM
Unknown Object (File)
Sat, Apr 27, 6:32 AM
Unknown Object (File)
Fri, Apr 5, 10:22 AM
Unknown Object (File)
Mar 20 2024, 7:31 AM
View All 54 Files
Subscribers
bcr
bjk
imp
Contributor Reviews (src)

Details

Reviewers
bjk
Group Reviewers
manpages
Commits
rS361783: Add EXAMPLES to killall(1)
Summary

killall(1) man page lacked EXAMPLES. Add some of them showing typical usage

Test Plan
  1. Apply patch
  2. man ./killall.1

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 31405
Build 29028: arc lint + arc unit

Event Timeline

fernape created this revision.May 25 2020, 4:20 PM
Herald added a reviewer: manpages. · View Herald TranscriptMay 25 2020, 4:20 PM
Herald added subscribers: Contributor Reviews (src), imp. · View Herald Transcript
Harbormaster completed remote builds in B31294: Diff 72243.May 25 2020, 4:20 PM
fernape requested review of this revision.May 25 2020, 4:20 PM
fernape updated this revision to Diff 72244.May 25 2020, 4:22 PM

Remove blank like after EXAMPLES section

Harbormaster completed remote builds in B31295: Diff 72244.May 25 2020, 4:22 PM
bcr added a subscriber: bcr.May 25 2020, 7:44 PM
bjk added a subscriber: bjk.May 29 2020, 2:39 AM

Please remember to bump .Dd for the final version

killall/killall.1
149

I think .Dv would be appropriate for the plaintext signal names.

154

The Va macro can be used for variable names, though ${USER} is more of an expression than a variable name, so one could argue for it being .Li instead

fernape updated this revision to Diff 72402.May 29 2020, 12:15 PM

Addressing comments by bcr@

  • Use .Dv for signals
  • Use .Va for ${USER} variable
Harbormaster completed remote builds in B31368: Diff 72402.May 29 2020, 12:15 PM
fernape marked 2 inline comments as done.May 29 2020, 12:16 PM
fernape added inline comments.
killall/killall.1
149

Corrected here and in other places around the diff.

bjk added a comment.May 30 2020, 4:46 PM

Thanks for the updates; they look good.
Just one more thing (stray .Ed) that I missed last time, sorry.
mandoc -Tlint can help find this sort of thing in the future.

killall/killall.1
160

It looks like there are a couple of .Ed macros at the end of regular paragraphs like this.
.Ed is only needed to close a matching .Bd section, around the actual example command-lines.

167

here too

192

Since "vim" and "vimdiff" are just examples of things that match "vim*", I don't feel a particular need to put extra markup (e.g., .Xr) on them

fernape updated this revision to Diff 72471.May 31 2020, 10:08 AM
fernape marked an inline comment as done.
  • Remove Ed without matching Bd (requested by bjk@)
  • Removing Pp before Bd (reported by mandoc -Tlint)
  • Remove extra white spaces at the end of the line (reported by mandoc -Tlint)
Harbormaster completed remote builds in B31405: Diff 72471.May 31 2020, 10:08 AM
fernape marked 2 inline comments as done.May 31 2020, 10:23 AM
In D25002#552126, @bjk wrote:

Thanks for the updates; they look good.
Just one more thing (stray .Ed) that I missed last time, sorry.
mandoc -Tlint can help find this sort of thing in the future.

Thanks for the time spent reviewing this. I addressed also a couple of issues the linter spotted.

bjk accepted this revision.May 31 2020, 10:41 PM

Looks good, thanks for the final updates!

This revision is now accepted and ready to land.May 31 2020, 10:41 PM
Closed by commit rS361783: Add EXAMPLES to killall(1) (authored by bjk). · Explain WhyJun 4 2020, 4:29 AM
This revision was automatically updated to reflect the committed changes.
bjk added a commit: rS361783: Add EXAMPLES to killall(1).

Revision Contents
Changeset List

PathSize
killall/
44 lines

Diff 72471

View Options

killall/killall.1

Loading...