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

[PATCH v3 2/3] documentation: mention --no-use-mailmap and log.mailmap false setting

From
Ariadne Conill <ariadne@dereferenced.org>
Date
Jul 15, 2019, 12:41 UTC
Message-ID
<20190715124106.12642-3-ariadne@dereferenced.org>
In-Reply-To
<20190715124106.12642-1-ariadne@dereferenced.org>

The log.mailmap setting may be explicitly set to false, which disables the mailmap feature implicity. In practice, doing so is equivalent to always using the previously undocumented --no-use-mailmap option on the command line.

Accordingly, we document both the existence of --no-use-mailmap as well as briefly discuss the equivalence of it to log.mailmap=False.

Signed-off-by: Ariadne Conill <ariadne@dereferenced.org>
---
 Documentation/config/log.txt | 3 ++-
 Documentation/git-log.txt    | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/config/log.txt b/Documentation/config/log.txt
index 78d9e4453a..7798e10cb0 100644
--- a/Documentation/config/log.txt
+++ b/Documentation/config/log.txt
@@ -40,4 +40,5 @@ log.showSignature::
 
 log.mailmap::
 	If true, makes linkgit:git-log[1], linkgit:git-show[1], and
-	linkgit:git-whatchanged[1] assume `--use-mailmap`.
+	linkgit:git-whatchanged[1] assume `--use-mailmap`, otherwise
+	assume `--no-use-mailmap`. False by default.
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index b02e922dc3..b406bc4c48 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -49,7 +49,7 @@ OPTIONS
 	Print out the ref name given on the command line by which each
 	commit was reached.
 
---use-mailmap::
+--[no-]use-mailmap::
 	Use mailmap file to map author and committer names and email
 	addresses to canonical real names and email addresses. See
 	linkgit:git-shortlog[1].
-- 
2.17.1
Previous: Ariadne ConillNext: Ariadne Conill
Message 3 of 4 in “document deprecation of log.mailmap=false default”
  1. 0/3 document deprecation of log.mailmap=false defaultAriadne Conill, Jul 15, 2019
  2. 1/3 log: add warning for unspecified log.mailmap settingAriadne Conill, Jul 15, 2019
  3. 2/3 documentation: mention --no-use-mailmap and log.mailmap false settingAriadne Conill, Jul 15, 2019
  4. 3/3 tests: defang pager tests by explicitly disabling the log.mailmap warningAriadne Conill, Jul 15, 2019

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.