From: Jeff King <peff@peff.net>
To: Christian Couder <christian.couder@gmail.com>
Cc: Jonathan Nieder <jrnieder@gmail.com>,
Stefan Beller <sbeller@google.com>, git <git@vger.kernel.org>
Subject: Re: [RFC PATCH] help: add optional instructions for reporting bugs
Date: Sun, 12 Mar 2017 08:47:25 -0400 [thread overview]
Message-ID: <20170312124725.ogwame2nm72maffy@sigill.intra.peff.net> (raw)
In-Reply-To: <CAP8UFD0xCCcmd66ChsfxPBFohekucBx3ib4Ayi+KQOXNZFHMjQ@mail.gmail.com>
On Fri, Mar 10, 2017 at 10:50:50PM +0100, Christian Couder wrote:
> 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
next prev parent reply other threads:[~2017-03-12 12:47 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-09 19:30 [RFC PATCH] help: add optional instructions for reporting bugs Stefan Beller
2017-03-10 18:13 ` Jonathan Nieder
2017-03-10 21:50 ` Christian Couder
2017-03-12 12:47 ` Jeff King [this message]
2017-03-13 18:00 ` Stefan Beller
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170312124725.ogwame2nm72maffy@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=jrnieder@gmail.com \
--cc=sbeller@google.com \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).