From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>,
"Eric Sunshine" <sunshine@sunshineco.com>,
"SZEDER Gábor" <szeder.dev@gmail.com>,
"Philippe Blain" <levraiphilippeblain@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH v2 0/9] help: tests, parse_options() sanity, fix "help -g" regression
Date: Mon, 21 Feb 2022 20:38:43 +0100 [thread overview]
Message-ID: <cover-v2-0.9-00000000000-20220221T193708Z-avarab@gmail.com> (raw)
In-Reply-To: <cover-0.7-00000000000-20211228T153456Z-avarab@gmail.com>
A late re-roll of [1] which addresses all the comments Eric Sunshine
raised, thanks for the review, and sorry the v2 took so long!
As the range-diff shows the main change is a mid-series set of changes
to sanity check more "git help <opts>" incompaitibilities. The
SYNOPSIS issues etc. Eric noted have also been fixed.
1. https://lore.kernel.org/git/cover-0.7-00000000000-20211228T153456Z-avarab@gmail.com/
Ævar Arnfjörð Bjarmason (9):
help doc: add missing "]" to "[-a|--all]"
help.c: use puts() instead of printf{,_ln}() for consistency
help tests: test "git" and "git help [-a|-g] spacing
help.c: split up list_all_cmds_help() function
help: note the option name on option incompatibility
help: correct usage & behavior of "git help --all"
help: error if [-a|-g|-c] and [-i|-m|-w] are combined
help: add --no-[external-commands|aliases] for use with --all
help: don't print "\n" before single-section output
Documentation/git-help.txt | 15 ++++--
builtin/help.c | 63 +++++++++++++++++++++----
help.c | 37 +++++++++++----
help.h | 2 +-
t/t0012-help.sh | 94 ++++++++++++++++++++++++++++++++++++++
5 files changed, 187 insertions(+), 24 deletions(-)
Range-diff against v1:
1: 652dae26bf4 = 1: c4b66c36c17 help doc: add missing "]" to "[-a|--all]"
2: f84662469a3 = 2: 124643c4b35 help.c: use puts() instead of printf{,_ln}() for consistency
3: 3956937cf3b ! 3: 3e39116f197 help tests: test "git" and "git help [-a|-g] spacing
@@ t/t0012-help.sh: test_expect_success 'git help --config-sections-for-completion'
+'
+
test_expect_success 'generate builtin list' '
+ mkdir -p sub &&
git --list-cmds=builtins >builtins
- '
4: f040dd549b4 = 4: f9c4d5e2d28 help.c: split up list_all_cmds_help() function
5: 12ff152bd57 < -: ----------- help: error if [-a|-g|-c] and [-i|-m|-w] are combined
-: ----------- > 5: e5c49089106 help: note the option name on option incompatibility
-: ----------- > 6: 868e8a6cf83 help: correct usage & behavior of "git help --all"
-: ----------- > 7: 992ee6580ac help: error if [-a|-g|-c] and [-i|-m|-w] are combined
6: a5ef9f69530 ! 8: c81c0cbbcdb help: add --no-[external-commands|aliases] for use with --all
@@ Documentation/git-help.txt: git-help - Display help information about Git
--------
[verse]
-'git help' [-a|--all] [--[no-]verbose]
-+'git help' [-a|--all] [--[no-]verbose] [--[no-](external-commands|aliases)]
++'git help' [-a|--all] [--[no-]verbose] [--[no-]external-commands] [--[no-]aliases]
'git help' [[-i|--info] [-m|--man] [-w|--web]] [<command>|<guide>]
'git help' [-g|--guides]
'git help' [-c|--config]
@@ Documentation/git-help.txt: OPTIONS
- Prints all the available commands on the standard output. This
- option overrides any given command or guide name.
+ --all::
+ Prints all the available commands on the standard output.
+--no-external-commands::
+ When used with `--all`, exclude the listing of external "git-*"
@@ builtin/help.c: static const char *html_path;
OPT_CMDMODE('a', "all", &cmd_mode, N_("print all available commands"),
HELP_ACTION_ALL),
+ OPT_BOOL(0, "external-commands", &show_external_commands,
-+ N_("show external commands in --all?")),
-+ OPT_BOOL(0, "aliases", &show_aliases, N_("show aliases in --all?")),
++ N_("show external commands in --all")),
++ OPT_BOOL(0, "aliases", &show_aliases, N_("show aliases in --all")),
OPT_HIDDEN_BOOL(0, "exclude-guides", &exclude_guides, N_("exclude guides")),
OPT_SET_INT('m', "man", &help_format, N_("show man page"), HELP_FORMAT_MAN),
OPT_SET_INT('w', "web", &help_format, N_("show manual in web browser"),
@@ builtin/help.c: static struct option builtin_help_options[] = {
static const char * const builtin_help_usage[] = {
- N_("git help [-a|--all] [--[no-]verbose]]"),
-+ N_("git help [-a|--all] [--[no-]verbose]] [--[no-](external-commands|aliases)]"),
++ N_("git help [-a|--all] [--[no-]verbose]] [--[no-]external-commands] [--[no-]aliases]"),
N_("git help [[-i|--info] [-m|--man] [-w|--web]] [<command>]"),
N_("git help [-g|--guides]"),
N_("git help [-c|--config]"),
@@ builtin/help.c: int cmd_help(int argc, const char **argv, const char *prefix)
+
switch (cmd_mode) {
case HELP_ACTION_ALL:
- no_format();
+ opt_mode_usage(argc, "--all", help_format);
if (verbose) {
setup_pager();
- list_all_cmds_help();
7: 08fd12fe7b4 = 9: 08dc693dc3e help: don't print "\n" before single-section output
--
2.35.1.1132.ga1fe46f8690
next prev parent reply other threads:[~2022-02-21 19:39 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-28 15:35 [PATCH 0/7] help: test and fix small "help -g" regression Ævar Arnfjörð Bjarmason
2021-12-28 15:35 ` [PATCH 1/7] help doc: add missing "]" to "[-a|--all]" Ævar Arnfjörð Bjarmason
2021-12-28 15:35 ` [PATCH 2/7] help.c: use puts() instead of printf{,_ln}() for consistency Ævar Arnfjörð Bjarmason
2021-12-28 15:35 ` [PATCH 3/7] help tests: test "git" and "git help [-a|-g] spacing Ævar Arnfjörð Bjarmason
2021-12-28 15:35 ` [PATCH 4/7] help.c: split up list_all_cmds_help() function Ævar Arnfjörð Bjarmason
2021-12-28 15:35 ` [PATCH 5/7] help: error if [-a|-g|-c] and [-i|-m|-w] are combined Ævar Arnfjörð Bjarmason
2021-12-28 16:18 ` Eric Sunshine
2021-12-29 0:04 ` Ævar Arnfjörð Bjarmason
2021-12-28 15:35 ` [PATCH 6/7] help: add --no-[external-commands|aliases] for use with --all Ævar Arnfjörð Bjarmason
2021-12-28 16:28 ` Eric Sunshine
2021-12-28 15:35 ` [PATCH 7/7] help: don't print "\n" before single-section output Ævar Arnfjörð Bjarmason
2022-02-21 19:38 ` Ævar Arnfjörð Bjarmason [this message]
2022-02-21 19:38 ` [PATCH v2 1/9] help doc: add missing "]" to "[-a|--all]" Ævar Arnfjörð Bjarmason
2022-02-21 19:38 ` [PATCH v2 2/9] help.c: use puts() instead of printf{,_ln}() for consistency Ævar Arnfjörð Bjarmason
2022-02-23 21:51 ` Junio C Hamano
2022-02-23 21:57 ` Ævar Arnfjörð Bjarmason
2022-02-21 19:38 ` [PATCH v2 3/9] help tests: test "git" and "git help [-a|-g] spacing Ævar Arnfjörð Bjarmason
2022-02-21 19:38 ` [PATCH v2 4/9] help.c: split up list_all_cmds_help() function Ævar Arnfjörð Bjarmason
2022-02-23 22:03 ` Junio C Hamano
2022-02-21 19:38 ` [PATCH v2 5/9] help: note the option name on option incompatibility Ævar Arnfjörð Bjarmason
2022-02-23 22:04 ` Junio C Hamano
2022-02-21 19:38 ` [PATCH v2 6/9] help: correct usage & behavior of "git help --all" Ævar Arnfjörð Bjarmason
2022-02-23 22:12 ` Junio C Hamano
2022-02-21 19:38 ` [PATCH v2 7/9] help: error if [-a|-g|-c] and [-i|-m|-w] are combined Ævar Arnfjörð Bjarmason
2022-02-23 22:16 ` Junio C Hamano
2022-02-21 19:38 ` [PATCH v2 8/9] help: add --no-[external-commands|aliases] for use with --all Ævar Arnfjörð Bjarmason
2022-02-23 22:19 ` Junio C Hamano
2022-02-21 19:38 ` [PATCH v2 9/9] help: don't print "\n" before single-section output Ævar Arnfjörð Bjarmason
2022-02-23 22:31 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cover-v2-0.9-00000000000-20220221T193708Z-avarab@gmail.com \
--to=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=levraiphilippeblain@gmail.com \
--cc=pclouds@gmail.com \
--cc=sunshine@sunshineco.com \
--cc=szeder.dev@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).