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 <bert.wesarg@googlemail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Bert Wesarg committed
Jul 11, 2011 at 11:14 UTC
cd8e3711bf2dce3e2d18aac41e7f42242fbba338
2 files changed
+6
-3
Documentation/config.txt
+3
-1
@@ -330,7 +330,9 @@ core.logAllRefUpdates::
330
SHA1, the date/time and the reason of the update, but
331
only when the file exists. If this configuration
332
variable is set to true, missing "$GIT_DIR/logs/<ref>"
333
- file is automatically created for branch heads.
333
+ file is automatically created for branch heads (i.e. under
334
+ refs/heads/), remote refs (i.e. under refs/remotes/),
335
+ note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
336
+
337
This information can be used to determine what commit
338
was the tip of a branch "2 days ago".
Documentation/git-update-ref.txt
+3
-2
@@ -60,8 +60,9 @@ still contains <oldvalue>.
60
61
Logging Updates
62
---------------
63
-If config parameter "core.logAllRefUpdates" is true or the file
64
-"$GIT_DIR/logs/<ref>" exists then `git update-ref` will append
63
+If config parameter "core.logAllRefUpdates" is true and the ref is one under
64
+"refs/heads/", "refs/remotes/", "refs/notes/", or the symbolic ref HEAD; or
65
+the file "$GIT_DIR/logs/<ref>" exists then `git update-ref` will append
66
a line to the log file "$GIT_DIR/logs/<ref>" (dereferencing all
67
symbolic refs before creating the log name) describing the change
68
in ref value. Log lines are formatted as: