From: "Abhradeep Chakraborty via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Johannes Schindelin" <Johannes.Schindelin@gmx.de>,
"Julia Lawall" <julia.lawall@inria.fr>,
"Eric Sunshine" <sunshine@sunshineco.com>,
"Abhradeep Chakraborty" <chakrabortyabhradeep79@gmail.com>
Subject: [PATCH v3 0/2] add usage-strings ci check and amend remaining usage strings
Date: Wed, 23 Feb 2022 14:27:33 +0000 [thread overview]
Message-ID: <pull.1147.v3.git.1645626455.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1147.v2.git.1645545507689.gitgitgadget@gmail.com>
This patch series completely fixes #636.
The issue is about amending the usage-strings (for command flags such as -h,
-v etc.) which do not follow the style convention/guide. There was a PR
[https://github.com/gitgitgadget/git/pull/920] addressing this issue but as
Johannes [https://github.com/dscho] said in his comment
[https://github.com/gitgitgadget/git/issues/636#issuecomment-1018660439],
there are some files that still have those kind of usage strings. Johannes
also suggested to add a CI check under ci/test-documentation.sh to check the
usage strings.
In this version, the previously single commit is split into two commits (
one addressing amending of usage strings and another is for adding the style
checks to parse_options_check()) and the checks are simplified.
Changes since v1:
1. remove check-usage-strings.sh
2. remove CI check
3. add checks to parse-options.c
4. modify t/t1502-rev-parse-parseopt.sh to pass the test
Until v1:
A shell script check-usage-strings.sh was introduced to check the
usage-strings. CI check for the same was also introduced.
Abhra303 (1):
amend remaining usage strings according to style guide
Abhradeep Chakraborty (1):
parse-options.c: add style checks for usage-strings
builtin/bisect--helper.c | 2 +-
builtin/reflog.c | 6 +++---
builtin/submodule--helper.c | 2 +-
diff.c | 2 +-
parse-options.c | 6 ++++++
t/helper/test-run-command.c | 6 +++---
t/t1502-rev-parse-parseopt.sh | 4 ++--
7 files changed, 17 insertions(+), 11 deletions(-)
base-commit: e6ebfd0e8cbbd10878070c8a356b5ad1b3ca464e
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1147%2FAbhra303%2Fusage_command_amend-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1147/Abhra303/usage_command_amend-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/1147
Range-diff vs v2:
1: 902937e768d ! 1: f425e36b7ea add usage-strings check and amend remaining usage strings
@@ Metadata
Author: Abhra303 <chakrabortyabhradeep79@gmail.com>
## Commit message ##
- add usage-strings check and amend remaining usage strings
+ amend remaining usage strings according to style guide
Usage strings for git (sub)command flags has a style guide that
- suggests - first letter should not capitalized (unless requied)
+ suggests - first letter should not capitalized (unless required)
and it should skip full-stop at the end of line. But there are
some files where usage-strings do not follow the above mentioned
- guide. Moreover, there are no checks to verify if all usage strings
- are following the guide/convention or not.
+ guide.
- Amend the usage strings that don't follow the convention/guide and
- add a check in the `parse_options_check()` function in `parse-options.c`
- to check the usage strings against the style guide.
+ Amend the usage strings that don't follow the style convention/guide.
Signed-off-by: Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com>
@@ diff.c: static void prep_parse_options(struct diff_options *options)
OPT_END()
- ## parse-options.c ##
-@@ parse-options.c: static void parse_options_check(const struct option *opts)
- default:
- ; /* ok. (usually accepts an argument) */
- }
-+ if (opts->type != OPTION_GROUP && opts->help &&
-+ !(starts_with(opts->help, "HEAD") ||
-+ starts_with(opts->help, "GPG") ||
-+ starts_with(opts->help, "DEPRECATED") ||
-+ starts_with(opts->help, "SHA1")) &&
-+ (opts->help[0] >= 65 && opts->help[0] <= 90))
-+ err |= optbug(opts, xstrfmt("help should not start with capital letter unless needed: %s", opts->help));
-+ if (opts->help && !ends_with(opts->help, "...") && ends_with(opts->help, "."))
-+ err |= optbug(opts, xstrfmt("help should not end with a dot: %s", opts->help));
- if (opts->argh &&
- strcspn(opts->argh, " _") != strlen(opts->argh))
- err |= optbug(opts, "multi-word argh should use dash to separate words");
-
## t/helper/test-run-command.c ##
@@ t/helper/test-run-command.c: static int quote_stress_test(int argc, const char **argv)
struct strbuf out = STRBUF_INIT;
@@ t/helper/test-run-command.c: static int quote_stress_test(int argc, const char *
OPT_END()
};
const char * const usage[] = {
-
- ## t/t1502-rev-parse-parseopt.sh ##
-@@ t/t1502-rev-parse-parseopt.sh: test_expect_success 'setup optionspec-only-hidden-switches' '
- |
- |some-command does foo and bar!
- |--
--|hidden1* A hidden switch
-+|hidden1* a hidden switch
- EOF
- '
-
-@@ t/t1502-rev-parse-parseopt.sh: test_expect_success 'test --parseopt help-all output hidden switches' '
- |
- | some-command does foo and bar!
- |
--| --hidden1 A hidden switch
-+| --hidden1 a hidden switch
- |
- |EOF
- END_EXPECT
-: ----------- > 2: 9d42bdbff6c parse-options.c: add style checks for usage-strings
--
gitgitgadget
next prev parent reply other threads:[~2022-02-23 14:27 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-02-16 17:02 [PATCH] add usage-strings ci check and amend remaining usage strings Abhradeep Chakraborty via GitGitGadget
2022-02-21 14:51 ` Abhradeep Chakraborty
2022-02-21 15:39 ` Ævar Arnfjörð Bjarmason
2022-02-21 17:15 ` Junio C Hamano
2022-02-21 17:33 ` Abhradeep Chakraborty
2022-02-21 18:52 ` Ævar Arnfjörð Bjarmason
2022-02-22 10:57 ` Johannes Schindelin
2022-02-22 12:37 ` Ævar Arnfjörð Bjarmason
2022-02-22 13:42 ` [cocci] " Julia Lawall
2022-02-22 14:03 ` Abhradeep Chakraborty
2022-02-22 15:47 ` Abhradeep Chakraborty
2022-02-25 15:30 ` Johannes Schindelin
2022-02-25 16:16 ` Ævar Arnfjörð Bjarmason
2022-02-26 4:22 ` Abhradeep Chakraborty
2022-02-26 8:55 ` Julia Lawall
2022-02-25 15:03 ` [cocci] " Johannes Schindelin
2022-02-25 15:36 ` Julia Lawall
2022-02-25 16:28 ` Ævar Arnfjörð Bjarmason
2022-02-22 10:25 ` Abhradeep Chakraborty
2022-02-22 15:58 ` [PATCH v2] add usage-strings " Abhradeep Chakraborty via GitGitGadget
2022-02-22 17:16 ` Eric Sunshine
2022-02-23 11:59 ` Abhradeep Chakraborty
2022-02-23 21:17 ` Junio C Hamano
2022-02-23 21:20 ` Eric Sunshine
2022-02-24 6:26 ` Abhradeep Chakraborty
2022-02-23 14:27 ` Abhradeep Chakraborty via GitGitGadget [this message]
2022-02-23 14:27 ` [PATCH v3 1/2] amend remaining usage strings according to style guide Abhra303 via GitGitGadget
2022-02-23 14:27 ` [PATCH v3 2/2] parse-options.c: add style checks for usage-strings Abhradeep Chakraborty via GitGitGadget
2022-02-25 5:23 ` [PATCH v4 0/2] add usage-strings ci check and amend remaining usage strings Abhradeep Chakraborty via GitGitGadget
2022-02-25 5:23 ` [PATCH v4 1/2] amend remaining usage strings according to style guide Abhradeep Chakraborty via GitGitGadget
2022-02-25 5:23 ` [PATCH v4 2/2] parse-options.c: add style checks for usage-strings Abhradeep Chakraborty via GitGitGadget
2022-02-25 6:13 ` Junio C Hamano
2022-02-25 8:08 ` Abhradeep Chakraborty
2022-02-25 17:06 ` Junio C Hamano
2022-02-26 3:57 ` Abhradeep Chakraborty
2022-02-25 15:36 ` Johannes Schindelin
2022-02-25 16:01 ` Abhradeep Chakraborty
2022-02-26 1:36 ` Junio C Hamano
2022-02-26 6:08 ` Junio C Hamano
2022-02-26 6:57 ` Abhradeep Chakraborty
2022-02-27 19:15 ` Junio C Hamano
2022-02-28 7:39 ` Abhradeep Chakraborty
2022-02-28 17:48 ` Junio C Hamano
2022-02-28 19:32 ` Ævar Arnfjörð Bjarmason
2022-03-01 6:38 ` Abhradeep Chakraborty
2022-03-01 11:12 ` Junio C Hamano
2022-03-01 19:37 ` Johannes Schindelin
2022-03-03 17:34 ` Abhradeep Chakraborty
2022-03-03 22:30 ` Junio C Hamano
2022-03-04 14:21 ` Abhradeep Chakraborty
2022-03-07 16:12 ` Johannes Schindelin
2022-03-08 5:44 ` Abhradeep Chakraborty
2022-03-01 20:08 ` [PATCH] parse-options: make parse_options_check() test-only Junio C Hamano
2022-03-01 21:57 ` Ævar Arnfjörð Bjarmason
2022-03-01 22:18 ` Junio C Hamano
2022-03-02 10:52 ` Ævar Arnfjörð Bjarmason
2022-03-02 18:59 ` Junio C Hamano
2022-03-02 19:17 ` Ævar Arnfjörð Bjarmason
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=pull.1147.v3.git.1645626455.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=avarab@gmail.com \
--cc=chakrabortyabhradeep79@gmail.com \
--cc=git@vger.kernel.org \
--cc=julia.lawall@inria.fr \
--cc=sunshine@sunshineco.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.
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 NNTP newsgroup(s).