Commit 899bd19a62c10be929103542aabbf8585de8aecd

Juan Rubén 2014-02-24T21:20:57

Document enumerator and rewording

diff --git a/examples/blame.c b/examples/blame.c
index f04c417..6bc0581 100644
--- a/examples/blame.c
+++ b/examples/blame.c
@@ -148,7 +148,7 @@ static void usage(const char *msg, const char *arg)
 	fprintf(stderr, "   -L <n,m>            process only line range n-m, counting from 1\n");
 	fprintf(stderr, "   -M                  find line moves within and across files\n");
 	fprintf(stderr, "   -C                  find line copies within and across files\n");
-	fprintf(stderr, "   -F                  only care about the first parent\n");
+	fprintf(stderr, "   -F                  follow only the first parent commits\n");
 	fprintf(stderr, "\n");
 	exit(1);
 }
diff --git a/include/git2/blame.h b/include/git2/blame.h
index 873a94d..4ad51ee 100644
--- a/include/git2/blame.h
+++ b/include/git2/blame.h
@@ -40,7 +40,8 @@ typedef enum {
 	 * commit (like `git blame -CCC`). Implies SAME_COMMIT_COPIES.
 	 * NOT IMPLEMENTED. */
 	GIT_BLAME_TRACK_COPIES_ANY_COMMIT_COPIES = (1<<3),
-
+	/** Restrict the search of commits to those reachable following only the
+	 * first parents. */
 	GIT_BLAME_FIRST_PARENT = (1<<4),
 } git_blame_flag_t;