[v12,0/5] bugreport: add tool to generate debugging info

Message

Emily Shaffer April 6, 2020, 10:45 p.m. UTC

Since v11, reordered tests per SZEDER's comment so that the
test_when_finished lines come first in each test.

Emily Shaffer (5):
  help: move list_config_help to builtin/help
  bugreport: add tool to generate debugging info
  bugreport: gather git version and build info
  bugreport: add uname info
  bugreport: add compiler info

 .gitignore                      |   2 +
 Documentation/git-bugreport.txt |  52 ++++++++++++
 Makefile                        |  18 +++-
 bugreport.c                     | 142 ++++++++++++++++++++++++++++++++
 builtin/help.c                  |  86 +++++++++++++++++++
 command-list.txt                |   1 +
 compat/compiler.h               |  41 +++++++++
 generate-cmdlist.sh             |  19 -----
 generate-configlist.sh          |  21 +++++
 help.c                          | 131 +++++++----------------------
 help.h                          |   2 +-
 strbuf.c                        |   4 +
 strbuf.h                        |   1 +
 t/t0091-bugreport.sh            |  61 ++++++++++++++
 14 files changed, 455 insertions(+), 126 deletions(-)
 create mode 100644 Documentation/git-bugreport.txt
 create mode 100644 bugreport.c
 create mode 100644 compat/compiler.h
 create mode 100755 generate-configlist.sh
 create mode 100755 t/t0091-bugreport.sh

Comments

Junio C Hamano April 7, 2020, 3:24 p.m. UTC | #1

Emily Shaffer <[e-mail]> writes:

> Since v11, reordered tests per SZEDER's comment so that the
> test_when_finished lines come first in each test.
>
> Emily Shaffer (5):
>   help: move list_config_help to builtin/help
>   bugreport: add tool to generate debugging info
>   bugreport: gather git version and build info
>   bugreport: add uname info
>   bugreport: add compiler info

Overall it was a pleasnt read.

Just to avoid misunderstanding, those comments in which I envisioned
a way to report versions and attributes on different parts of "git"
(and I expect we'd be reporting versions and add-ons to tools like
'wish' that runs gitk and git-gui, 'perl' and 'python' in a similar
way---by finding them on the $PATH and asking them who they are) are
NOT "without these, the bugreport tool would not be useful", but "we
will in time need these, so let's keep them in mind" issues [*1*].

So, I am hoping that this is ready to move to 'next'.

Thanks.


[Footnote]

*1* What we saw here in the review showed us a very good starting
point to report the version of the source one binary was built from,
and the compiler and library that binary was built with, and various
attributes of the system that is running that binary.  Thanks to
step [1/5], these helper functions can also be linked to help other
parts of "git" (like the transport) report the first two (some code
may further need to be moved so that they can be called from the
built-ins and standalones).  The system that the binary is running
on would be the same anyway, so there is no need to duplicate that
part of the report.