From: Bert Wesarg Date: Mon, 11 Jul 2011 09:14:18 +0000 (+0200) Subject: Documentation: clearly specify what refs are honored by core.logAllRefUpdates X-Git-Tag: v1.7.6.1~22^2 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=cd8e3711bf2dce3e2d18aac41e7f42242fbba338;p=git.git Documentation: clearly specify what refs are honored by core.logAllRefUpdates The documentation for logging updates in git-update-ref, doesn't make it clear that only a specific subset of refs are honored by this variable. Signed-off-by: Bert Wesarg Signed-off-by: Junio C Hamano --- diff --git a/Documentation/config.txt b/Documentation/config.txt index 4c36aa95b..03c822a9a 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -330,7 +330,9 @@ core.logAllRefUpdates:: SHA1, the date/time and the reason of the update, but only when the file exists. If this configuration variable is set to true, missing "$GIT_DIR/logs/" - file is automatically created for branch heads. + file is automatically created for branch heads (i.e. under + refs/heads/), remote refs (i.e. under refs/remotes/), + note refs (i.e. under refs/notes/), and the symbolic ref HEAD. + This information can be used to determine what commit was the tip of a branch "2 days ago". diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt index 9639f705a..c7d086d5e 100644 --- a/Documentation/git-update-ref.txt +++ b/Documentation/git-update-ref.txt @@ -60,8 +60,9 @@ still contains . Logging Updates --------------- -If config parameter "core.logAllRefUpdates" is true or the file -"$GIT_DIR/logs/" exists then `git update-ref` will append +If config parameter "core.logAllRefUpdates" is true and the ref is one under +"refs/heads/", "refs/remotes/", "refs/notes/", or the symbolic ref HEAD; or +the file "$GIT_DIR/logs/" exists then `git update-ref` will append a line to the log file "$GIT_DIR/logs/" (dereferencing all symbolic refs before creating the log name) describing the change in ref value. Log lines are formatted as: