git/Documentation/git-bugreport.txt, branch v2.41.3

builtin/bugreport.c: create '--diagnose' option

2022-08-12T20:20:02Z

Create a '--diagnose' option for 'git bugreport' to collect additional information about the repository and write it to a zipped archive. The '--diagnose' option behaves effectively as an alias for simultaneously running 'git bugreport' and 'git diagnose'. In the documentation, users are explicitly recommended to attach the diagnostics alongside a bug report to provide additional context to readers, ideally reducing some back-and-forth between reporters and those debugging the issue. Note that '--diagnose' may take an optional string arg (either 'stats' or 'all'). If specified without the arg, the behavior corresponds to running 'git diagnose' without '--mode'. As with 'git diagnose', this default is intended to help reduce unintentional leaking of sensitive information). Users can also explicitly specify '--diagnose=(stats|all)' to generate the respective archive created by 'git diagnose --mode=(stats|all)'. Suggested-by: Ævar Arnfjörð Bjarmason Helped-by: Derrick Stolee Signed-off-by: Victoria Dye Signed-off-by: Junio C Hamano

Documentation: fix default directory of git bugreport -o

2021-09-07T21:25:13Z

git bugreport writes bug report to the current directory by default, instead of repository root. Fix the documentation. Signed-off-by: Bagas Sanjaya Signed-off-by: Junio C Hamano

Merge branch 'es/bugreport-shell'

2020-06-09T01:06:28Z

"git bugreport" learns to report what shell is in use. * es/bugreport-shell: bugreport: include user interactive shell help: add shell-path to --build-options

Merge branch 'es/bugreport'

2020-05-20T15:33:30Z

Doc fix. * es/bugreport: git-bugreport.txt: adjust reference to strftime(3)

git-bugreport.txt: adjust reference to strftime(3)

2020-05-18T19:54:53Z

The strftime(3) man page is outside of the Git suite. Refererence it as we do other external man pages and avoid creating a broken link when generating the HTML documentation. Signed-off-by: Todd Zullinger Signed-off-by: Junio C Hamano

bugreport: include user interactive shell

2020-05-13T05:02:20Z

It's possible a user may complain about the way that Git interacts with their interactive shell, e.g. autocompletion or shell prompt. In that case, it's useful for us to know which shell they're using interactively. Signed-off-by: Emily Shaffer Signed-off-by: Junio C Hamano

bugreport: collect list of populated hooks

2020-05-08T01:25:04Z

Occasionally a failure a user is seeing may be related to a specific hook which is being run, perhaps without the user realizing. While the contents of hooks can be sensitive - containing user data or process information specific to the user's organization - simply knowing that a hook is being run at a certain stage can help us to understand whether something is going wrong. Without a definitive list of hook names within the code, we compile our own list from the documentation. This is likely prone to bitrot, but designing a single source of truth for acceptable hooks is too much overhead for this small change to the bugreport tool. Signed-off-by: Emily Shaffer Signed-off-by: Junio C Hamano

bugreport: add compiler info

2020-04-16T22:23:42Z

To help pinpoint the source of a regression, it is useful to know some info about the compiler which the user's Git client was built with. By adding a generic get_compiler_info() in 'compat/' we can choose which relevant information to share per compiler; to get started, let's demonstrate the version of glibc if the user built with 'gcc'. Signed-off-by: Emily Shaffer Helped-by: Đoàn Trần Công Danh Helped-by: Johannes Schindelin Signed-off-by: Junio C Hamano

bugreport: add uname info

2020-04-16T22:23:42Z

The contents of uname() can give us some insight into what sort of system the user is running on, and help us replicate their setup if need be. The domainname field is not guaranteed to be available, so don't collect it. Signed-off-by: Emily Shaffer Signed-off-by: Junio C Hamano

bugreport: gather git version and build info

2020-04-16T22:23:42Z

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 Signed-off-by: Junio C Hamano