Code

Merge branch 'bw/log-all-ref-updates-doc' into maint
authorJunio C Hamano <gitster@pobox.com>
Tue, 16 Aug 2011 18:41:28 +0000 (11:41 -0700)
committerJunio C Hamano <gitster@pobox.com>
Tue, 16 Aug 2011 18:41:28 +0000 (11:41 -0700)
* bw/log-all-ref-updates-doc:
  Documentation: clearly specify what refs are honored by core.logAllRefUpdates

Documentation/config.txt
Documentation/git-update-ref.txt

index 6b937771994f5b0a532b6f2cc522a9d3f35c9c09..4914d768c7c2f14abd854a58c594a4e88184047d 100644 (file)
@@ -344,7 +344,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/<ref>"
-       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".
index 2a96143b7c92d97a81eb7f8d8d425f2a1367153f..d377a352433cb38536f42c5b3fc6b80ae2b11f7f 100644 (file)
@@ -61,8 +61,9 @@ still contains <oldvalue>.
 
 Logging Updates
 ---------------
-If config parameter "core.logAllRefUpdates" is true or the file
-"$GIT_DIR/logs/<ref>" 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/<ref>" exists then `git update-ref` will append
 a line to the log file "$GIT_DIR/logs/<ref>" (dereferencing all
 symbolic refs before creating the log name) describing the change
 in ref value.  Log lines are formatted as: