Page MenuHomeFreeBSD

top: Polish key bindings in usage and manual
ClosedPublic

Authored by ziaee on Sun, Mar 23, 6:37 PM.
Tags
None
Referenced Files
F114328260: D49462.id152660.diff
Fri, Apr 11, 3:12 AM
Unknown Object (File)
Thu, Apr 10, 6:13 AM
Unknown Object (File)
Tue, Apr 8, 1:14 AM
Unknown Object (File)
Sun, Apr 6, 2:33 PM
Unknown Object (File)
Sat, Apr 5, 5:10 AM
Unknown Object (File)
Fri, Apr 4, 10:46 AM
Unknown Object (File)
Thu, Apr 3, 12:31 AM
Unknown Object (File)
Sat, Mar 29, 7:06 PM

Details

Summary

Organize key bindings by ascii(7) for consistency and maintainability,
mark them as Interactive Commands, wordsmith them, and sync their
organization between the manual and
help screen.

MFC after: 3 days
PR: 282734
Fixes: c8aa5e526 (move command mapping to commands.c)

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

ziaee requested review of this revision.Sun, Mar 23, 6:37 PM

Fix a pre-existing typo in the manual's synopsis (s/x/w/).

jpb_jimby.name added inline comments.
usr.bin/top/top.1
270

Consider adding a note here about some options that toggle their effect such as 'i' showing / not showing idle processes. There are a number of such options.

272–273

Consider moving this note to the '/' command. There are similar notes in other commands (see 'J', 'p', and 'u').

ziaee retitled this revision from top: Sync key bindings in usage and manual to top: Polish key bindings in usage and manual.Tue, Mar 25, 7:40 PM
ziaee edited the summary of this revision. (Show Details)

I have been working on this manual for many hours over the last two
days. This commit is just scoped to this section. Subsequent patches
to follow.

ziaee added a subscriber: dvl.
ziaee added inline comments.
usr.bin/top/top.1
272–273

You're right, my mistake copying.

ziaee marked an inline comment as done.

Fix a small consistency nit

Fix a grammatical typo, I think this is the last one.

FYI, it is difficult to review a change that reorders and rewords a list of entries, at the same time. In the future such a thing should be split.

However, seems good to me.

This revision is now accepted and ready to land.Tue, Mar 25, 9:32 PM

Same comments a mhorne

This revision was automatically updated to reflect the committed changes.

*sigh* and after all that I still messed it up.
In this situation, we have:

  1. The help screen
  2. The usage
  3. The manual synopsis
  4. The manual description (just the command explanations, the introductiory paragraph is also wrong, but trying to scope)

Every single one of them disagrees in different ways with what the program does. I will send another patch tonight. Sorry everyone. At least this is substantially more accurate than what we had before.