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>
Ævar Arnfjörð Bjarmason committed
Jan 12, 2021 at 21:17 UTC
fcafb753829b5d2c73fe67becc073227feb4d7a3
1 file changed
+3
-2
Documentation/gitmailmap.txt
+3
-2
@@ -23,6 +23,9 @@ canonical real names and email addresses.
23
SYNTAX
24
------
25
26
+The '#' character begins a comment to the end of line, blank lines
27
+are ignored.
28
+
29
In the simple form, each line in the file consists of the canonical
30
real name of an author, whitespace, and an email address used in the
31
commit (enclosed by '<' and '>') to map to the name. For example:
@@ -94,8 +97,6 @@ Other Author <other@author.xx> <nick2@company.xx>
97
Santa Claus <santa.claus@northpole.xx> <me@company.xx>
98
------------
99
97
-Use hash '#' for comments that are either on their own line, or after
98
-the email address.
100
101
102
SEE ALSO