Re: [RFC PATCH] help: add optional instructions for reporting bugs

From: Jeff King <peff@peff.net>
Date: Mar 12, 2017, 12:47 UTC
Message-ID: <20170312124725.ogwame2nm72maffy@sigill.intra.peff.net>
In-Reply-To: <CAP8UFD0xCCcmd66ChsfxPBFohekucBx3ib4Ayi+KQOXNZFHMjQ@mail.gmail.com>

On Fri, Mar 10, 2017 at 10:50:50PM +0100, Christian Couder wrote:

Show 13 quoted lines

> I don't think it's a good idea to add those "hint: ..." and
> "reporting-bugs: ..." lines.
> 
> I think it's better to do things like the following:
> 
> - add `git version -h`
> - add proper documentation for `git version` so that `git help version` works
> - in `git help version` talk about the REPORTING BUGS section in `git help git`
> - add `git version --full` or other such options to also print other
> stuff like the current OS, processor architecture, libc, etc
> - suggest in `git help version` and/or in the REPORTING BUGS section
> in `git help git` that people just copy paste the output of `git
> version --full` in their bug report

I wonder if a "gitbugs(7)" manpage would be a good thing. Then "git help bugs" would find it.

That still leaves open the question of whether people would find that documentation, but at least it is less buried than being at the bottom of the git(1) page.

-Peff