git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Chinmoy via GitGitGadget <gitgitgadget@gmail.com>
Cc: Chinmoy <chinmoy12c@gmail.com>, git@vger.kernel.org
Subject: Re: [PATCH] Documentation: amended usages of various (sub)commands
Date: Sun, 28 Mar 2021 15:13:54 +0700	[thread overview]
Message-ID: <de6d56b5-89e4-1e50-1011-0a9b9c46f4d9@gmail.com> (raw)
In-Reply-To: <e85a653c-2650-313d-b5ca-5874559d9528@gmail.com>

On 28/03/21 13.56, Bagas Sanjaya wrote:
> On 28/03/21 13.34, Chinmoy via GitGitGadget wrote:
>> From: Chinmoy Chakraborty <chinmoy12c@gmail.com>
>>
>> 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>
>> ---
>>      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

  reply	other threads:[~2021-03-28  8:14 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-28  6:34 [PATCH] Documentation: amended usages of various (sub)commands Chinmoy via GitGitGadget
2021-03-28  6:56 ` Bagas Sanjaya
2021-03-28  8:13   ` Bagas Sanjaya [this message]
2021-03-28  8:24     ` Chinmoy Chakraborty
2021-03-28 18:32     ` Junio C Hamano
2021-03-29  5:17       ` Bagas Sanjaya
2021-03-28 10:16 ` [PATCH v2] Documentation: make (sub)command options conform to TD of option parsing Chinmoy via GitGitGadget
2021-03-29 10:45   ` [PATCH v3] column, range-diff: downcase option description Chinmoy via GitGitGadget
2021-03-29 10:58     ` Bagas Sanjaya
2021-03-29 13:46     ` Philip Oakley
2021-03-29 14:46     ` [PATCH v4] " Chinmoy via GitGitGadget
2021-03-29 21:05       ` 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=de6d56b5-89e4-1e50-1011-0a9b9c46f4d9@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=chinmoy12c@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@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).