summaryrefslogtreecommitdiff
path: root/Documentation/gitmailmap.txt
diff options
context:
space:
mode:
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>2021-01-12 20:17:48 (GMT)
committerJunio C Hamano <gitster@pobox.com>2021-01-12 22:04:40 (GMT)
commitfcafb753829b5d2c73fe67becc073227feb4d7a3 (patch)
tree5b2b8a772fa809f3f8ffcc5882878b76376e970f /Documentation/gitmailmap.txt
parent6646cca8927c1c88a13e07bc14144cf5c12610f3 (diff)
downloadgit-fcafb753829b5d2c73fe67becc073227feb4d7a3.zip
git-fcafb753829b5d2c73fe67becc073227feb4d7a3.tar.gz
git-fcafb753829b5d2c73fe67becc073227feb4d7a3.tar.bz2
mailmap doc: start by mentioning the comment syntax
Mentioning the comment syntax and blank line support first is in line with how "git help config" describes its format. See b8936cf060 (config.txt grammar, typo, and asciidoc fixes, 2006-06-08) for the paragraph I'm copying & amending from its documentation. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/gitmailmap.txt')
-rw-r--r--Documentation/gitmailmap.txt5
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/gitmailmap.txt b/Documentation/gitmailmap.txt
index e75eadd..4e46770 100644
--- a/Documentation/gitmailmap.txt
+++ b/Documentation/gitmailmap.txt
@@ -23,6 +23,9 @@ canonical real names and email addresses.
SYNTAX
------
+The '#' character begins a comment to the end of line, blank lines
+are ignored.
+
In the simple form, each line in the file consists of the canonical
real name of an author, whitespace, and an email address used in the
commit (enclosed by '<' and '>') to map to the name. For example:
@@ -94,8 +97,6 @@ Other Author <other@author.xx> <nick2@company.xx>
Santa Claus <santa.claus@northpole.xx> <me@company.xx>
------------
-Use hash '#' for comments that are either on their own line, or after
-the email address.
SEE ALSO