9front - general discussion about 9front
 help / color / mirror / Atom feed
From: ori@eigenstate.org
To: henesy.dev@gmail.com, 9front@9front.org
Subject: Re: [9front] quality of life usage consistency patch
Date: Sun, 8 Mar 2020 20:14:19 -0700	[thread overview]
Message-ID: <DB53D500DD37144857BE14859A1B9DD1@eigenstate.org> (raw)
In-Reply-To: <a33a887f-47a2-91d5-fa54-1ef6e22b99fd@gmail.com>

Thanks for taking the time to do this!

> A not so small patch set for normalizing usage messages to match the 
> greater of the two styles, usage vs. Usage.

I'll take a look at this, but it'll take a bit of time. I want
to make sure that both the usage and the docs match the code.
 
> I found a few other inconsistencies between programs and attempted to 
> correct instances where information seemed to be missing or lost. This 
> includes missing arguments, etc. in a manual (as per mothra(1)) and in 
> usage messages where arguments existed in the manual, instead.
> 
> In particular, gzip(1) seems to mismatch particularly with compress(1). 
> I haven't attempted to correct this yet as I'm not sure what the best 
> approach would be since the manual seems to try to normalize flags 
> across a set of programs which don't necessarily share all arguments.

Is the issue that the flags don't match between them in the manpage?
If so, how does this sound:

	The options flags have a common meaning across programs,
	when implemented:

		-a:	alligator clips are attached to the files
		-b: bromine is poured down your pants
		-c: charlie chaplin is summoned

	These flags are specific to gzip:

		-d: a pack of wild dogs chases chaplin, if the -c flag is given.

	...etc

> I hope this isn't too much bikeshedding ☺.

printing the correct set of flags is valuable.
if you were only changing 'Usage' to 'usage', I'd call it pointless.

> Python and ghostscript were intentionally ignored as I wasn't sure what 
> the protocol should be for changing these.

Yeah, not sure -- I'd leave the usage output untouched, so long
as its correct. They're alien anyways.



  reply	other threads:[~2020-03-09  3:14 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-09  2:06 Sean Hinchee
2020-03-09  3:14 ` ori [this message]
2020-03-09  3:47   ` Sean Hinchee
2020-03-10 17:56 ` ori
2020-03-10 18:03   ` sl

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=DB53D500DD37144857BE14859A1B9DD1@eigenstate.org \
    --to=ori@eigenstate.org \
    --cc=9front@9front.org \
    --cc=henesy.dev@gmail.com \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).