Skip to content

Commit 22d9b79

Browse files
committed
Merge branch 'bw/log-all-ref-updates-doc' into maint
* bw/log-all-ref-updates-doc: Documentation: clearly specify what refs are honored by core.logAllRefUpdates
2 parents cd145e7 + cd8e371 commit 22d9b79

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

Documentation/config.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,9 @@ core.logAllRefUpdates::
344344
SHA1, the date/time and the reason of the update, but
345345
only when the file exists. If this configuration
346346
variable is set to true, missing "$GIT_DIR/logs/<ref>"
347-
file is automatically created for branch heads.
347+
file is automatically created for branch heads (i.e. under
348+
refs/heads/), remote refs (i.e. under refs/remotes/),
349+
note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
348350
+
349351
This information can be used to determine what commit
350352
was the tip of a branch "2 days ago".

Documentation/git-update-ref.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,9 @@ still contains <oldvalue>.
6161

6262
Logging Updates
6363
---------------
64-
If config parameter "core.logAllRefUpdates" is true or the file
65-
"$GIT_DIR/logs/<ref>" exists then `git update-ref` will append
64+
If config parameter "core.logAllRefUpdates" is true and the ref is one under
65+
"refs/heads/", "refs/remotes/", "refs/notes/", or the symbolic ref HEAD; or
66+
the file "$GIT_DIR/logs/<ref>" exists then `git update-ref` will append
6667
a line to the log file "$GIT_DIR/logs/<ref>" (dereferencing all
6768
symbolic refs before creating the log name) describing the change
6869
in ref value. Log lines are formatted as:

0 commit comments

Comments
 (0)