diff options
author | Junio C Hamano <gitster@pobox.com> | 2020-05-01 14:53:51 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2020-05-01 14:53:51 -0700 |
commit | 864182b6457faf2455894d9a200acda0751f3c80 (patch) | |
tree | 06ab5e096eab9ff6ae4bcb46ce9f1c2515f43ff0 /git-bugreport.txt | |
parent | 67cc2b7cdda7af3a7079b399a8a154d094efc649 (diff) | |
download | git-htmldocs-864182b6457faf2455894d9a200acda0751f3c80.tar.gz |
Autogenerated HTML docs for v2.26.2-533-gb34789
Diffstat (limited to 'git-bugreport.txt')
-rw-r--r-- | git-bugreport.txt | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/git-bugreport.txt b/git-bugreport.txt new file mode 100644 index 000000000..643d1b288 --- /dev/null +++ b/git-bugreport.txt @@ -0,0 +1,52 @@ +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' + - uname sysname, release, version, and machine strings + - Compiler-specific info string + +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 |