diff options
| author | Ben Straub <bs@github.com> | 2014-01-29 09:57:20 -0800 |
|---|---|---|
| committer | Ben Straub <bs@github.com> | 2014-01-30 15:53:52 -0800 |
| commit | a1b07dca7d456b5eb1f32e6f25c4f419752778b3 (patch) | |
| tree | 33e981e698d973b3478713298bd3046d3c903135 /include/git2/branch.h | |
| parent | 59bb1126e0a6d5c004f3856e23c75ae440211f1c (diff) | |
| download | libgit2-a1b07dca7d456b5eb1f32e6f25c4f419752778b3.tar.gz | |
Document branch-creation reflog better
Diffstat (limited to 'include/git2/branch.h')
| -rw-r--r-- | include/git2/branch.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/include/git2/branch.h b/include/git2/branch.h index e653077d5..46aef3206 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 |