{"thread":{"id":"55405","subject":"[PATCH] Documentation: amended usages of various (sub)commands","startedAt":"2021-03-28T06:35:37Z","lastAt":"2021-03-29T21:06:37Z","messageCount":12,"participants":["Chinmoy via GitGitGadget","Bagas Sanjaya","Chinmoy Chakraborty","Junio C Hamano","Philip Oakley"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"420365","messageId":"pull.920.git.1616913298624.gitgitgadget@gmail.com","threadId":"55405","inReplyTo":null,"subject":"[PATCH] Documentation: amended usages of various (sub)commands","fromName":"Chinmoy via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2021-03-28T06:34:58Z","receivedAt":"2021-03-28T06:35:37Z","isPatch":true,"sender":{"key":"name:Chinmoy","avatar":null},"body":"From: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n\nThe Git suite option parsing API's Technical Documentation suggests this\nabout the option descriptions of a (sub)command:\n\n`description` is a short string to describe the effect of the option.\nIt shall begin with a lower-case letter and a full stop (.) shall be\nomitted at the end.\n\nVarious (sub)commands' option arrays don't follow the guideline provided\nby the parse_options Documentation regarding the descriptions.\n\nSigned-off-by: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n---\n    Documentation: amended usages of various (sub)commands\n    \n    The Git suite option parsing API's Technical Documentation suggests this\n    about the option descriptions of a (sub)command:\n    \n    description is a short string to describe the effect of the option. It\n    shall begin with a lower-case letter and a full stop (.) shall be\n    omitted at the end.\n    \n    Various (sub)commands' option arrays don't follow the guideline provided\n    by the parse_options Documentation regarding the descriptions.\n    \n    Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/920\n\n builtin/column.c     | 8 ++++----\n builtin/range-diff.c | 2 +-\n 2 files changed, 5 insertions(+), 5 deletions(-)\n\ndiff --git a/builtin/column.c b/builtin/column.c\nindex e815e148aa18..40d4b3bee2dd 100644\n--- a/builtin/column.c\n+++ b/builtin/column.c\n@@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix)\n \t\tOPT_STRING(0, \"command\", &real_command, N_(\"name\"), N_(\"lookup config vars\")),\n \t\tOPT_COLUMN(0, \"mode\", &colopts, N_(\"layout to use\")),\n \t\tOPT_INTEGER(0, \"raw-mode\", &colopts, N_(\"layout to use\")),\n-\t\tOPT_INTEGER(0, \"width\", &copts.width, N_(\"Maximum width\")),\n-\t\tOPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"Padding space on left border\")),\n-\t\tOPT_INTEGER(0, \"nl\", &copts.nl, N_(\"Padding space on right border\")),\n-\t\tOPT_INTEGER(0, \"padding\", &copts.padding, N_(\"Padding space between columns\")),\n+\t\tOPT_INTEGER(0, \"width\", &copts.width, N_(\"maximum width\")),\n+\t\tOPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"padding space on left border\")),\n+\t\tOPT_INTEGER(0, \"nl\", &copts.nl, N_(\"padding space on right border\")),\n+\t\tOPT_INTEGER(0, \"padding\", &copts.padding, N_(\"padding space between columns\")),\n \t\tOPT_END()\n \t};\n \ndiff --git a/builtin/range-diff.c b/builtin/range-diff.c\nindex 78bc9fa77062..50318849d657 100644\n--- a/builtin/range-diff.c\n+++ b/builtin/range-diff.c\n@@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix)\n \tstruct option range_diff_options[] = {\n \t\tOPT_INTEGER(0, \"creation-factor\",\n \t\t\t    &range_diff_opts.creation_factor,\n-\t\t\t    N_(\"Percentage by which creation is weighted\")),\n+\t\t\t    N_(\"percentage by which creation is weighted\")),\n \t\tOPT_BOOL(0, \"no-dual-color\", &simple_color,\n \t\t\t    N_(\"use simple diff colors\")),\n \t\tOPT_PASSTHRU_ARGV(0, \"notes\", &other_arg,\n\nbase-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860\n-- \ngitgitgadget\n"},{"id":"420368","messageId":"e85a653c-2650-313d-b5ca-5874559d9528@gmail.com","threadId":"55405","inReplyTo":"pull.920.git.1616913298624.gitgitgadget@gmail.com","subject":"Re: [PATCH] Documentation: amended usages of various (sub)commands","fromName":"Bagas Sanjaya","fromEmail":"bagasdotme@gmail.com","sentAt":"2021-03-28T06:56:04Z","receivedAt":"2021-03-28T07:02:13Z","isPatch":true,"sender":{"key":"bagasdotme@gmail.com","avatar":"https://avatars.githubusercontent.com/u/40219486?v=4"},"body":"On 28/03/21 13.34, Chinmoy via GitGitGadget wrote:\n> From: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n> \n> The Git suite option parsing API's Technical Documentation suggests this\n> about the option descriptions of a (sub)command:\n> \n> `description` is a short string to describe the effect of the option.\n> It shall begin with a lower-case letter and a full stop (.) shall be\n> omitted at the end.\n> \n> Various (sub)commands' option arrays don't follow the guideline provided\n> by the parse_options Documentation regarding the descriptions.\n> \n> Signed-off-by: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n> ---\n>      Documentation: amended usages of various (sub)commands\n>      \n>      The Git suite option parsing API's Technical Documentation suggests this\n>      about the option descriptions of a (sub)command:\n>      \n>      description is a short string to describe the effect of the option. It\n>      shall begin with a lower-case letter and a full stop (.) shall be\n>      omitted at the end.\n>      \n>      Various (sub)commands' option arrays don't follow the guideline provided\n>      by the parse_options Documentation regarding the descriptions.\n>      \n>      Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com\n> \n> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v1\n> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v1\n> Pull-Request: https://github.com/gitgitgadget/git/pull/920\n> \n>   builtin/column.c     | 8 ++++----\n>   builtin/range-diff.c | 2 +-\n>   2 files changed, 5 insertions(+), 5 deletions(-)\n> \n> diff --git a/builtin/column.c b/builtin/column.c\n> index e815e148aa18..40d4b3bee2dd 100644\n> --- a/builtin/column.c\n> +++ b/builtin/column.c\n> @@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix)\n>   \t\tOPT_STRING(0, \"command\", &real_command, N_(\"name\"), N_(\"lookup config vars\")),\n>   \t\tOPT_COLUMN(0, \"mode\", &colopts, N_(\"layout to use\")),\n>   \t\tOPT_INTEGER(0, \"raw-mode\", &colopts, N_(\"layout to use\")),\n> -\t\tOPT_INTEGER(0, \"width\", &copts.width, N_(\"Maximum width\")),\n> -\t\tOPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"Padding space on left border\")),\n> -\t\tOPT_INTEGER(0, \"nl\", &copts.nl, N_(\"Padding space on right border\")),\n> -\t\tOPT_INTEGER(0, \"padding\", &copts.padding, N_(\"Padding space between columns\")),\n> +\t\tOPT_INTEGER(0, \"width\", &copts.width, N_(\"maximum width\")),\n> +\t\tOPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"padding space on left border\")),\n> +\t\tOPT_INTEGER(0, \"nl\", &copts.nl, N_(\"padding space on right border\")),\n> +\t\tOPT_INTEGER(0, \"padding\", &copts.padding, N_(\"padding space between columns\")),\n>   \t\tOPT_END()\n>   \t};\n>   \n> diff --git a/builtin/range-diff.c b/builtin/range-diff.c\n> index 78bc9fa77062..50318849d657 100644\n> --- a/builtin/range-diff.c\n> +++ b/builtin/range-diff.c\n> @@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix)\n>   \tstruct option range_diff_options[] = {\n>   \t\tOPT_INTEGER(0, \"creation-factor\",\n>   \t\t\t    &range_diff_opts.creation_factor,\n> -\t\t\t    N_(\"Percentage by which creation is weighted\")),\n> +\t\t\t    N_(\"percentage by which creation is weighted\")),\n>   \t\tOPT_BOOL(0, \"no-dual-color\", &simple_color,\n>   \t\t\t    N_(\"use simple diff colors\")),\n>   \t\tOPT_PASSTHRU_ARGV(0, \"notes\", &other_arg,\n> \n> base-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860\n> \nWait, I expected that this patch touches Documentation/* (as the title implied),\nbut it seems like the patch content is something else (not related).\n\nTotally wrong patch submitted here.\n\n-- \nAn old man doll... just what I always wanted! - Clara\n"},{"id":"420371","messageId":"de6d56b5-89e4-1e50-1011-0a9b9c46f4d9@gmail.com","threadId":"55405","inReplyTo":"e85a653c-2650-313d-b5ca-5874559d9528@gmail.com","subject":"Re: [PATCH] Documentation: amended usages of various (sub)commands","fromName":"Bagas Sanjaya","fromEmail":"bagasdotme@gmail.com","sentAt":"2021-03-28T08:13:54Z","receivedAt":"2021-03-28T08:14:50Z","isPatch":true,"sender":{"key":"bagasdotme@gmail.com","avatar":"https://avatars.githubusercontent.com/u/40219486?v=4"},"body":"On 28/03/21 13.56, Bagas Sanjaya wrote:\n> On 28/03/21 13.34, Chinmoy via GitGitGadget wrote:\n>> From: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n>>\n>> The Git suite option parsing API's Technical Documentation suggests this\n>> about the option descriptions of a (sub)command:\n>>\n>> `description` is a short string to describe the effect of the option.\n>> It shall begin with a lower-case letter and a full stop (.) shall be\n>> omitted at the end.\n>>\n>> Various (sub)commands' option arrays don't follow the guideline provided\n>> by the parse_options Documentation regarding the descriptions.\n>>\n>> Signed-off-by: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n>> ---\n>>      Documentation: amended usages of various (sub)commands\n>>      The Git suite option parsing API's Technical Documentation suggests this\n>>      about the option descriptions of a (sub)command:\n>>      description is a short string to describe the effect of the option. It\n>>      shall begin with a lower-case letter and a full stop (.) shall be\n>>      omitted at the end.\n>>      Various (sub)commands' option arrays don't follow the guideline provided\n>>      by the parse_options Documentation regarding the descriptions.\n>>      Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com\n>>\n>> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v1\n>> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v1\n>> Pull-Request: https://github.com/gitgitgadget/git/pull/920\n>>\n>>   builtin/column.c     | 8 ++++----\n>>   builtin/range-diff.c | 2 +-\n>>   2 files changed, 5 insertions(+), 5 deletions(-)\n>>\n>> diff --git a/builtin/column.c b/builtin/column.c\n>> index e815e148aa18..40d4b3bee2dd 100644\n>> --- a/builtin/column.c\n>> +++ b/builtin/column.c\n>> @@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix)\n>>           OPT_STRING(0, \"command\", &real_command, N_(\"name\"), N_(\"lookup config vars\")),\n>>           OPT_COLUMN(0, \"mode\", &colopts, N_(\"layout to use\")),\n>>           OPT_INTEGER(0, \"raw-mode\", &colopts, N_(\"layout to use\")),\n>> -        OPT_INTEGER(0, \"width\", &copts.width, N_(\"Maximum width\")),\n>> -        OPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"Padding space on left border\")),\n>> -        OPT_INTEGER(0, \"nl\", &copts.nl, N_(\"Padding space on right border\")),\n>> -        OPT_INTEGER(0, \"padding\", &copts.padding, N_(\"Padding space between columns\")),\n>> +        OPT_INTEGER(0, \"width\", &copts.width, N_(\"maximum width\")),\n>> +        OPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"padding space on left border\")),\n>> +        OPT_INTEGER(0, \"nl\", &copts.nl, N_(\"padding space on right border\")),\n>> +        OPT_INTEGER(0, \"padding\", &copts.padding, N_(\"padding space between columns\")),\n>>           OPT_END()\n>>       };\n>> diff --git a/builtin/range-diff.c b/builtin/range-diff.c\n>> index 78bc9fa77062..50318849d657 100644\n>> --- a/builtin/range-diff.c\n>> +++ b/builtin/range-diff.c\n>> @@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix)\n>>       struct option range_diff_options[] = {\n>>           OPT_INTEGER(0, \"creation-factor\",\n>>                   &range_diff_opts.creation_factor,\n>> -                N_(\"Percentage by which creation is weighted\")),\n>> +                N_(\"percentage by which creation is weighted\")),\n>>           OPT_BOOL(0, \"no-dual-color\", &simple_color,\n>>                   N_(\"use simple diff colors\")),\n>>           OPT_PASSTHRU_ARGV(0, \"notes\", &other_arg,\n>>\n>> base-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860\n>>\n> Wait, I expected that this patch touches Documentation/* (as the title implied),\n> but it seems like the patch content is something else (not related).\n> \n> Totally wrong patch submitted here.\n> \nOops, I don't see that diff above. Sorry for that.\n\nWhat about this patch title below?:\n\n`Make (sub)command options conform to TD of option parsing`\n\n-- \nAn old man doll... just what I always wanted! - Clara\n"},{"id":"420372","messageId":"2ccb53ea-e92d-f7ba-f480-467a0269548c@gmail.com","threadId":"55405","inReplyTo":"de6d56b5-89e4-1e50-1011-0a9b9c46f4d9@gmail.com","subject":"Re: [PATCH] Documentation: amended usages of various (sub)commands","fromName":"Chinmoy Chakraborty","fromEmail":"chinmoy12c@gmail.com","sentAt":"2021-03-28T08:24:51Z","receivedAt":"2021-03-28T08:25:01Z","isPatch":true,"sender":{"key":"chinmoy12c@gmail.com","avatar":"https://avatars.githubusercontent.com/u/57670338?v=4"},"body":"\nOn 3/28/21 1:43 PM, Bagas Sanjaya wrote:\n> Oops, I don't see that diff above. Sorry for that.\nThat's fine :).\n>\n> What about this patch title below?:\n>\n> `Make (sub)command options conform to TD of option parsing`\n>\nSure I'll update the title. Thanks for the suggestion.\n"},{"id":"420377","messageId":"pull.920.v2.git.1616926582735.gitgitgadget@gmail.com","threadId":"55405","inReplyTo":"pull.920.git.1616913298624.gitgitgadget@gmail.com","subject":"[PATCH v2] Documentation: make (sub)command options conform to TD of option parsing","fromName":"Chinmoy via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2021-03-28T10:16:22Z","receivedAt":"2021-03-28T10:17:13Z","isPatch":true,"sender":{"key":"name:Chinmoy","avatar":null},"body":"From: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n\nThe Git suite option parsing API's Technical Documentation suggests this\nabout the option descriptions of a (sub)command:\n\n`description` is a short string to describe the effect of the option.\nIt shall begin with a lower-case letter and a full stop (.) shall be\nomitted at the end.\n\nVarious (sub)commands' option arrays don't follow the guideline provided\nby the parse_options Documentation regarding the descriptions.\n\nSigned-off-by: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n---\n    Documentation: make (sub)command options conform to TD of option parsing\n    \n    The Git suite option parsing API's Technical Documentation suggests this\n    about the option descriptions of a (sub)command:\n    \n    description is a short string to describe the effect of the option. It\n    shall begin with a lower-case letter and a full stop (.) shall be\n    omitted at the end.\n    \n    Various (sub)commands' option arrays don't follow the guideline provided\n    by the parse_options Documentation regarding the descriptions.\n    \n    Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v2\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v2\nPull-Request: https://github.com/gitgitgadget/git/pull/920\n\nRange-diff vs v1:\n\n 1:  817b25caa931 ! 1:  b032c2fa5b28 Documentation: amended usages of various (sub)commands\n     @@ Metadata\n      Author: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n      \n       ## Commit message ##\n     -    Documentation: amended usages of various (sub)commands\n     +    Documentation: make (sub)command options conform to TD of option parsing\n      \n          The Git suite option parsing API's Technical Documentation suggests this\n          about the option descriptions of a (sub)command:\n\n\n builtin/column.c     | 8 ++++----\n builtin/range-diff.c | 2 +-\n 2 files changed, 5 insertions(+), 5 deletions(-)\n\ndiff --git a/builtin/column.c b/builtin/column.c\nindex e815e148aa18..40d4b3bee2dd 100644\n--- a/builtin/column.c\n+++ b/builtin/column.c\n@@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix)\n \t\tOPT_STRING(0, \"command\", &real_command, N_(\"name\"), N_(\"lookup config vars\")),\n \t\tOPT_COLUMN(0, \"mode\", &colopts, N_(\"layout to use\")),\n \t\tOPT_INTEGER(0, \"raw-mode\", &colopts, N_(\"layout to use\")),\n-\t\tOPT_INTEGER(0, \"width\", &copts.width, N_(\"Maximum width\")),\n-\t\tOPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"Padding space on left border\")),\n-\t\tOPT_INTEGER(0, \"nl\", &copts.nl, N_(\"Padding space on right border\")),\n-\t\tOPT_INTEGER(0, \"padding\", &copts.padding, N_(\"Padding space between columns\")),\n+\t\tOPT_INTEGER(0, \"width\", &copts.width, N_(\"maximum width\")),\n+\t\tOPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"padding space on left border\")),\n+\t\tOPT_INTEGER(0, \"nl\", &copts.nl, N_(\"padding space on right border\")),\n+\t\tOPT_INTEGER(0, \"padding\", &copts.padding, N_(\"padding space between columns\")),\n \t\tOPT_END()\n \t};\n \ndiff --git a/builtin/range-diff.c b/builtin/range-diff.c\nindex 78bc9fa77062..50318849d657 100644\n--- a/builtin/range-diff.c\n+++ b/builtin/range-diff.c\n@@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix)\n \tstruct option range_diff_options[] = {\n \t\tOPT_INTEGER(0, \"creation-factor\",\n \t\t\t    &range_diff_opts.creation_factor,\n-\t\t\t    N_(\"Percentage by which creation is weighted\")),\n+\t\t\t    N_(\"percentage by which creation is weighted\")),\n \t\tOPT_BOOL(0, \"no-dual-color\", &simple_color,\n \t\t\t    N_(\"use simple diff colors\")),\n \t\tOPT_PASSTHRU_ARGV(0, \"notes\", &other_arg,\n\nbase-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860\n-- \ngitgitgadget\n"},{"id":"420419","messageId":"xmqq35wfm8mt.fsf@gitster.g","threadId":"55405","inReplyTo":"de6d56b5-89e4-1e50-1011-0a9b9c46f4d9@gmail.com","subject":"Re: [PATCH] Documentation: amended usages of various (sub)commands","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-03-28T18:32:42Z","receivedAt":"2021-03-28T18:33:49Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Bagas Sanjaya <bagasdotme@gmail.com> writes:\n\n>>> ...\n>> Wait, I expected that this patch touches Documentation/* (as the title implied),\n>> but it seems like the patch content is something else (not related).\n>> Totally wrong patch submitted here.\n\nPlease learn to trim your quotes.\n\n> Oops, I don't see that diff above. Sorry for that.\n>\n> What about this patch title below?:\n>\n> `Make (sub)command options conform to TD of option parsing`\n\n\"Make X conform\" has low information contents (especially when\nnobody knows what the TD is), because nobody would try to make the\ncode worse by making things nonconforming.\n\n    Subject: [PATCH] column, range-diff: downcase option description\n\n    It is customary not to begin the help text for each option given to\n    the parse-options API with a capital letter.\n\n    Downcase the first word of some option descriptions for \"column\"\n    and \"range-diff\".\n\nor something like that?\n\nEven though the guideline for the documentation talks about two\nthings (i.e. not starting with capital and omitting full-stop at the\nend), the help strings being touched by the patch only have problem\nwith the former, so quoting the guideline in full would not help\npeople understand what is changed and why.\n"},{"id":"420430","messageId":"6852d727-5ce8-0b9f-112e-e420c44227ce@gmail.com","threadId":"55405","inReplyTo":"xmqq35wfm8mt.fsf@gitster.g","subject":"Re: [PATCH] Documentation: amended usages of various (sub)commands","fromName":"Bagas Sanjaya","fromEmail":"bagasdotme@gmail.com","sentAt":"2021-03-29T05:17:43Z","receivedAt":"2021-03-29T05:21:58Z","isPatch":true,"sender":{"key":"bagasdotme@gmail.com","avatar":"https://avatars.githubusercontent.com/u/40219486?v=4"},"body":"On 29/03/21 01.32, Junio C Hamano wrote:\n>> What about this patch title below?:\n>>\n>> `Make (sub)command options conform to TD of option parsing`\n> \n> \"Make X conform\" has low information contents (especially when\n> nobody knows what the TD is), because nobody would try to make the\n> code worse by making things nonconforming.\n> \n>      Subject: [PATCH] column, range-diff: downcase option description\n> \n>      It is customary not to begin the help text for each option given to\n>      the parse-options API with a capital letter.\n> \n>      Downcase the first word of some option descriptions for \"column\"\n>      and \"range-diff\".\n> \n> or something like that?\n\nThat's what this patch intended to do (from the diff).\n\n-- \nAn old man doll... just what I always wanted! - Clara\n"},{"id":"420444","messageId":"pull.920.v3.git.1617014753305.gitgitgadget@gmail.com","threadId":"55405","inReplyTo":"pull.920.v2.git.1616926582735.gitgitgadget@gmail.com","subject":"[PATCH v3] column, range-diff: downcase option description","fromName":"Chinmoy via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2021-03-29T10:45:52Z","receivedAt":"2021-03-29T10:46:58Z","isPatch":true,"sender":{"key":"name:Chinmoy","avatar":null},"body":"From: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n\nIt is customary not to begin the help text for each option given to\nthe parse-options API with a capital letter.Various (sub)commands'\noption arrays don't follow the guideline provided by the parse_options\nDocumentation regarding the descriptions.\n\nDowncase the first word of some option descriptions for \"column\"\nand \"range-diff\".\n\nSigned-off-by: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n---\n    column, range-diff: downcase option description\n    \n    It is customary not to begin the help text for each option given to the\n    parse-options API with a capital letter.Various (sub)commands' option\n    arrays don't follow the guideline provided by the parse_options\n    Documentation regarding the descriptions.\n    \n    Downcase the first word of some option descriptions for \"column\" and\n    \"range-diff\".\n    \n    Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v3\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v3\nPull-Request: https://github.com/gitgitgadget/git/pull/920\n\nRange-diff vs v2:\n\n 1:  b032c2fa5b28 ! 1:  61be08b7dd73 Documentation: make (sub)command options conform to TD of option parsing\n     @@ Metadata\n      Author: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n      \n       ## Commit message ##\n     -    Documentation: make (sub)command options conform to TD of option parsing\n     +    column, range-diff: downcase option description\n      \n     -    The Git suite option parsing API's Technical Documentation suggests this\n     -    about the option descriptions of a (sub)command:\n     +    It is customary not to begin the help text for each option given to\n     +    the parse-options API with a capital letter.Various (sub)commands'\n     +    option arrays don't follow the guideline provided by the parse_options\n     +    Documentation regarding the descriptions.\n      \n     -    `description` is a short string to describe the effect of the option.\n     -    It shall begin with a lower-case letter and a full stop (.) shall be\n     -    omitted at the end.\n     -\n     -    Various (sub)commands' option arrays don't follow the guideline provided\n     -    by the parse_options Documentation regarding the descriptions.\n     +    Downcase the first word of some option descriptions for \"column\"\n     +    and \"range-diff\".\n      \n          Signed-off-by: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n      \n\n\n builtin/column.c     | 8 ++++----\n builtin/range-diff.c | 2 +-\n 2 files changed, 5 insertions(+), 5 deletions(-)\n\ndiff --git a/builtin/column.c b/builtin/column.c\nindex e815e148aa18..40d4b3bee2dd 100644\n--- a/builtin/column.c\n+++ b/builtin/column.c\n@@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix)\n \t\tOPT_STRING(0, \"command\", &real_command, N_(\"name\"), N_(\"lookup config vars\")),\n \t\tOPT_COLUMN(0, \"mode\", &colopts, N_(\"layout to use\")),\n \t\tOPT_INTEGER(0, \"raw-mode\", &colopts, N_(\"layout to use\")),\n-\t\tOPT_INTEGER(0, \"width\", &copts.width, N_(\"Maximum width\")),\n-\t\tOPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"Padding space on left border\")),\n-\t\tOPT_INTEGER(0, \"nl\", &copts.nl, N_(\"Padding space on right border\")),\n-\t\tOPT_INTEGER(0, \"padding\", &copts.padding, N_(\"Padding space between columns\")),\n+\t\tOPT_INTEGER(0, \"width\", &copts.width, N_(\"maximum width\")),\n+\t\tOPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"padding space on left border\")),\n+\t\tOPT_INTEGER(0, \"nl\", &copts.nl, N_(\"padding space on right border\")),\n+\t\tOPT_INTEGER(0, \"padding\", &copts.padding, N_(\"padding space between columns\")),\n \t\tOPT_END()\n \t};\n \ndiff --git a/builtin/range-diff.c b/builtin/range-diff.c\nindex 78bc9fa77062..50318849d657 100644\n--- a/builtin/range-diff.c\n+++ b/builtin/range-diff.c\n@@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix)\n \tstruct option range_diff_options[] = {\n \t\tOPT_INTEGER(0, \"creation-factor\",\n \t\t\t    &range_diff_opts.creation_factor,\n-\t\t\t    N_(\"Percentage by which creation is weighted\")),\n+\t\t\t    N_(\"percentage by which creation is weighted\")),\n \t\tOPT_BOOL(0, \"no-dual-color\", &simple_color,\n \t\t\t    N_(\"use simple diff colors\")),\n \t\tOPT_PASSTHRU_ARGV(0, \"notes\", &other_arg,\n\nbase-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860\n-- \ngitgitgadget\n"},{"id":"420447","messageId":"eb3c37fe-45b1-6a25-c4c5-851dd88649bf@gmail.com","threadId":"55405","inReplyTo":"pull.920.v3.git.1617014753305.gitgitgadget@gmail.com","subject":"Re: [PATCH v3] column, range-diff: downcase option description","fromName":"Bagas Sanjaya","fromEmail":"bagasdotme@gmail.com","sentAt":"2021-03-29T10:58:51Z","receivedAt":"2021-03-29T10:59:46Z","isPatch":true,"sender":{"key":"bagasdotme@gmail.com","avatar":"https://avatars.githubusercontent.com/u/40219486?v=4"},"body":"On 29/03/21 17.45, Chinmoy via GitGitGadget wrote:\n> From: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n> \n> It is customary not to begin the help text for each option given to\n> the parse-options API with a capital letter.Various (sub)commands'\n> option arrays don't follow the guideline provided by the parse_options\n> Documentation regarding the descriptions.\n> \n> Downcase the first word of some option descriptions for \"column\"\n> and \"range-diff\".\n> \n> Signed-off-by: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n> ---\n>      column, range-diff: downcase option description\n>      \n>      It is customary not to begin the help text for each option given to the\n>      parse-options API with a capital letter.Various (sub)commands' option\n>      arrays don't follow the guideline provided by the parse_options\n>      Documentation regarding the descriptions.\n>      \n>      Downcase the first word of some option descriptions for \"column\" and\n>      \"range-diff\".\n>      \n>      Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com\n> \n> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v3\n> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v3\n> Pull-Request: https://github.com/gitgitgadget/git/pull/920\n> \n> Range-diff vs v2:\n> \n>   1:  b032c2fa5b28 ! 1:  61be08b7dd73 Documentation: make (sub)command options conform to TD of option parsing\n>       @@ Metadata\n>        Author: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n>        \n>         ## Commit message ##\n>       -    Documentation: make (sub)command options conform to TD of option parsing\n>       +    column, range-diff: downcase option description\n>        \n>       -    The Git suite option parsing API's Technical Documentation suggests this\n>       -    about the option descriptions of a (sub)command:\n>       +    It is customary not to begin the help text for each option given to\n>       +    the parse-options API with a capital letter.Various (sub)commands'\n>       +    option arrays don't follow the guideline provided by the parse_options\n>       +    Documentation regarding the descriptions.\n>        \n>       -    `description` is a short string to describe the effect of the option.\n>       -    It shall begin with a lower-case letter and a full stop (.) shall be\n>       -    omitted at the end.\n>       -\n>       -    Various (sub)commands' option arrays don't follow the guideline provided\n>       -    by the parse_options Documentation regarding the descriptions.\n>       +    Downcase the first word of some option descriptions for \"column\"\n>       +    and \"range-diff\".\n>        \n>            Signed-off-by: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n>        \n> \n> \n>   builtin/column.c     | 8 ++++----\n>   builtin/range-diff.c | 2 +-\n>   2 files changed, 5 insertions(+), 5 deletions(-)\n> \n> diff --git a/builtin/column.c b/builtin/column.c\n> index e815e148aa18..40d4b3bee2dd 100644\n> --- a/builtin/column.c\n> +++ b/builtin/column.c\n> @@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix)\n>   \t\tOPT_STRING(0, \"command\", &real_command, N_(\"name\"), N_(\"lookup config vars\")),\n>   \t\tOPT_COLUMN(0, \"mode\", &colopts, N_(\"layout to use\")),\n>   \t\tOPT_INTEGER(0, \"raw-mode\", &colopts, N_(\"layout to use\")),\n> -\t\tOPT_INTEGER(0, \"width\", &copts.width, N_(\"Maximum width\")),\n> -\t\tOPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"Padding space on left border\")),\n> -\t\tOPT_INTEGER(0, \"nl\", &copts.nl, N_(\"Padding space on right border\")),\n> -\t\tOPT_INTEGER(0, \"padding\", &copts.padding, N_(\"Padding space between columns\")),\n> +\t\tOPT_INTEGER(0, \"width\", &copts.width, N_(\"maximum width\")),\n> +\t\tOPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"padding space on left border\")),\n> +\t\tOPT_INTEGER(0, \"nl\", &copts.nl, N_(\"padding space on right border\")),\n> +\t\tOPT_INTEGER(0, \"padding\", &copts.padding, N_(\"padding space between columns\")),\n>   \t\tOPT_END()\n>   \t};\n>   \n> diff --git a/builtin/range-diff.c b/builtin/range-diff.c\n> index 78bc9fa77062..50318849d657 100644\n> --- a/builtin/range-diff.c\n> +++ b/builtin/range-diff.c\n> @@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix)\n>   \tstruct option range_diff_options[] = {\n>   \t\tOPT_INTEGER(0, \"creation-factor\",\n>   \t\t\t    &range_diff_opts.creation_factor,\n> -\t\t\t    N_(\"Percentage by which creation is weighted\")),\n> +\t\t\t    N_(\"percentage by which creation is weighted\")),\n>   \t\tOPT_BOOL(0, \"no-dual-color\", &simple_color,\n>   \t\t\t    N_(\"use simple diff colors\")),\n>   \t\tOPT_PASSTHRU_ARGV(0, \"notes\", &other_arg,\n> \n> base-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860\n> \nPatch title and description match, looks OK.\n\nReviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>\n\n-- \nAn old man doll... just what I always wanted! - Clara\n"},{"id":"420475","messageId":"bb5b4945-93f1-c0a9-5e7f-6b11525312f7@iee.email","threadId":"55405","inReplyTo":"pull.920.v3.git.1617014753305.gitgitgadget@gmail.com","subject":"Re: [PATCH v3] column, range-diff: downcase option description","fromName":"Philip Oakley","fromEmail":"philipoakley@iee.email","sentAt":"2021-03-29T13:46:29Z","receivedAt":"2021-03-29T13:47:43Z","isPatch":true,"sender":{"key":"philipoakley@iee.email","avatar":"https://avatars.githubusercontent.com/u/914343?v=4"},"body":"Super minor nit - missing space after full stop.\n\nOn 29/03/2021 11:45, Chinmoy via GitGitGadget wrote:\n> From: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n>\n> It is customary not to begin the help text for each option given to\n> the parse-options API with a capital letter.Various (sub)commands'\ns/Various/ Various/\n\n--\nPhilip\n\n> option arrays don't follow the guideline provided by the parse_options\n> Documentation regarding the descriptions.\n>\n> Downcase the first word of some option descriptions for \"column\"\n> and \"range-diff\".\n>\n> Signed-off-by: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n> ---\n>     column, range-diff: downcase option description\n>     \n>     It is customary not to begin the help text for each option given to the\n>     parse-options API with a capital letter.Various (sub)commands' option\n>     arrays don't follow the guideline provided by the parse_options\n>     Documentation regarding the descriptions.\n>     \n>     Downcase the first word of some option descriptions for \"column\" and\n>     \"range-diff\".\n>     \n>     Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com\n>\n> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v3\n> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v3\n> Pull-Request: https://github.com/gitgitgadget/git/pull/920\n>\n> Range-diff vs v2:\n>\n>  1:  b032c2fa5b28 ! 1:  61be08b7dd73 Documentation: make (sub)command options conform to TD of option parsing\n>      @@ Metadata\n>       Author: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n>       \n>        ## Commit message ##\n>      -    Documentation: make (sub)command options conform to TD of option parsing\n>      +    column, range-diff: downcase option description\n>       \n>      -    The Git suite option parsing API's Technical Documentation suggests this\n>      -    about the option descriptions of a (sub)command:\n>      +    It is customary not to begin the help text for each option given to\n>      +    the parse-options API with a capital letter.Various (sub)commands'\n>      +    option arrays don't follow the guideline provided by the parse_options\n>      +    Documentation regarding the descriptions.\n>       \n>      -    `description` is a short string to describe the effect of the option.\n>      -    It shall begin with a lower-case letter and a full stop (.) shall be\n>      -    omitted at the end.\n>      -\n>      -    Various (sub)commands' option arrays don't follow the guideline provided\n>      -    by the parse_options Documentation regarding the descriptions.\n>      +    Downcase the first word of some option descriptions for \"column\"\n>      +    and \"range-diff\".\n>       \n>           Signed-off-by: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n>       \n>\n>\n>  builtin/column.c     | 8 ++++----\n>  builtin/range-diff.c | 2 +-\n>  2 files changed, 5 insertions(+), 5 deletions(-)\n>\n> diff --git a/builtin/column.c b/builtin/column.c\n> index e815e148aa18..40d4b3bee2dd 100644\n> --- a/builtin/column.c\n> +++ b/builtin/column.c\n> @@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix)\n>  \t\tOPT_STRING(0, \"command\", &real_command, N_(\"name\"), N_(\"lookup config vars\")),\n>  \t\tOPT_COLUMN(0, \"mode\", &colopts, N_(\"layout to use\")),\n>  \t\tOPT_INTEGER(0, \"raw-mode\", &colopts, N_(\"layout to use\")),\n> -\t\tOPT_INTEGER(0, \"width\", &copts.width, N_(\"Maximum width\")),\n> -\t\tOPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"Padding space on left border\")),\n> -\t\tOPT_INTEGER(0, \"nl\", &copts.nl, N_(\"Padding space on right border\")),\n> -\t\tOPT_INTEGER(0, \"padding\", &copts.padding, N_(\"Padding space between columns\")),\n> +\t\tOPT_INTEGER(0, \"width\", &copts.width, N_(\"maximum width\")),\n> +\t\tOPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"padding space on left border\")),\n> +\t\tOPT_INTEGER(0, \"nl\", &copts.nl, N_(\"padding space on right border\")),\n> +\t\tOPT_INTEGER(0, \"padding\", &copts.padding, N_(\"padding space between columns\")),\n>  \t\tOPT_END()\n>  \t};\n>  \n> diff --git a/builtin/range-diff.c b/builtin/range-diff.c\n> index 78bc9fa77062..50318849d657 100644\n> --- a/builtin/range-diff.c\n> +++ b/builtin/range-diff.c\n> @@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix)\n>  \tstruct option range_diff_options[] = {\n>  \t\tOPT_INTEGER(0, \"creation-factor\",\n>  \t\t\t    &range_diff_opts.creation_factor,\n> -\t\t\t    N_(\"Percentage by which creation is weighted\")),\n> +\t\t\t    N_(\"percentage by which creation is weighted\")),\n>  \t\tOPT_BOOL(0, \"no-dual-color\", &simple_color,\n>  \t\t\t    N_(\"use simple diff colors\")),\n>  \t\tOPT_PASSTHRU_ARGV(0, \"notes\", &other_arg,\n>\n> base-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860\n\n"},{"id":"420478","messageId":"pull.920.v4.git.1617029194872.gitgitgadget@gmail.com","threadId":"55405","inReplyTo":"pull.920.v3.git.1617014753305.gitgitgadget@gmail.com","subject":"[PATCH v4] column, range-diff: downcase option description","fromName":"Chinmoy via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2021-03-29T14:46:34Z","receivedAt":"2021-03-29T14:47:42Z","isPatch":true,"sender":{"key":"name:Chinmoy","avatar":null},"body":"From: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n\nIt is customary not to begin the help text for each option given to\nthe parse-options API with a capital letter. Various (sub)commands'\noption arrays don't follow the guideline provided by the parse_options\nDocumentation regarding the descriptions.\n\nDowncase the first word of some option descriptions for \"column\"\nand \"range-diff\".\n\nSigned-off-by: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n---\n    column, range-diff: downcase option description\n    \n    It is customary not to begin the help text for each option given to the\n    parse-options API with a capital letter.Various (sub)commands' option\n    arrays don't follow the guideline provided by the parse_options\n    Documentation regarding the descriptions.\n    \n    Downcase the first word of some option descriptions for \"column\" and\n    \"range-diff\".\n    \n    Signed-off-by: Chinmoy Chakraborty chinmoy12c@gmail.com\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v4\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v4\nPull-Request: https://github.com/gitgitgadget/git/pull/920\n\nRange-diff vs v3:\n\n 1:  61be08b7dd73 ! 1:  286668a91cb9 column, range-diff: downcase option description\n     @@ Commit message\n          column, range-diff: downcase option description\n      \n          It is customary not to begin the help text for each option given to\n     -    the parse-options API with a capital letter.Various (sub)commands'\n     +    the parse-options API with a capital letter. Various (sub)commands'\n          option arrays don't follow the guideline provided by the parse_options\n          Documentation regarding the descriptions.\n      \n\n\n builtin/column.c     | 8 ++++----\n builtin/range-diff.c | 2 +-\n 2 files changed, 5 insertions(+), 5 deletions(-)\n\ndiff --git a/builtin/column.c b/builtin/column.c\nindex e815e148aa18..40d4b3bee2dd 100644\n--- a/builtin/column.c\n+++ b/builtin/column.c\n@@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix)\n \t\tOPT_STRING(0, \"command\", &real_command, N_(\"name\"), N_(\"lookup config vars\")),\n \t\tOPT_COLUMN(0, \"mode\", &colopts, N_(\"layout to use\")),\n \t\tOPT_INTEGER(0, \"raw-mode\", &colopts, N_(\"layout to use\")),\n-\t\tOPT_INTEGER(0, \"width\", &copts.width, N_(\"Maximum width\")),\n-\t\tOPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"Padding space on left border\")),\n-\t\tOPT_INTEGER(0, \"nl\", &copts.nl, N_(\"Padding space on right border\")),\n-\t\tOPT_INTEGER(0, \"padding\", &copts.padding, N_(\"Padding space between columns\")),\n+\t\tOPT_INTEGER(0, \"width\", &copts.width, N_(\"maximum width\")),\n+\t\tOPT_STRING(0, \"indent\", &copts.indent, N_(\"string\"), N_(\"padding space on left border\")),\n+\t\tOPT_INTEGER(0, \"nl\", &copts.nl, N_(\"padding space on right border\")),\n+\t\tOPT_INTEGER(0, \"padding\", &copts.padding, N_(\"padding space between columns\")),\n \t\tOPT_END()\n \t};\n \ndiff --git a/builtin/range-diff.c b/builtin/range-diff.c\nindex 78bc9fa77062..50318849d657 100644\n--- a/builtin/range-diff.c\n+++ b/builtin/range-diff.c\n@@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix)\n \tstruct option range_diff_options[] = {\n \t\tOPT_INTEGER(0, \"creation-factor\",\n \t\t\t    &range_diff_opts.creation_factor,\n-\t\t\t    N_(\"Percentage by which creation is weighted\")),\n+\t\t\t    N_(\"percentage by which creation is weighted\")),\n \t\tOPT_BOOL(0, \"no-dual-color\", &simple_color,\n \t\t\t    N_(\"use simple diff colors\")),\n \t\tOPT_PASSTHRU_ARGV(0, \"notes\", &other_arg,\n\nbase-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860\n-- \ngitgitgadget\n"},{"id":"420512","messageId":"xmqqmtulisbn.fsf@gitster.g","threadId":"55405","inReplyTo":"pull.920.v4.git.1617029194872.gitgitgadget@gmail.com","subject":"Re: [PATCH v4] column, range-diff: downcase option description","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-03-29T21:05:32Z","receivedAt":"2021-03-29T21:06:37Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Chinmoy via GitGitGadget\" <gitgitgadget@gmail.com> writes:\n\n> From: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n>\n> It is customary not to begin the help text for each option given to\n> the parse-options API with a capital letter. Various (sub)commands'\n> option arrays don't follow the guideline provided by the parse_options\n> Documentation regarding the descriptions.\n>\n> Downcase the first word of some option descriptions for \"column\"\n> and \"range-diff\".\n>\n> Signed-off-by: Chinmoy Chakraborty <chinmoy12c@gmail.com>\n> ---\n\nThanks, Chinmoy, Bagas and Philip.  Will queue.\n\n"}]}