Document branch-creation reflog better

ben · ben · commit b3558d8897b8 · 2014-01-29T09:57:20.000-08:00
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,9 @@ GIT_BEGIN_DECL`
`45`	`45`	`*`
`46`	`46`	`* @param signature The identity that will used to populate the reflog entry`
`47`	`47`	`*`
`48`		`- * @param log_message The one line long message to be appended to the reflog`
	`48`	`+ * @param log_message The one line long message to be appended to the reflog.`
	`49`	`+ * If NULL, the default is "Branch: created"; if you want something more`
	`50`	`+ * useful, provide a message.`
`49`	`51`	`*`
`50`	`52`	`* @return 0, GIT_EINVALIDSPEC or an error code.`
`51`	`53`	`* A proper reference is written in the refs/heads namespace`