Commit a1b07dca7d456b5eb1f32e6f25c4f419752778b3

Ben Straub 2014-01-29T09:57:20

Document branch-creation reflog better

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
diff --git a/include/git2/branch.h b/include/git2/branch.h
index e653077..46aef32 100644
--- a/include/git2/branch.h
+++ b/include/git2/branch.h
@@ -45,7 +45,9 @@ GIT_BEGIN_DECL
  *
  * @param signature The identity that will used to populate the reflog entry
  *
- * @param log_message The one line long message to be appended to the reflog
+ * @param log_message The one line long message to be appended to the reflog.
+ * If NULL, the default is "Branch: created"; if you want something more
+ * useful, provide a message.
  *
  * @return 0, GIT_EINVALIDSPEC or an error code.
  * A proper reference is written in the refs/heads namespace