[PATCH] Documentation: clearly specify what refs are honored by core.logAllRefUpdates
- From
Bert Wesarg <bert.wesarg@googlemail.com>
- Date
- Jul 11, 2011, 09:14 UTC
- Message-ID
- <c63583df97ff8dd596d16d4471041d6ebedb67e8.1310375571.git.bert.wesarg@googlemail.com>
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>
---
The initial justification in 4057deb (Junio C Hamano, 2006-10-08), leaves the impression, that a blacklist would have made more sense, than the current whitelist. Maybe we can change this? --- Documentation/config.txt | 4 +++- Documentation/git-update-ref.txt | 5 +++-- 2 files changed, 6 insertions(+), 3 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt index c631d1c..dd44122 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 reafs (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 e25a65a..18fce69 100644 --- a/Documentation/git-update-ref.txt +++ b/Documentation/git-update-ref.txt @@ -60,8 +60,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:
-- 1.7.5.517.g10515