Re: [PATCH 2/2] Documentation: make git-sh-setup docs less scary

From: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date: Dec 20, 2011, 19:45 UTC
Message-ID: <CACBZZX5BSfh8S9Kf1Wbi+NPEKpxJNXU8TD8-hkC2o1Mi91Or6A@mail.gmail.com>
In-Reply-To: <c8867738c264a76f9662080b64e00615ec1aa28f.1324378986.git.trast@student.ethz.ch>

On Tue, Dec 20, 2011 at 12:09, Thomas Rast <trast@student.ethz.ch> wrote:

> At least one IRC user was scared away by the introductory "This is not
> a command the end user would want to run.  Ever." to the point of not
> reading on.

Arguably that's the point isn't it? To not have people who aren't maintaining Git itself waste time on reading it.

Anyway I don't care how it's worded, but if you're going to patch it you should probably do these too for consistency, since they copy/paste this same blurb:

    $ git --no-pager grep -l 'This is not a command the end user would
want to run.  Ever.'
    Documentation/git-mergetool--lib.txt
    Documentation/git-sh-i18n--envsubst.txt
    Documentation/git-sh-i18n.txt
    Documentation/git-sh-setup.txt

And actually we might want to do all those with some asciidoc include mechanism.