Update documentation for git-format-patch

diff --git a/ident.c b/ident.c
index bc89e1d04c63563c051005754a50247f22256974..7c81fe8d8bfc4c76324277dc7daa39c76ed12cd3 100644 (file)
--- a/ident.c
+++ b/ident.c
@@ -140,7 +140,7 @@ static int copy(char *buf, int size, int offset, const char *src)
 
        /*
         * Copy the rest to the buffer, but avoid the special
-        * characters '\n' '<' and '>' that act as delimeters on
+        * characters '\n' '<' and '>' that act as delimiters on
         * a identification line
         */
        for (i = 0; i < len; i++) {
@@ -156,7 +156,18 @@ static int copy(char *buf, int size, int offset, const char *src)
        return offset;
 }
 
-char *get_ident(const char *name, const char *email, const char *date_str)
+static const char au_env[] = "GIT_AUTHOR_NAME";
+static const char co_env[] = "GIT_COMMITTER_NAME";
+static const char *env_hint =
+"\n*** Environment problem:\n"
+"*** Your name cannot be determined from your system services (gecos).\n"
+"*** You would need to set %s and %s\n"
+"*** environment variables; otherwise you won't be able to perform\n"
+"*** certain operations because of \"empty ident\" errors.\n"
+"*** Alternatively, you can use user.name configuration variable.\n\n";
+
+static const char *get_ident(const char *name, const char *email,
+                            const char *date_str, int error_on_no_name)
 {
        static char buffer[1000];
        char date[50];
@@ -166,6 +177,16 @@ char *get_ident(const char *name, const char *email, const char *date_str)
                name = git_default_name;
        if (!email)
                email = git_default_email;
+
+       if (!*name) {
+               if (name == git_default_name && env_hint) {
+                       fprintf(stderr, env_hint, au_env, co_env);
+                       env_hint = NULL; /* warn only once, for "git-var -l" */
+               }
+               if (error_on_no_name)
+                       die("empty ident %s <%s> not allowed", name, email);
+       }
+
        strcpy(date, git_default_date);
        if (date_str)
                parse_date(date_str, date, sizeof(date));
@@ -181,12 +202,18 @@ char *get_ident(const char *name, const char *email, const char *date_str)
        return buffer;
 }
 
-char *git_author_info(void)
+const char *git_author_info(int error_on_no_name)
 {
-       return get_ident(getenv("GIT_AUTHOR_NAME"), getenv("GIT_AUTHOR_EMAIL"), getenv("GIT_AUTHOR_DATE"));
+       return get_ident(getenv("GIT_AUTHOR_NAME"),
+                        getenv("GIT_AUTHOR_EMAIL"),
+                        getenv("GIT_AUTHOR_DATE"),
+                        error_on_no_name);
 }
 
-char *git_committer_info(void)
+const char *git_committer_info(int error_on_no_name)
 {
-       return get_ident(getenv("GIT_COMMITTER_NAME"), getenv("GIT_COMMITTER_EMAIL"), getenv("GIT_COMMITTER_DATE"));
+       return get_ident(getenv("GIT_COMMITTER_NAME"),
+                        getenv("GIT_COMMITTER_EMAIL"),
+                        getenv("GIT_COMMITTER_DATE"),
+                        error_on_no_name);
 }