summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2011-07-22 21:43:51 (GMT)
committerJunio C Hamano <gitster@pobox.com>2011-07-22 21:43:51 (GMT)
commitef6663b3dbb3d63b993078477b8b21d9af64e8e5 (patch)
tree499f52480c0dccb3dbfff9ff342231dc5facd4c0
parentb07522797915c1f907d7b7547510e659ddf01df5 (diff)
parentcd8e3711bf2dce3e2d18aac41e7f42242fbba338 (diff)
downloadgit-ef6663b3dbb3d63b993078477b8b21d9af64e8e5.zip
git-ef6663b3dbb3d63b993078477b8b21d9af64e8e5.tar.gz
git-ef6663b3dbb3d63b993078477b8b21d9af64e8e5.tar.bz2
Merge branch 'bw/log-all-ref-updates-doc'
* bw/log-all-ref-updates-doc: Documentation: clearly specify what refs are honored by core.logAllRefUpdates
-rw-r--r--Documentation/config.txt4
-rw-r--r--Documentation/git-update-ref.txt5
2 files changed, 6 insertions, 3 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt
index b56959b..0658ffb 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -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".
diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt
index 2a96143..d377a35 100644
--- a/Documentation/git-update-ref.txt
+++ b/Documentation/git-update-ref.txt
@@ -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: