mirror of
https://github.com/git/git
synced 2024-08-25 02:35:46 +00:00
617d57195a
Knowing which version of Git a user has and how it was built allows us to more precisely pin down the circumstances when a certain issue occurs, so teach bugreport how to tell us the same output as 'git version --build-options'. It's not ideal to directly call 'git version --build-options' because that output goes to stdout. Instead, wrap the version string in a helper within help.[ch] library, and call that helper from within the bugreport library. Signed-off-by: Emily Shaffer <emilyshaffer@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
51 lines
1.4 KiB
Plaintext
51 lines
1.4 KiB
Plaintext
git-bugreport(1)
|
|
================
|
|
|
|
NAME
|
|
----
|
|
git-bugreport - Collect information for user to file a bug report
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git bugreport' [(-o | --output-directory) <path>] [(-s | --suffix) <format>]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
Captures information about the user's machine, Git client, and repository state,
|
|
as well as a form requesting information about the behavior the user observed,
|
|
into a single text file which the user can then share, for example to the Git
|
|
mailing list, in order to report an observed bug.
|
|
|
|
The following information is requested from the user:
|
|
|
|
- Reproduction steps
|
|
- Expected behavior
|
|
- Actual behavior
|
|
|
|
The following information is captured automatically:
|
|
|
|
- 'git version --build-options'
|
|
|
|
This tool is invoked via the typical Git setup process, which means that in some
|
|
cases, it might not be able to launch - for example, if a relevant config file
|
|
is unreadable. In this kind of scenario, it may be helpful to manually gather
|
|
the kind of information listed above when manually asking for help.
|
|
|
|
OPTIONS
|
|
-------
|
|
-o <path>::
|
|
--output-directory <path>::
|
|
Place the resulting bug report file in `<path>` instead of the root of
|
|
the Git repository.
|
|
|
|
-s <format>::
|
|
--suffix <format>::
|
|
Specify an alternate suffix for the bugreport name, to create a file
|
|
named 'git-bugreport-<formatted suffix>'. This should take the form of a
|
|
link:strftime[3] format string; the current local time will be used.
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|