Skip to content

Commit cd8e371

Browse files
bertwesarggitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent e923eae commit cd8e371

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
@@ -330,7 +330,9 @@ core.logAllRefUpdates::
330330
SHA1, the date/time and the reason of the update, but
331331
only when the file exists. If this configuration
332332
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.
334336
+
335337
This information can be used to determine what commit
336338
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
@@ -60,8 +60,9 @@ still contains <oldvalue>.
6060

6161
Logging Updates
6262
---------------
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
6566
a line to the log file "$GIT_DIR/logs/<ref>" (dereferencing all
6667
symbolic refs before creating the log name) describing the change
6768
in ref value. Log lines are formatted as:

0 commit comments

Comments
 (0)