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

[PATCH] Documentation: fix --color option formatting

From
Andrei Rybak <rybak.a.v@gmail.com>
Date
Jul 18, 2018, 17:37 UTC
Message-ID
<ccf73807-1856-1ce8-365a-0c4fb25ea7bf@gmail.com>
Add missing colon in two places to fix formatting of options.
Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
---
Done on top of maint.

The earliest this patch applies is on top of commit aebd23506e ("Merge branch 'jk/ui-color-always-to-auto-maint' into jk/ui-color-always-to-auto", 2017-10-04), one commit away from the commit that added both of the affected lines: 0c88bf5050 (provide --color option for all ref-filter users, 2017-10-03).

I grepped the Documentation folder, and haven't found any other similar typos.

---
 Documentation/git-for-each-ref.txt | 2 +-
 Documentation/git-tag.txt          | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 085d177d97..901faef1bf 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -57,7 +57,7 @@ OPTIONS
 	`xx`; for example `%00` interpolates to `\0` (NUL),
 	`%09` to `\t` (TAB) and `%0a` to `\n` (LF).
 
---color[=<when>]:
+--color[=<when>]::
 	Respect any colors specified in the `--format` option. The
 	`<when>` field must be one of `always`, `never`, or `auto` (if
 	`<when>` is absent, behave as if `always` was given).
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 87c4288ffc..92f9c12b87 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -115,7 +115,7 @@ options for details.
 	variable if it exists, or lexicographic order otherwise. See
 	linkgit:git-config[1].
 
---color[=<when>]:
+--color[=<when>]::
 	Respect any colors specified in the `--format` option. The
 	`<when>` field must be one of `always`, `never`, or `auto` (if
 	`<when>` is absent, behave as if `always` was given).
-- 
2.18.0
Next: Jeff King
Message 1 of 5 in “Documentation: fix --color option formatting”
  1. Documentation: fix --color option formattingAndrei Rybak, Jul 18, 2018
  2. Jeff KingJul 18, 2018
  3. brian m. carlsonJul 20, 2018
  4. Junio C HamanoJul 20, 2018
  5. Junio C HamanoJul 18, 2018

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.