summaryrefslogtreecommitdiffstats
path: root/git-update-ref.txt
diff options
context:
space:
mode:
authorJunio C Hamano <junio@hera.kernel.org>2006-06-04 07:24:48 +0000
committerJunio C Hamano <junio@hera.kernel.org>2006-06-04 07:24:48 +0000
commit341071d878757c06a3931db660fe318effc8317e (patch)
tree8cb7bf28351c062adbe71172b942a3228d40725d /git-update-ref.txt
parentbb8fb05ed082c81af81f9eecf356f993e2ef83b7 (diff)
downloadgit-htmldocs-341071d878757c06a3931db660fe318effc8317e.tar.gz
Autogenerated HTML docs for v1.3.3-g16a4
Diffstat (limited to 'git-update-ref.txt')
-rw-r--r--git-update-ref.txt28
1 files changed, 27 insertions, 1 deletions
diff --git a/git-update-ref.txt b/git-update-ref.txt
index 475237f19..e062030e9 100644
--- a/git-update-ref.txt
+++ b/git-update-ref.txt
@@ -7,7 +7,7 @@ git-update-ref - update the object name stored in a ref safely
SYNOPSIS
--------
-'git-update-ref' <ref> <newvalue> [<oldvalue>]
+'git-update-ref' [-m <reason>] <ref> <newvalue> [<oldvalue>]
DESCRIPTION
-----------
@@ -49,6 +49,32 @@ for reading but not for writing (so we'll never write through a
ref symlink to some other tree, if you have copied a whole
archive by creating a symlink tree).
+Logging Updates
+---------------
+If config parameter "core.logAllRefUpdates" is true 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:
+
+ . oldsha1 SP newsha1 SP committer LF
++
+Where "oldsha1" is the 40 character hexadecimal value previously
+stored in <ref>, "newsha1" is the 40 character hexadecimal value of
+<newvalue> and "committer" is the committer's name, email address
+and date in the standard GIT committer ident format.
+
+Optionally with -m:
+
+ . oldsha1 SP newsha1 SP committer TAB message LF
++
+Where all fields are as described above and "message" is the
+value supplied to the -m option.
+
+An update will fail (without changing <ref>) if the current user is
+unable to create a new log file, append to the existing log file
+or does not have committer information available.
+
Author
------
Written by Linus Torvalds <torvalds@osdl.org>.