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

Re: Parameter --color-words not documented for "git show"

From
Junio C Hamano <gitster@pobox.com>
Date
Jan 21, 2011, 06:08 UTC
Message-ID
<7vy66epz4r.fsf@alter.siamese.dyndns.org>
In-Reply-To
<20110120233429.GB9442@sigill.intra.peff.net>
Jeff King <peff@peff.net> writes:
Show 22 quoted lines
> The problem is that we have a bazillion diff options that appear in many
> manpages, so you are stuck with one of:
>
>   1. repeat them all in each manpage (usually via some automagic
>      include), which dwarfs the original content, and makes it hard for
>      users to see subtle differences between commands
>
>   2. Say "this describes only the most frequently used options", which
>      leaves the user wondering which infrequently used options exist.
>
>   3. Say "we also take diff options, and you can find out more about
>      diff options in git-diff(1)." This at least points the user in the
>      right direction, but you can't search for "--color-words" in the
>      page.
>
>   4. Do (3), but also list the all (or common) diff options in a succint
>      list without descriptions, and refer the user to git-diff(1). Then
>      they can grep if they like, and while they won't get the immediate
>      answer, they will get referred to the right place.
>
> As you can probably guess, I favor option (4), though we already do (3)
> in some places.

We attempt to do 1 to solve it "nicely" in some manual pages, and indeed there are many "exclude this option from the command X's manpage" magic that causes the problem of subtle differences you mentioned (which I agree).

One complication in either 3 or 4 is that they sometimes need to be accompanied with "... except these diff options do not make sense in the context of this command, so they are no-op". That is probably a price worth paying to be more helpful than 2 is.

Previous: Sebastian PippingNext: Jeff King
Message 10 of 14 in “Parameter --color-words not documented for "git show"”
  1. Sebastian PippingJan 20, 2011
  2. Thomas RastJan 20, 2011
  3. Sebastian PippingJan 20, 2011
  4. Junio C HamanoJan 20, 2011
  5. Nicolas SebrechtJan 20, 2011
  6. Jeff KingJan 20, 2011
  7. Sebastian PippingJan 21, 2011
  8. Jeff KingJan 21, 2011
  9. Sebastian PippingJan 21, 2011
  10. Junio C HamanoJan 21, 2011
  11. Jeff KingJan 21, 2011
  12. MaaartinJan 21, 2011
  13. Jeff KingJan 21, 2011
  14. Jakub NarebskiJan 23, 2011

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.