From: Maaartin <grajcar1@seznam.cz>
To: Jeff King <peff@peff.net>
Cc: Nicolas Sebrecht <nicolas.s.dev@gmx.fr>,
Junio C Hamano <gitster@pobox.com>,
Sebastian Pipping <webmaster@hartwork.org>,
Thomas Rast <trast@student.ethz.ch>, Git ML <git@vger.kernel.org>
Subject: Re: Parameter --color-words not documented for "git show"
Date: Fri, 21 Jan 2011 11:08:21 +0100 [thread overview]
Message-ID: <4D395B15.2040406@seznam.cz> (raw)
In-Reply-To: <20110120233429.GB9442@sigill.intra.peff.net>
On 11-01-21 00:34, Jeff King wrote:
> On Fri, Jan 21, 2011 at 12:16:49AM +0100, Nicolas Sebrecht wrote:
> 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.
I also favor (4), for the following reasons:
- sometimes you want to read the whole manpage, e.g., it's good for
beginners to get feeling what is it all about.
- repeated information makes the page too long and reading too boring.
- too long manpages may scare beginners.
Maybe there could be sort-of extended manpage, containing everything,
but it would need some markup beyond the capabilities of a terminal (a
grayed or collapsed area in html, or whatever). However, this could be a
lot of additional work, and I don't claim it should be done, just an idea.
next prev parent reply other threads:[~2011-01-21 10:08 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-01-20 19:58 Parameter --color-words not documented for "git show" Sebastian Pipping
2011-01-20 20:27 ` Thomas Rast
2011-01-20 20:43 ` Sebastian Pipping
2011-01-20 21:25 ` Junio C Hamano
2011-01-20 23:16 ` Nicolas Sebrecht
2011-01-20 23:34 ` Jeff King
2011-01-21 0:05 ` Sebastian Pipping
2011-01-21 0:20 ` Jeff King
2011-01-21 0:27 ` Sebastian Pipping
2011-01-21 6:08 ` Junio C Hamano
2011-01-21 16:16 ` Jeff King
2011-01-21 10:08 ` Maaartin [this message]
2011-01-21 16:17 ` Jeff King
2011-01-23 10:35 ` Jakub Narebski
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=4D395B15.2040406@seznam.cz \
--to=grajcar1@seznam.cz \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=nicolas.s.dev@gmx.fr \
--cc=peff@peff.net \
--cc=trast@student.ethz.ch \
--cc=webmaster@hartwork.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.