From: Bagas Sanjaya Date: Sun, 28 Mar 2021 08:13:54 GMT Subject: Re: [PATCH] Documentation: amended usages of various (sub)commands Message-ID: 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