git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] doc/for-each-ref: explicitly specify option names

From
Jeff King <peff@peff.net>
Date
Sep 1, 2017, 22:03 UTC
Message-ID
<20170901220322.stzgclld56r5lbt3@sigill.intra.peff.net>
In-Reply-To
<20170901144931.26114-1-me@ikke.info>
On Fri, Sep 01, 2017 at 04:49:31PM +0200, Kevin Daudt wrote:
> For count, sort and format, only the argument names were listed under
> OPTIONS, not the option names.
> 
> Add the option names to make it clear the options exist

Yeah, this looks much better. I could see having a general "<format>" section if it was used as the argument to multiple options, but that's not what's going on here. And even if it were, the right thing is to have individual "--foo=<format>" and "--bar=<format>" items in the list, and let them refer to a more general section on formats.

-Peff
Previous: Kevin DaudtNext: Johannes Schindelin
Message 2 of 9 in “doc/for-each-ref: explicitly specify option names”
  1. doc/for-each-ref: explicitly specify option namesKevin Daudt, Sep 1, 2017
  2. Jeff KingSep 1, 2017
  3. Johannes SchindelinSep 1, 2017
  4. Jonathan NiederSep 1, 2017
  5. Junio C HamanoSep 2, 2017
  6. 1/2 doc/for-each-ref: consistently use '=' to between argument names and valuesKevin Daudt, Sep 11, 2017
  7. 2/2 doc/for-each-ref: explicitly specify option namesKevin Daudt, Sep 11, 2017
  8. Junio C HamanoSep 12, 2017
  9. Kevin DaudtSep 12, 2017

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.