# [PATCH] Documentation: amended usages of various (sub)commands 12 messages from 2021-03-28 to 2021-03-29. Participants: Chinmoy via GitGitGadget, Bagas Sanjaya, Chinmoy Chakraborty, Junio C Hamano, Philip Oakley. Thread: https://gitlist.dev/t/55405 ## Chinmoy via GitGitGadget, 2021-03-28 06:34 Subject: [PATCH] Documentation: amended usages of various (sub)commands Message-ID: URL: https://gitlist.dev/e/pull.920.git.1616913298624.gitgitgadget%40gmail.com ``` From: Chinmoy Chakraborty The Git suite option parsing API's Technical Documentation suggests this about the option descriptions of a (sub)command: `description` is a short string to describe the effect of the option. It shall begin with a lower-case letter and a full stop (.) shall be omitted at the end. Various (sub)commands' option arrays don't follow the guideline provided by the parse_options Documentation regarding the descriptions. Signed-off-by: Chinmoy Chakraborty --- Documentation: amended usages of various (sub)commands The Git suite option parsing API's Technical Documentation suggests this about the option descriptions of a (sub)command: description is a short string to describe the effect of the option. It shall begin with a lower-case letter and a full stop (.) shall be omitted at the end. Various (sub)commands' option arrays don't follow the guideline provided by the parse_options Documentation regarding the descriptions. Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v1 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v1 Pull-Request: https://github.com/gitgitgadget/git/pull/920 builtin/column.c | 8 ++++---- builtin/range-diff.c | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/builtin/column.c b/builtin/column.c index e815e148aa18..40d4b3bee2dd 100644 --- a/builtin/column.c +++ b/builtin/column.c @@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix) OPT_STRING(0, "command", &real_command, N_("name"), N_("lookup config vars")), OPT_COLUMN(0, "mode", &colopts, N_("layout to use")), OPT_INTEGER(0, "raw-mode", &colopts, N_("layout to use")), - OPT_INTEGER(0, "width", &copts.width, N_("Maximum width")), - OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("Padding space on left border")), - OPT_INTEGER(0, "nl", &copts.nl, N_("Padding space on right border")), - OPT_INTEGER(0, "padding", &copts.padding, N_("Padding space between columns")), + OPT_INTEGER(0, "width", &copts.width, N_("maximum width")), + OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("padding space on left border")), + OPT_INTEGER(0, "nl", &copts.nl, N_("padding space on right border")), + OPT_INTEGER(0, "padding", &copts.padding, N_("padding space between columns")), OPT_END() }; diff --git a/builtin/range-diff.c b/builtin/range-diff.c index 78bc9fa77062..50318849d657 100644 --- a/builtin/range-diff.c +++ b/builtin/range-diff.c @@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix) struct option range_diff_options[] = { OPT_INTEGER(0, "creation-factor", &range_diff_opts.creation_factor, - N_("Percentage by which creation is weighted")), + N_("percentage by which creation is weighted")), OPT_BOOL(0, "no-dual-color", &simple_color, N_("use simple diff colors")), OPT_PASSTHRU_ARGV(0, "notes", &other_arg, base-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860 -- gitgitgadget ``` ## Bagas Sanjaya, 2021-03-28 06:56 Subject: Re: [PATCH] Documentation: amended usages of various (sub)commands Message-ID: URL: https://gitlist.dev/e/e85a653c-2650-313d-b5ca-5874559d9528%40gmail.com In-Reply-To: ``` On 28/03/21 13.34, Chinmoy via GitGitGadget wrote: > From: Chinmoy Chakraborty > > The Git suite option parsing API's Technical Documentation suggests this > about the option descriptions of a (sub)command: > > `description` is a short string to describe the effect of the option. > It shall begin with a lower-case letter and a full stop (.) shall be > omitted at the end. > > Various (sub)commands' option arrays don't follow the guideline provided > by the parse_options Documentation regarding the descriptions. > > Signed-off-by: Chinmoy Chakraborty > --- > Documentation: amended usages of various (sub)commands > > The Git suite option parsing API's Technical Documentation suggests this > about the option descriptions of a (sub)command: > > description is a short string to describe the effect of the option. It > shall begin with a lower-case letter and a full stop (.) shall be > omitted at the end. > > Various (sub)commands' option arrays don't follow the guideline provided > by the parse_options Documentation regarding the descriptions. > > Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com > > Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v1 > Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v1 > Pull-Request: https://github.com/gitgitgadget/git/pull/920 > > builtin/column.c | 8 ++++---- > builtin/range-diff.c | 2 +- > 2 files changed, 5 insertions(+), 5 deletions(-) > > diff --git a/builtin/column.c b/builtin/column.c > index e815e148aa18..40d4b3bee2dd 100644 > --- a/builtin/column.c > +++ b/builtin/column.c > @@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix) > OPT_STRING(0, "command", &real_command, N_("name"), N_("lookup config vars")), > OPT_COLUMN(0, "mode", &colopts, N_("layout to use")), > OPT_INTEGER(0, "raw-mode", &colopts, N_("layout to use")), > - OPT_INTEGER(0, "width", &copts.width, N_("Maximum width")), > - OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("Padding space on left border")), > - OPT_INTEGER(0, "nl", &copts.nl, N_("Padding space on right border")), > - OPT_INTEGER(0, "padding", &copts.padding, N_("Padding space between columns")), > + OPT_INTEGER(0, "width", &copts.width, N_("maximum width")), > + OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("padding space on left border")), > + OPT_INTEGER(0, "nl", &copts.nl, N_("padding space on right border")), > + OPT_INTEGER(0, "padding", &copts.padding, N_("padding space between columns")), > OPT_END() > }; > > diff --git a/builtin/range-diff.c b/builtin/range-diff.c > index 78bc9fa77062..50318849d657 100644 > --- a/builtin/range-diff.c > +++ b/builtin/range-diff.c > @@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix) > struct option range_diff_options[] = { > OPT_INTEGER(0, "creation-factor", > &range_diff_opts.creation_factor, > - N_("Percentage by which creation is weighted")), > + N_("percentage by which creation is weighted")), > OPT_BOOL(0, "no-dual-color", &simple_color, > N_("use simple diff colors")), > OPT_PASSTHRU_ARGV(0, "notes", &other_arg, > > base-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860 > Wait, I expected that this patch touches Documentation/* (as the title implied), but it seems like the patch content is something else (not related). Totally wrong patch submitted here. -- An old man doll... just what I always wanted! - Clara ``` ## Bagas Sanjaya, 2021-03-28 08:13 Subject: Re: [PATCH] Documentation: amended usages of various (sub)commands Message-ID: URL: https://gitlist.dev/e/de6d56b5-89e4-1e50-1011-0a9b9c46f4d9%40gmail.com In-Reply-To: ``` On 28/03/21 13.56, Bagas Sanjaya wrote: > On 28/03/21 13.34, Chinmoy via GitGitGadget wrote: >> From: Chinmoy Chakraborty >> >> The Git suite option parsing API's Technical Documentation suggests this >> about the option descriptions of a (sub)command: >> >> `description` is a short string to describe the effect of the option. >> It shall begin with a lower-case letter and a full stop (.) shall be >> omitted at the end. >> >> Various (sub)commands' option arrays don't follow the guideline provided >> by the parse_options Documentation regarding the descriptions. >> >> Signed-off-by: Chinmoy Chakraborty >> --- >>      Documentation: amended usages of various (sub)commands >>      The Git suite option parsing API's Technical Documentation suggests this >>      about the option descriptions of a (sub)command: >>      description is a short string to describe the effect of the option. It >>      shall begin with a lower-case letter and a full stop (.) shall be >>      omitted at the end. >>      Various (sub)commands' option arrays don't follow the guideline provided >>      by the parse_options Documentation regarding the descriptions. >>      Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com >> >> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v1 >> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v1 >> Pull-Request: https://github.com/gitgitgadget/git/pull/920 >> >>   builtin/column.c     | 8 ++++---- >>   builtin/range-diff.c | 2 +- >>   2 files changed, 5 insertions(+), 5 deletions(-) >> >> diff --git a/builtin/column.c b/builtin/column.c >> index e815e148aa18..40d4b3bee2dd 100644 >> --- a/builtin/column.c >> +++ b/builtin/column.c >> @@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix) >>           OPT_STRING(0, "command", &real_command, N_("name"), N_("lookup config vars")), >>           OPT_COLUMN(0, "mode", &colopts, N_("layout to use")), >>           OPT_INTEGER(0, "raw-mode", &colopts, N_("layout to use")), >> -        OPT_INTEGER(0, "width", &copts.width, N_("Maximum width")), >> -        OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("Padding space on left border")), >> -        OPT_INTEGER(0, "nl", &copts.nl, N_("Padding space on right border")), >> -        OPT_INTEGER(0, "padding", &copts.padding, N_("Padding space between columns")), >> +        OPT_INTEGER(0, "width", &copts.width, N_("maximum width")), >> +        OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("padding space on left border")), >> +        OPT_INTEGER(0, "nl", &copts.nl, N_("padding space on right border")), >> +        OPT_INTEGER(0, "padding", &copts.padding, N_("padding space between columns")), >>           OPT_END() >>       }; >> diff --git a/builtin/range-diff.c b/builtin/range-diff.c >> index 78bc9fa77062..50318849d657 100644 >> --- a/builtin/range-diff.c >> +++ b/builtin/range-diff.c >> @@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix) >>       struct option range_diff_options[] = { >>           OPT_INTEGER(0, "creation-factor", >>                   &range_diff_opts.creation_factor, >> -                N_("Percentage by which creation is weighted")), >> +                N_("percentage by which creation is weighted")), >>           OPT_BOOL(0, "no-dual-color", &simple_color, >>                   N_("use simple diff colors")), >>           OPT_PASSTHRU_ARGV(0, "notes", &other_arg, >> >> base-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860 >> > Wait, I expected that this patch touches Documentation/* (as the title implied), > but it seems like the patch content is something else (not related). > > Totally wrong patch submitted here. > Oops, I don't see that diff above. Sorry for that. What about this patch title below?: `Make (sub)command options conform to TD of option parsing` -- An old man doll... just what I always wanted! - Clara ``` ## Chinmoy Chakraborty, 2021-03-28 08:24 Subject: Re: [PATCH] Documentation: amended usages of various (sub)commands Message-ID: <2ccb53ea-e92d-f7ba-f480-467a0269548c@gmail.com> URL: https://gitlist.dev/e/2ccb53ea-e92d-f7ba-f480-467a0269548c%40gmail.com In-Reply-To: ``` On 3/28/21 1:43 PM, Bagas Sanjaya wrote: > Oops, I don't see that diff above. Sorry for that. That's fine :). > > What about this patch title below?: > > `Make (sub)command options conform to TD of option parsing` > Sure I'll update the title. Thanks for the suggestion. ``` ## Chinmoy via GitGitGadget, 2021-03-28 10:16 Subject: [PATCH v2] Documentation: make (sub)command options conform to TD of option parsing Message-ID: URL: https://gitlist.dev/e/pull.920.v2.git.1616926582735.gitgitgadget%40gmail.com In-Reply-To: ``` From: Chinmoy Chakraborty The Git suite option parsing API's Technical Documentation suggests this about the option descriptions of a (sub)command: `description` is a short string to describe the effect of the option. It shall begin with a lower-case letter and a full stop (.) shall be omitted at the end. Various (sub)commands' option arrays don't follow the guideline provided by the parse_options Documentation regarding the descriptions. Signed-off-by: Chinmoy Chakraborty --- Documentation: make (sub)command options conform to TD of option parsing The Git suite option parsing API's Technical Documentation suggests this about the option descriptions of a (sub)command: description is a short string to describe the effect of the option. It shall begin with a lower-case letter and a full stop (.) shall be omitted at the end. Various (sub)commands' option arrays don't follow the guideline provided by the parse_options Documentation regarding the descriptions. Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v2 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v2 Pull-Request: https://github.com/gitgitgadget/git/pull/920 Range-diff vs v1: 1: 817b25caa931 ! 1: b032c2fa5b28 Documentation: amended usages of various (sub)commands @@ Metadata Author: Chinmoy Chakraborty ## Commit message ## - Documentation: amended usages of various (sub)commands + Documentation: make (sub)command options conform to TD of option parsing The Git suite option parsing API's Technical Documentation suggests this about the option descriptions of a (sub)command: builtin/column.c | 8 ++++---- builtin/range-diff.c | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/builtin/column.c b/builtin/column.c index e815e148aa18..40d4b3bee2dd 100644 --- a/builtin/column.c +++ b/builtin/column.c @@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix) OPT_STRING(0, "command", &real_command, N_("name"), N_("lookup config vars")), OPT_COLUMN(0, "mode", &colopts, N_("layout to use")), OPT_INTEGER(0, "raw-mode", &colopts, N_("layout to use")), - OPT_INTEGER(0, "width", &copts.width, N_("Maximum width")), - OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("Padding space on left border")), - OPT_INTEGER(0, "nl", &copts.nl, N_("Padding space on right border")), - OPT_INTEGER(0, "padding", &copts.padding, N_("Padding space between columns")), + OPT_INTEGER(0, "width", &copts.width, N_("maximum width")), + OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("padding space on left border")), + OPT_INTEGER(0, "nl", &copts.nl, N_("padding space on right border")), + OPT_INTEGER(0, "padding", &copts.padding, N_("padding space between columns")), OPT_END() }; diff --git a/builtin/range-diff.c b/builtin/range-diff.c index 78bc9fa77062..50318849d657 100644 --- a/builtin/range-diff.c +++ b/builtin/range-diff.c @@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix) struct option range_diff_options[] = { OPT_INTEGER(0, "creation-factor", &range_diff_opts.creation_factor, - N_("Percentage by which creation is weighted")), + N_("percentage by which creation is weighted")), OPT_BOOL(0, "no-dual-color", &simple_color, N_("use simple diff colors")), OPT_PASSTHRU_ARGV(0, "notes", &other_arg, base-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860 -- gitgitgadget ``` ## Junio C Hamano, 2021-03-28 18:32 Subject: Re: [PATCH] Documentation: amended usages of various (sub)commands Message-ID: URL: https://gitlist.dev/e/xmqq35wfm8mt.fsf%40gitster.g In-Reply-To: ``` Bagas Sanjaya writes: >>> ... >> Wait, I expected that this patch touches Documentation/* (as the title implied), >> but it seems like the patch content is something else (not related). >> Totally wrong patch submitted here. Please learn to trim your quotes. > Oops, I don't see that diff above. Sorry for that. > > What about this patch title below?: > > `Make (sub)command options conform to TD of option parsing` "Make X conform" has low information contents (especially when nobody knows what the TD is), because nobody would try to make the code worse by making things nonconforming. Subject: [PATCH] column, range-diff: downcase option description It is customary not to begin the help text for each option given to the parse-options API with a capital letter. Downcase the first word of some option descriptions for "column" and "range-diff". or something like that? Even though the guideline for the documentation talks about two things (i.e. not starting with capital and omitting full-stop at the end), the help strings being touched by the patch only have problem with the former, so quoting the guideline in full would not help people understand what is changed and why. ``` ## Bagas Sanjaya, 2021-03-29 05:17 Subject: Re: [PATCH] Documentation: amended usages of various (sub)commands Message-ID: <6852d727-5ce8-0b9f-112e-e420c44227ce@gmail.com> URL: https://gitlist.dev/e/6852d727-5ce8-0b9f-112e-e420c44227ce%40gmail.com In-Reply-To: ``` On 29/03/21 01.32, Junio C Hamano wrote: >> What about this patch title below?: >> >> `Make (sub)command options conform to TD of option parsing` > > "Make X conform" has low information contents (especially when > nobody knows what the TD is), because nobody would try to make the > code worse by making things nonconforming. > > Subject: [PATCH] column, range-diff: downcase option description > > It is customary not to begin the help text for each option given to > the parse-options API with a capital letter. > > Downcase the first word of some option descriptions for "column" > and "range-diff". > > or something like that? That's what this patch intended to do (from the diff). -- An old man doll... just what I always wanted! - Clara ``` ## Chinmoy via GitGitGadget, 2021-03-29 10:45 Subject: [PATCH v3] column, range-diff: downcase option description Message-ID: URL: https://gitlist.dev/e/pull.920.v3.git.1617014753305.gitgitgadget%40gmail.com In-Reply-To: ``` From: Chinmoy Chakraborty It is customary not to begin the help text for each option given to the parse-options API with a capital letter.Various (sub)commands' option arrays don't follow the guideline provided by the parse_options Documentation regarding the descriptions. Downcase the first word of some option descriptions for "column" and "range-diff". Signed-off-by: Chinmoy Chakraborty --- column, range-diff: downcase option description It is customary not to begin the help text for each option given to the parse-options API with a capital letter.Various (sub)commands' option arrays don't follow the guideline provided by the parse_options Documentation regarding the descriptions. Downcase the first word of some option descriptions for "column" and "range-diff". Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v3 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v3 Pull-Request: https://github.com/gitgitgadget/git/pull/920 Range-diff vs v2: 1: b032c2fa5b28 ! 1: 61be08b7dd73 Documentation: make (sub)command options conform to TD of option parsing @@ Metadata Author: Chinmoy Chakraborty ## Commit message ## - Documentation: make (sub)command options conform to TD of option parsing + column, range-diff: downcase option description - The Git suite option parsing API's Technical Documentation suggests this - about the option descriptions of a (sub)command: + It is customary not to begin the help text for each option given to + the parse-options API with a capital letter.Various (sub)commands' + option arrays don't follow the guideline provided by the parse_options + Documentation regarding the descriptions. - `description` is a short string to describe the effect of the option. - It shall begin with a lower-case letter and a full stop (.) shall be - omitted at the end. - - Various (sub)commands' option arrays don't follow the guideline provided - by the parse_options Documentation regarding the descriptions. + Downcase the first word of some option descriptions for "column" + and "range-diff". Signed-off-by: Chinmoy Chakraborty builtin/column.c | 8 ++++---- builtin/range-diff.c | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/builtin/column.c b/builtin/column.c index e815e148aa18..40d4b3bee2dd 100644 --- a/builtin/column.c +++ b/builtin/column.c @@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix) OPT_STRING(0, "command", &real_command, N_("name"), N_("lookup config vars")), OPT_COLUMN(0, "mode", &colopts, N_("layout to use")), OPT_INTEGER(0, "raw-mode", &colopts, N_("layout to use")), - OPT_INTEGER(0, "width", &copts.width, N_("Maximum width")), - OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("Padding space on left border")), - OPT_INTEGER(0, "nl", &copts.nl, N_("Padding space on right border")), - OPT_INTEGER(0, "padding", &copts.padding, N_("Padding space between columns")), + OPT_INTEGER(0, "width", &copts.width, N_("maximum width")), + OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("padding space on left border")), + OPT_INTEGER(0, "nl", &copts.nl, N_("padding space on right border")), + OPT_INTEGER(0, "padding", &copts.padding, N_("padding space between columns")), OPT_END() }; diff --git a/builtin/range-diff.c b/builtin/range-diff.c index 78bc9fa77062..50318849d657 100644 --- a/builtin/range-diff.c +++ b/builtin/range-diff.c @@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix) struct option range_diff_options[] = { OPT_INTEGER(0, "creation-factor", &range_diff_opts.creation_factor, - N_("Percentage by which creation is weighted")), + N_("percentage by which creation is weighted")), OPT_BOOL(0, "no-dual-color", &simple_color, N_("use simple diff colors")), OPT_PASSTHRU_ARGV(0, "notes", &other_arg, base-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860 -- gitgitgadget ``` ## Bagas Sanjaya, 2021-03-29 10:58 Subject: Re: [PATCH v3] column, range-diff: downcase option description Message-ID: URL: https://gitlist.dev/e/eb3c37fe-45b1-6a25-c4c5-851dd88649bf%40gmail.com In-Reply-To: ``` On 29/03/21 17.45, Chinmoy via GitGitGadget wrote: > From: Chinmoy Chakraborty > > It is customary not to begin the help text for each option given to > the parse-options API with a capital letter.Various (sub)commands' > option arrays don't follow the guideline provided by the parse_options > Documentation regarding the descriptions. > > Downcase the first word of some option descriptions for "column" > and "range-diff". > > Signed-off-by: Chinmoy Chakraborty > --- > column, range-diff: downcase option description > > It is customary not to begin the help text for each option given to the > parse-options API with a capital letter.Various (sub)commands' option > arrays don't follow the guideline provided by the parse_options > Documentation regarding the descriptions. > > Downcase the first word of some option descriptions for "column" and > "range-diff". > > Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com > > Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v3 > Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v3 > Pull-Request: https://github.com/gitgitgadget/git/pull/920 > > Range-diff vs v2: > > 1: b032c2fa5b28 ! 1: 61be08b7dd73 Documentation: make (sub)command options conform to TD of option parsing > @@ Metadata > Author: Chinmoy Chakraborty > > ## Commit message ## > - Documentation: make (sub)command options conform to TD of option parsing > + column, range-diff: downcase option description > > - The Git suite option parsing API's Technical Documentation suggests this > - about the option descriptions of a (sub)command: > + It is customary not to begin the help text for each option given to > + the parse-options API with a capital letter.Various (sub)commands' > + option arrays don't follow the guideline provided by the parse_options > + Documentation regarding the descriptions. > > - `description` is a short string to describe the effect of the option. > - It shall begin with a lower-case letter and a full stop (.) shall be > - omitted at the end. > - > - Various (sub)commands' option arrays don't follow the guideline provided > - by the parse_options Documentation regarding the descriptions. > + Downcase the first word of some option descriptions for "column" > + and "range-diff". > > Signed-off-by: Chinmoy Chakraborty > > > > builtin/column.c | 8 ++++---- > builtin/range-diff.c | 2 +- > 2 files changed, 5 insertions(+), 5 deletions(-) > > diff --git a/builtin/column.c b/builtin/column.c > index e815e148aa18..40d4b3bee2dd 100644 > --- a/builtin/column.c > +++ b/builtin/column.c > @@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix) > OPT_STRING(0, "command", &real_command, N_("name"), N_("lookup config vars")), > OPT_COLUMN(0, "mode", &colopts, N_("layout to use")), > OPT_INTEGER(0, "raw-mode", &colopts, N_("layout to use")), > - OPT_INTEGER(0, "width", &copts.width, N_("Maximum width")), > - OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("Padding space on left border")), > - OPT_INTEGER(0, "nl", &copts.nl, N_("Padding space on right border")), > - OPT_INTEGER(0, "padding", &copts.padding, N_("Padding space between columns")), > + OPT_INTEGER(0, "width", &copts.width, N_("maximum width")), > + OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("padding space on left border")), > + OPT_INTEGER(0, "nl", &copts.nl, N_("padding space on right border")), > + OPT_INTEGER(0, "padding", &copts.padding, N_("padding space between columns")), > OPT_END() > }; > > diff --git a/builtin/range-diff.c b/builtin/range-diff.c > index 78bc9fa77062..50318849d657 100644 > --- a/builtin/range-diff.c > +++ b/builtin/range-diff.c > @@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix) > struct option range_diff_options[] = { > OPT_INTEGER(0, "creation-factor", > &range_diff_opts.creation_factor, > - N_("Percentage by which creation is weighted")), > + N_("percentage by which creation is weighted")), > OPT_BOOL(0, "no-dual-color", &simple_color, > N_("use simple diff colors")), > OPT_PASSTHRU_ARGV(0, "notes", &other_arg, > > base-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860 > Patch title and description match, looks OK. Reviewed-by: Bagas Sanjaya -- An old man doll... just what I always wanted! - Clara ``` ## Philip Oakley, 2021-03-29 13:46 Subject: Re: [PATCH v3] column, range-diff: downcase option description Message-ID: URL: https://gitlist.dev/e/bb5b4945-93f1-c0a9-5e7f-6b11525312f7%40iee.email In-Reply-To: ``` Super minor nit - missing space after full stop. On 29/03/2021 11:45, Chinmoy via GitGitGadget wrote: > From: Chinmoy Chakraborty > > It is customary not to begin the help text for each option given to > the parse-options API with a capital letter.Various (sub)commands' s/Various/ Various/ -- Philip > option arrays don't follow the guideline provided by the parse_options > Documentation regarding the descriptions. > > Downcase the first word of some option descriptions for "column" > and "range-diff". > > Signed-off-by: Chinmoy Chakraborty > --- > column, range-diff: downcase option description > > It is customary not to begin the help text for each option given to the > parse-options API with a capital letter.Various (sub)commands' option > arrays don't follow the guideline provided by the parse_options > Documentation regarding the descriptions. > > Downcase the first word of some option descriptions for "column" and > "range-diff". > > Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com > > Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v3 > Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v3 > Pull-Request: https://github.com/gitgitgadget/git/pull/920 > > Range-diff vs v2: > > 1: b032c2fa5b28 ! 1: 61be08b7dd73 Documentation: make (sub)command options conform to TD of option parsing > @@ Metadata > Author: Chinmoy Chakraborty > > ## Commit message ## > - Documentation: make (sub)command options conform to TD of option parsing > + column, range-diff: downcase option description > > - The Git suite option parsing API's Technical Documentation suggests this > - about the option descriptions of a (sub)command: > + It is customary not to begin the help text for each option given to > + the parse-options API with a capital letter.Various (sub)commands' > + option arrays don't follow the guideline provided by the parse_options > + Documentation regarding the descriptions. > > - `description` is a short string to describe the effect of the option. > - It shall begin with a lower-case letter and a full stop (.) shall be > - omitted at the end. > - > - Various (sub)commands' option arrays don't follow the guideline provided > - by the parse_options Documentation regarding the descriptions. > + Downcase the first word of some option descriptions for "column" > + and "range-diff". > > Signed-off-by: Chinmoy Chakraborty > > > > builtin/column.c | 8 ++++---- > builtin/range-diff.c | 2 +- > 2 files changed, 5 insertions(+), 5 deletions(-) > > diff --git a/builtin/column.c b/builtin/column.c > index e815e148aa18..40d4b3bee2dd 100644 > --- a/builtin/column.c > +++ b/builtin/column.c > @@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix) > OPT_STRING(0, "command", &real_command, N_("name"), N_("lookup config vars")), > OPT_COLUMN(0, "mode", &colopts, N_("layout to use")), > OPT_INTEGER(0, "raw-mode", &colopts, N_("layout to use")), > - OPT_INTEGER(0, "width", &copts.width, N_("Maximum width")), > - OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("Padding space on left border")), > - OPT_INTEGER(0, "nl", &copts.nl, N_("Padding space on right border")), > - OPT_INTEGER(0, "padding", &copts.padding, N_("Padding space between columns")), > + OPT_INTEGER(0, "width", &copts.width, N_("maximum width")), > + OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("padding space on left border")), > + OPT_INTEGER(0, "nl", &copts.nl, N_("padding space on right border")), > + OPT_INTEGER(0, "padding", &copts.padding, N_("padding space between columns")), > OPT_END() > }; > > diff --git a/builtin/range-diff.c b/builtin/range-diff.c > index 78bc9fa77062..50318849d657 100644 > --- a/builtin/range-diff.c > +++ b/builtin/range-diff.c > @@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix) > struct option range_diff_options[] = { > OPT_INTEGER(0, "creation-factor", > &range_diff_opts.creation_factor, > - N_("Percentage by which creation is weighted")), > + N_("percentage by which creation is weighted")), > OPT_BOOL(0, "no-dual-color", &simple_color, > N_("use simple diff colors")), > OPT_PASSTHRU_ARGV(0, "notes", &other_arg, > > base-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860 ``` ## Chinmoy via GitGitGadget, 2021-03-29 14:46 Subject: [PATCH v4] column, range-diff: downcase option description Message-ID: URL: https://gitlist.dev/e/pull.920.v4.git.1617029194872.gitgitgadget%40gmail.com In-Reply-To: ``` From: Chinmoy Chakraborty It is customary not to begin the help text for each option given to the parse-options API with a capital letter. Various (sub)commands' option arrays don't follow the guideline provided by the parse_options Documentation regarding the descriptions. Downcase the first word of some option descriptions for "column" and "range-diff". Signed-off-by: Chinmoy Chakraborty --- column, range-diff: downcase option description It is customary not to begin the help text for each option given to the parse-options API with a capital letter.Various (sub)commands' option arrays don't follow the guideline provided by the parse_options Documentation regarding the descriptions. Downcase the first word of some option descriptions for "column" and "range-diff". Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v4 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v4 Pull-Request: https://github.com/gitgitgadget/git/pull/920 Range-diff vs v3: 1: 61be08b7dd73 ! 1: 286668a91cb9 column, range-diff: downcase option description @@ Commit message column, range-diff: downcase option description It is customary not to begin the help text for each option given to - the parse-options API with a capital letter.Various (sub)commands' + the parse-options API with a capital letter. Various (sub)commands' option arrays don't follow the guideline provided by the parse_options Documentation regarding the descriptions. builtin/column.c | 8 ++++---- builtin/range-diff.c | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/builtin/column.c b/builtin/column.c index e815e148aa18..40d4b3bee2dd 100644 --- a/builtin/column.c +++ b/builtin/column.c @@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix) OPT_STRING(0, "command", &real_command, N_("name"), N_("lookup config vars")), OPT_COLUMN(0, "mode", &colopts, N_("layout to use")), OPT_INTEGER(0, "raw-mode", &colopts, N_("layout to use")), - OPT_INTEGER(0, "width", &copts.width, N_("Maximum width")), - OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("Padding space on left border")), - OPT_INTEGER(0, "nl", &copts.nl, N_("Padding space on right border")), - OPT_INTEGER(0, "padding", &copts.padding, N_("Padding space between columns")), + OPT_INTEGER(0, "width", &copts.width, N_("maximum width")), + OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("padding space on left border")), + OPT_INTEGER(0, "nl", &copts.nl, N_("padding space on right border")), + OPT_INTEGER(0, "padding", &copts.padding, N_("padding space between columns")), OPT_END() }; diff --git a/builtin/range-diff.c b/builtin/range-diff.c index 78bc9fa77062..50318849d657 100644 --- a/builtin/range-diff.c +++ b/builtin/range-diff.c @@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix) struct option range_diff_options[] = { OPT_INTEGER(0, "creation-factor", &range_diff_opts.creation_factor, - N_("Percentage by which creation is weighted")), + N_("percentage by which creation is weighted")), OPT_BOOL(0, "no-dual-color", &simple_color, N_("use simple diff colors")), OPT_PASSTHRU_ARGV(0, "notes", &other_arg, base-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860 -- gitgitgadget ``` ## Junio C Hamano, 2021-03-29 21:05 Subject: Re: [PATCH v4] column, range-diff: downcase option description Message-ID: URL: https://gitlist.dev/e/xmqqmtulisbn.fsf%40gitster.g In-Reply-To: ``` "Chinmoy via GitGitGadget" writes: > From: Chinmoy Chakraborty > > It is customary not to begin the help text for each option given to > the parse-options API with a capital letter. Various (sub)commands' > option arrays don't follow the guideline provided by the parse_options > Documentation regarding the descriptions. > > Downcase the first word of some option descriptions for "column" > and "range-diff". > > Signed-off-by: Chinmoy Chakraborty > --- Thanks, Chinmoy, Bagas and Philip. Will queue. ```