All of lore.kernel.org
 help / color / mirror / Atom feed
From: Benno Schulenberg <bensberg@justemail.net>
To: Karel Zak <kzak@redhat.com>
Cc: Martin Steigerwald <ms@teamix.de>,
	"Util-Linux" <util-linux@vger.kernel.org>
Subject: Re: chrt: inconsistency in --help
Date: Thu, 11 Jun 2015 11:03:48 +0200	[thread overview]
Message-ID: <1434013428.75585.292665745.17FBFAD5@webmail.messagingengine.com> (raw)
In-Reply-To: <20150609092412.GG1992@ws.net.home>


On Tue, Jun 9, 2015, at 11:24, Karel Zak wrote:
> On Tue, Jun 09, 2015 at 10:37:46AM +0200, Martin Steigerwald wrote:
> > Set policy:
> >   chrt [options] [-p] [<policy>] <priority> [<pid> | <command> [<arg>...]]
> 
>  Yes, I have modified --help output to this

Well, -p is just one of the possible options, so it could be simply
subsumed under [options].  Also, the brackets around "<pid> | <command>
[<arg>..." seem to say that both <pid> and <command> are optional,
but they are not when the <priority> is given.  Furthermore, <policy>
seems to suggest it is something like "WORD" or "name" or "12345",
but in fact it is a certain type of option, starting with a dash.
So I think the current synopsis is rather confusing.

The man page summarizes the command as follows:
    chrt [options] priority command [argument...]
    chrt [options] -p [priority] pid

The first line shows how to run a command with certain attributes,
the second how to query or modify the attributes of an existing process.
Quite clear.

So, to make usage synopsis clearer and correct I would suggest
rewriting it as:

Set policy:
    chrt [options] <priority> <command> [<arg>...]
    chrt [options] -p <priority> <pid>

The first of the upcoming two patches makes this change.

Benno

-- 
http://www.fastmail.com - Accessible with your email software
                          or over the web


  reply	other threads:[~2015-06-11  9:03 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-06-09  8:37 chrt: inconsistency in --help Martin Steigerwald
2015-06-09  9:24 ` Karel Zak
2015-06-11  9:03   ` Benno Schulenberg [this message]
2015-06-15 13:09     ` Karel Zak

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1434013428.75585.292665745.17FBFAD5@webmail.messagingengine.com \
    --to=bensberg@justemail.net \
    --cc=kzak@redhat.com \
    --cc=ms@teamix.de \
    --cc=util-linux@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.