Documentation: amended usages of various (sub)commands

PATCH In review Chinmoy via GitGitGadget 5 participants 12 messages Mar 28, 2021 – Mar 29, 2021

lore

Share & tools

lore

Chinmoy via GitGitGadget

author

2021-03-28 06:35 UTC #0 lore raw

PATCH 1/1 Documentation: amended usages of various (sub)commands

From: Chinmoy Chakraborty <[email protected]>

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 <[email protected]>

---
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 [email protected]

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(-)

builtin/column.c +4 -4

index e815e148aa18..40d4b3bee2dd 100644
@@ -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()
 	};

builtin/range-diff.c +1 -1

index 78bc9fa77062..50318849d657 100644
@@ -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

Signature · 1 line

gitgitgadget

Bagas Sanjaya

2021-03-28 07:02 UTC #1 lore raw

Quoted 69 lines · Chinmoy via GitGitGadget

From: Chinmoy Chakraborty <[email protected]>
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 <[email protected]>
---
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 [email protected]
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(-)
builtin/column.c +4 -4
index e815e148aa18..40d4b3bee2dd 100644
@@ -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()
  	};
 
builtin/range-diff.c +1 -1
index 78bc9fa77062..50318849d657 100644
@@ -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,

Quoted 2 lines

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.

Signature · 1 line

An old man doll... just what I always wanted! - Clara

Bagas Sanjaya

2021-03-28 08:14 UTC #2 lore raw

Quoted 65 lines · Bagas Sanjaya

Quoted 64 lines · Chinmoy via GitGitGadget
From: Chinmoy Chakraborty <[email protected]>
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 <[email protected]>
---
     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 [email protected]
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(-)
builtin/column.c +4 -4
index e815e148aa18..40d4b3bee2dd 100644
@@ -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()
       };
builtin/range-diff.c +1 -1
index 78bc9fa77062..50318849d657 100644
@@ -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,

Quoted 7 lines

Quoted 2 lines
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

Signature · 1 line

An old man doll... just what I always wanted! - Clara

Chinmoy Chakraborty

2021-03-28 08:25 UTC #3 lore raw

Quoted 1 line · Bagas Sanjaya

Oops, I don't see that diff above. Sorry for that.

That's fine :).

Quoted 5 lines

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.

Junio C Hamano

2021-03-28 18:33 UTC #4 lore raw

In reply to Bagas Sanjaya

Quoted 4 lines · Bagas Sanjaya

Quoted 4 lines
Quoted 1 line
...
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.

Quoted 5 lines

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:21 UTC #5 lore raw

Quoted 10 lines · Junio C Hamano

Quoted 3 lines
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

Quoted 7 lines

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).

Signature · 1 line

An old man doll... just what I always wanted! - Clara

Chinmoy via GitGitGadget

author

2021-03-28 10:17 UTC #6 lore raw

PATCH v2 1/1 Documentation: make (sub)command options conform to TD of option parsing

In reply to Chinmoy via GitGitGadget

From: Chinmoy Chakraborty <[email protected]>

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 <[email protected]>

---
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 [email protected]

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 <[email protected]>

## 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(-)

builtin/column.c +4 -4

index e815e148aa18..40d4b3bee2dd 100644
@@ -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()
 	};

builtin/range-diff.c +1 -1

index 78bc9fa77062..50318849d657 100644
@@ -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

Signature · 1 line

gitgitgadget

Chinmoy via GitGitGadget

author

2021-03-29 10:46 UTC #7 lore raw

PATCH v3 1/1 column, range-diff: downcase option description

From: Chinmoy Chakraborty <[email protected]>

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 <[email protected]>

---
column, range-diff: downcase option description

Downcase the first word of some option descriptions for "column" and "range-diff".

Signed-off-by Chinmoy Chakraborty [email protected]

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 <[email protected]>

## 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 <[email protected]>

 builtin/column.c     | 8 ++++----
 builtin/range-diff.c | 2 +-
 2 files changed, 5 insertions(+), 5 deletions(-)

builtin/column.c +4 -4

index e815e148aa18..40d4b3bee2dd 100644
@@ -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()
 	};

builtin/range-diff.c +1 -1

index 78bc9fa77062..50318849d657 100644
@@ -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

Signature · 1 line

gitgitgadget

Bagas Sanjaya

Reviewed-by on v3 1/1

2021-03-29 10:59 UTC #8 lore raw

Re: [PATCH v3] column, range-diff: downcase option description

Quoted 95 lines · Chinmoy via GitGitGadget

From: Chinmoy Chakraborty <[email protected]>
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 <[email protected]>
---
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 [email protected]
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 <[email protected]>
## 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 <[email protected]>
  builtin/column.c     | 8 ++++----
  builtin/range-diff.c | 2 +-
  2 files changed, 5 insertions(+), 5 deletions(-)
builtin/column.c +4 -4
index e815e148aa18..40d4b3bee2dd 100644
@@ -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()
  	};
 
builtin/range-diff.c +1 -1
index 78bc9fa77062..50318849d657 100644
@@ -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,

Quoted 2 lines

base-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860

Patch title and description match, looks OK.

Reviewed-by Bagas Sanjaya <[email protected]>

Signature · 1 line

An old man doll... just what I always wanted! - Clara

Philip Oakley

2021-03-29 13:47 UTC #9 lore raw

Re: [PATCH v3] column, range-diff: downcase option description

In reply to Chinmoy via GitGitGadget

Super minor nit - missing space after full stop.

Quoted 4 lines · Chinmoy via GitGitGadget

From: Chinmoy Chakraborty <[email protected]>
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

Quoted 92 lines

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 <[email protected]>
---
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 [email protected]
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 <[email protected]>
## 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 <[email protected]>
 builtin/column.c     | 8 ++++----
 builtin/range-diff.c | 2 +-
 2 files changed, 5 insertions(+), 5 deletions(-)
builtin/column.c +4 -4
index e815e148aa18..40d4b3bee2dd 100644
@@ -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()
 	};
 
builtin/range-diff.c +1 -1
index 78bc9fa77062..50318849d657 100644
@@ -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

author

2021-03-29 14:47 UTC #10 lore raw

PATCH v4 1/1 column, range-diff: downcase option description

In reply to Chinmoy via GitGitGadget

From: Chinmoy Chakraborty <[email protected]>

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 <[email protected]>

---
column, range-diff: downcase option description

Downcase the first word of some option descriptions for "column" and "range-diff".

Signed-off-by Chinmoy Chakraborty [email protected]

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(-)

builtin/column.c +4 -4

index e815e148aa18..40d4b3bee2dd 100644
@@ -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()
 	};

builtin/range-diff.c +1 -1

index 78bc9fa77062..50318849d657 100644
@@ -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

Signature · 1 line

gitgitgadget

Junio C Hamano

2021-03-29 21:06 UTC #11 lore raw

Re: [PATCH v4] column, range-diff: downcase option description

Quoted 7 lines · Chinmoy via GitGitGadget

From: Chinmoy Chakraborty <[email protected]>
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.

Quoted 5 lines

Downcase the first word of some option descriptions for "column" and "range-diff".
Signed-off-by Chinmoy Chakraborty <[email protected]>
---

Thanks, Chinmoy, Bagas and Philip. Will queue.