git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
CGChinmoy via GitGitGadget <gitgitgadget@gmail.com>
Date
Mar 29, 2021, 14:46 UTC
Message-ID
<pull.920.v4.git.1617029194872.gitgitgadget@gmail.com>
In-Reply-To
<pull.920.v3.git.1617014753305.gitgitgadget@gmail.com>
From: Chinmoy Chakraborty <chinmoy12c@gmail.com>

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>
---
    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
Previous: Philip OakleyNext: Junio C Hamano
Message 11 of 12 in “Documentation: amended usages of various (sub)commands”
  1. Documentation: amended usages of various (sub)commandsChinmoy via GitGitGadget, Mar 28, 2021
  2. Bagas SanjayaMar 28, 2021
  3. Bagas SanjayaMar 28, 2021
  4. Chinmoy ChakrabortyMar 28, 2021
  5. Junio C HamanoMar 28, 2021
  6. Bagas SanjayaMar 29, 2021
  7. Documentation: make (sub)command options conform to TD of option parsingChinmoy via GitGitGadget, Mar 28, 2021
  8. column, range-diff: downcase option descriptionChinmoy via GitGitGadget, Mar 29, 2021
  9. Bagas SanjayaMar 29, 2021
  10. Philip OakleyMar 29, 2021
  11. column, range-diff: downcase option descriptionChinmoy via GitGitGadget, Mar 29, 2021
  12. Junio C HamanoMar 29, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.