Page MenuHomeFreeBSD

killall(1): add EXAMPLES to manpage
ClosedPublic

Authored by fernape on May 25 2020, 4:20 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Nov 16, 7:57 AM
Unknown Object (File)
Oct 3 2024, 7:56 PM
Unknown Object (File)
Oct 3 2024, 12:55 PM
Unknown Object (File)
Oct 2 2024, 1:11 PM
Unknown Object (File)
Oct 1 2024, 7:15 PM
Unknown Object (File)
Oct 1 2024, 2:13 PM
Unknown Object (File)
Sep 28 2024, 7:17 AM
Unknown Object (File)
Sep 28 2024, 6:22 AM

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
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

Remove blank like after EXAMPLES section

Please remember to bump .Dd for the final version

killall/killall.1
149 ↗(On Diff #72244)

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

154 ↗(On Diff #72244)

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

Addressing comments by bcr@

  • Use .Dv for signals
  • Use .Va for ${USER} variable
fernape added inline comments.
killall/killall.1
149 ↗(On Diff #72244)

Corrected here and in other places around the diff.

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 ↗(On Diff #72402)

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 ↗(On Diff #72402)

here too

192 ↗(On Diff #72402)

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 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)
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.

Looks good, thanks for the final updates!

This revision is now accepted and ready to land.May 31 2020, 10:41 PM
This revision was automatically updated to reflect the committed changes.