fast-import: Document author/committer/tagger name is optional

The fast-import parser does not validate that the author, committer
or tagger name component contains both a name and an email address.
Therefore the name component has always been optional.  Correct the
documentation to match the implementation.

Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt
index 288032c7b88f2f43a2965d5bdbffc8472f0ca281..e6d364f53cd14a1738a210e131bc7799fb746abb 100644 (file)
--- a/Documentation/git-fast-import.txt
+++ b/Documentation/git-fast-import.txt
@@ -311,8 +311,8 @@ change to the project.
 ....
        'commit' SP <ref> LF
        mark?
 ....
        'commit' SP <ref> LF
        mark?

-       ('author' SP <name> SP LT <email> GT SP <when> LF)?
-       'committer' SP <name> SP LT <email> GT SP <when> LF
+       ('author' (SP <name>)? SP LT <email> GT SP <when> LF)?
+       'committer' (SP <name>)? SP LT <email> GT SP <when> LF

        data
        ('from' SP <committish> LF)?
        ('merge' SP <committish> LF)?
        data
        ('from' SP <committish> LF)?
        ('merge' SP <committish> LF)?


@@ -657,7 +657,7 @@ lightweight (non-annotated) tags see the `reset` command below.
 ....
        'tag' SP <name> LF
        'from' SP <committish> LF
 ....
        'tag' SP <name> LF
        'from' SP <committish> LF

-       'tagger' SP <name> SP LT <email> GT SP <when> LF
+       'tagger' (SP <name>)? SP LT <email> GT SP <when> LF

        data
 ....
 
        data
 ....
 

diff --git a/fast-import.c b/fast-import.c
index dd3c99d60d0ccf2506b08632c35c5ffc2bbc3255..cd8704987168be08bf488ffd191f57f2f80aea22 100644 (file)
--- a/fast-import.c
+++ b/fast-import.c
@@ -19,8 +19,8 @@ Format of STDIN stream:
 
   new_commit ::= 'commit' sp ref_str lf
     mark?
 
   new_commit ::= 'commit' sp ref_str lf
     mark?

-    ('author' sp name sp '<' email '>' sp when lf)?
-    'committer' sp name sp '<' email '>' sp when lf
+    ('author' (sp name)? sp '<' email '>' sp when lf)?
+    'committer' (sp name)? sp '<' email '>' sp when lf

     commit_msg
     ('from' sp committish lf)?
     ('merge' sp committish lf)*
     commit_msg
     ('from' sp committish lf)?
     ('merge' sp committish lf)*


@@ -47,7 +47,7 @@ Format of STDIN stream:
 
   new_tag ::= 'tag' sp tag_str lf
     'from' sp committish lf
 
   new_tag ::= 'tag' sp tag_str lf
     'from' sp committish lf

-    ('tagger' sp name sp '<' email '>' sp when lf)?
+    ('tagger' (sp name)? sp '<' email '>' sp when lf)?

     tag_msg;
   tag_msg ::= data;
 
     tag_msg;
   tag_msg ::= data;