pretty.h: update and expand docstring for userformat_find_requirements()

[thirdparty/git.git] / pretty.h

diff --git a/pretty.h b/pretty.h
index f034609e4db6e68efb24a149c580fc7bda3c4cfa..c81cf40d387b95592b7ce9f895d70c75e687f34d 100644 (file)
--- a/pretty.h
+++ b/pretty.h
@@ -65,12 +65,15 @@ static inline int cmit_fmt_is_mail(enum cmit_fmt fmt)
        return (fmt == CMIT_FMT_EMAIL || fmt == CMIT_FMT_MBOXRD);
 }
 
+/*
+ * Examine the user-specified format given by "fmt" (or if NULL, the global one
+ * previously saved by get_commit_format()), and set flags based on which items
+ * the format will need when it is expanded.
+ */
 struct userformat_want {
        unsigned notes:1;
        unsigned source:1;
 };
-
-/* Set the flag "w->notes" if there is placeholder %N in "fmt". */
 void userformat_find_requirements(const char *fmt, struct userformat_want *w);
 
 /*