pr-1310/vdye/scalar/generalize-diagnose-v3
tagged this
10 Aug 23:34
…-diagnose' As part of the preparation for moving Scalar out of 'contrib/' and into Git, this series moves the functionality of 'scalar diagnose' into a new builtin ('git diagnose') and a new option ('--diagnose') for 'git bugreport'. This change further aligns Scalar with the objective [1] of having it only contain functionality and settings that benefit large Git repositories, but not all repositories. The diagnostics reported by 'scalar diagnose' relevant for investigating issues in any Git repository, so generating them should be part of a "normal" Git builtin. The series is organized as follows: * Miscellaneous fixes for the existing 'scalar diagnose' implementation * Moving the code for generating diagnostics into a common location in the Git tree * Implementing 'git diagnose' * Implementing 'git bugreport --diagnose' * Updating the Scalar roadmap Finally, despite 'scalar diagnose' now being nothing more than a wrapper for 'git bugreport --diagnose', it is not being deprecated in this series. Although deprecation -> removal could be a future cleanup effort, 'scalar diagnose' is kept around for now as an alias for users already accustomed to using it in 'scalar'. Changes since V2 ================ * Replaced 'int include_everything' arg to 'create_diagnostic_archive()' with 'enum diagnose_mode mode'. * Replaced '--all' with configurable '--mode' option in 'git diagnose'; moved 'option_parse_diagnose()' into 'diagnose.c' so that it can be used for both 'git bugreport --diagnose' and 'git diagnose --mode'. * Split "builtin/diagnose.c: gate certain data behind '--all'" (formerly patch 7/10) into "diagnose.c: add option to configure archive contents" (patch 6/11) and "builtin/diagnose.c: add '--mode' option" (patch 8/11). * Added '--no-diagnose' for 'git bugreport'. I was initially going to use '--diagnose=none', but '--no-diagnose' was easier to configure when using the shared 'option_parse_diagnose()' function . * Updated usage strings, option descriptions, and documentation files for 'mode' option. To avoid needing to keep multiple lists of valid 'mode' values up-to-date, format mode value as <mode> everywhere except option description in 'git-diagnose.txt', where the values are listed. The documentation of '--diagnose' in 'git-bugreport.txt' links to 'git-diagnose.txt' and explicitly calls out that details on 'mode' can be found there. * Reworded 'git diagnose' and 'git bugreport' command & option documentation. * Added additional checks to 't0091-bugreport.sh' and 't0092-diagnose.sh' tests * Moved '#include "cache.h" from 'diagnose.h' to 'diagnose.c'. * Fixed '--output-directory' usage string in 'builtin/diagnose.c'. * Replaced 'die()' with 'die_errno()' in error triggered when leading directories of archive cannot be created. * Changed hardcoded '-1' error exit code in 'scalar diagnose' to returning the exit code from 'git diagnose --mode=all'. Changes since V1 ================ * Reorganized patches to fix minor issues (e.g., more gently adding directories to the archive) of 'scalar diagnose' in 'scalar.c', before the code is moved out of that file. * (Almost) entirely redesigned the UI for generating diagnostics. The new approach avoids cluttering 'git bugreport' with a mode that doesn't actually generate a report. Now, there are distinct options for different use cases: generating extra diagnostics with a bug report ('git bugreport --diagnose') and generating diagnostics for personal debugging/addition to an existing bug report ('git diagnose'). * Moved 'get_disk_info()' into 'compat/'. * Moved 'create_diagnostics_archive()' into a new 'diagnose.c', as it now has multiple callers. * Updated command & option documentation to more clearly guide users on how to use the new options. * Added the '--all' (and '--diagnose=all') option to change the default behavior of diagnostics generation to exclude '.git' directory contents. For many bug reporters, this would reveal private repository contents they don't want to expose to the public mailing list. This has the added benefit of creating much smaller archives by default, which will be more likely to successfully send to the mailing list. Thanks! * Victoria [1] https://lore.kernel.org/git/pull.1275.v2.git.1657584367.gitgitgadget@gmail.com/ Victoria Dye (11): scalar-diagnose: use "$GIT_UNZIP" in test scalar-diagnose: avoid 32-bit overflow of size_t scalar-diagnose: add directory to archiver more gently scalar-diagnose: move 'get_disk_info()' to 'compat/' scalar-diagnose: move functionality to common location diagnose.c: add option to configure archive contents builtin/diagnose.c: create 'git diagnose' builtin builtin/diagnose.c: add '--mode' option builtin/bugreport.c: create '--diagnose' option scalar-diagnose: use 'git diagnose --mode=all' scalar: update technical doc roadmap .gitignore | 1 + Documentation/git-bugreport.txt | 18 ++ Documentation/git-diagnose.txt | 65 +++++++ Documentation/technical/scalar.txt | 9 +- Makefile | 2 + builtin.h | 1 + builtin/bugreport.c | 27 ++- builtin/diagnose.c | 61 +++++++ compat/disk.h | 56 ++++++ contrib/scalar/scalar.c | 271 +---------------------------- contrib/scalar/t/t9099-scalar.sh | 8 +- diagnose.c | 254 +++++++++++++++++++++++++++ diagnose.h | 17 ++ git-compat-util.h | 1 + git.c | 1 + t/t0091-bugreport.sh | 48 +++++ t/t0092-diagnose.sh | 60 +++++++ 17 files changed, 622 insertions(+), 278 deletions(-) create mode 100644 Documentation/git-diagnose.txt create mode 100644 builtin/diagnose.c create mode 100644 compat/disk.h create mode 100644 diagnose.c create mode 100644 diagnose.h create mode 100755 t/t0092-diagnose.sh base-commit: 4af7188bc97f70277d0f10d56d5373022b1fa385 Submitted-As: https://lore.kernel.org/git/pull.1310.v3.git.1660174473.gitgitgadget@gmail.com In-Reply-To: https://lore.kernel.org/git/pull.1310.git.1659388498.gitgitgadget@gmail.com In-Reply-To: https://lore.kernel.org/git/pull.1310.v2.git.1659577543.gitgitgadget@gmail.com
Assets 2
-
2022-08-10T23:34:33Z -
2022-08-10T23:34:33Z - Loading