Documentation/git-update-ref.txt

   1 git-update-ref(1)
   2 =================
   3
   4 NAME
   5 ----
   6 git-update-ref - Update the object name stored in a ref safely
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'git update-ref' [-m <reason>] (-d <ref> [<oldvalue>] | [--no-deref] <ref> <newvalue> [<oldvalue>] | --stdin [-z])
  12
  13 DESCRIPTION
  14 -----------
  15 Given two arguments, stores the <newvalue> in the <ref>, possibly
  16 dereferencing the symbolic refs.  E.g. `git update-ref HEAD
  17 <newvalue>` updates the current branch head to the new object.
  18
  19 Given three arguments, stores the <newvalue> in the <ref>,
  20 possibly dereferencing the symbolic refs, after verifying that
  21 the current value of the <ref> matches <oldvalue>.
  22 E.g. `git update-ref refs/heads/master <newvalue> <oldvalue>`
  23 updates the master branch head to <newvalue> only if its current
  24 value is <oldvalue>.  You can specify 40 "0" or an empty string
  25 as <oldvalue> to make sure that the ref you are creating does
  26 not exist.
  27
  28 It also allows a "ref" file to be a symbolic pointer to another
  29 ref file by starting with the four-byte header sequence of
  30 "ref:".
  31
  32 More importantly, it allows the update of a ref file to follow
  33 these symbolic pointers, whether they are symlinks or these
  34 "regular file symbolic refs".  It follows *real* symlinks only
  35 if they start with "refs/": otherwise it will just try to read
  36 them and update them as a regular file (i.e. it will allow the
  37 filesystem to follow them, but will overwrite such a symlink to
  38 somewhere else with a regular filename).
  39
  40 If --no-deref is given, <ref> itself is overwritten, rather than
  41 the result of following the symbolic pointers.
  42
  43 In general, using
  44
  45         git update-ref HEAD "$head"
  46
  47 should be a _lot_ safer than doing
  48
  49         echo "$head" > "$GIT_DIR/HEAD"
  50
  51 both from a symlink following standpoint *and* an error checking
  52 standpoint.  The "refs/" rule for symlinks means that symlinks
  53 that point to "outside" the tree are safe: they'll be followed
  54 for reading but not for writing (so we'll never write through a
  55 ref symlink to some other tree, if you have copied a whole
  56 archive by creating a symlink tree).
  57
  58 With `-d` flag, it deletes the named <ref> after verifying it
  59 still contains <oldvalue>.
  60
  61 With `--stdin`, update-ref reads instructions from standard input and
  62 performs all modifications together.  Specify commands of the form:
  63
  64         update SP <ref> SP <newvalue> [SP <oldvalue>] LF
  65         create SP <ref> SP <newvalue> LF
  66         delete SP <ref> [SP <oldvalue>] LF
  67         verify SP <ref> [SP <oldvalue>] LF
  68         option SP <opt> LF
  69
  70 Quote fields containing whitespace as if they were strings in C source
  71 code; i.e., surrounded by double-quotes and with backslash escapes.
  72 Use 40 "0" characters or the empty string to specify a zero value.  To
  73 specify a missing value, omit the value and its preceding SP entirely.
  74
  75 Alternatively, use `-z` to specify in NUL-terminated format, without
  76 quoting:
  77
  78         update SP <ref> NUL <newvalue> NUL [<oldvalue>] NUL
  79         create SP <ref> NUL <newvalue> NUL
  80         delete SP <ref> NUL [<oldvalue>] NUL
  81         verify SP <ref> NUL [<oldvalue>] NUL
  82         option SP <opt> NUL
  83
  84 In this format, use 40 "0" to specify a zero value, and use the empty
  85 string to specify a missing value.
  86
  87 In either format, values can be specified in any form that Git
  88 recognizes as an object name.  Commands in any other format or a
  89 repeated <ref> produce an error.  Command meanings are:
  90
  91 update::
  92         Set <ref> to <newvalue> after verifying <oldvalue>, if given.
  93         Specify a zero <newvalue> to ensure the ref does not exist
  94         after the update and/or a zero <oldvalue> to make sure the
  95         ref does not exist before the update.
  96
  97 create::
  98         Create <ref> with <newvalue> after verifying it does not
  99         exist.  The given <newvalue> may not be zero.
 100
 101 delete::
 102         Delete <ref> after verifying it exists with <oldvalue>, if
 103         given.  If given, <oldvalue> may not be zero.
 104
 105 verify::
 106         Verify <ref> against <oldvalue> but do not change it.  If
 107         <oldvalue> zero or missing, the ref must not exist.
 108
 109 option::
 110         Modify behavior of the next command naming a <ref>.
 111         The only valid option is `no-deref` to avoid dereferencing
 112         a symbolic ref.
 113
 114 If all <ref>s can be locked with matching <oldvalue>s
 115 simultaneously, all modifications are performed.  Otherwise, no
 116 modifications are performed.  Note that while each individual
 117 <ref> is updated or deleted atomically, a concurrent reader may
 118 still see a subset of the modifications.
 119
 120 Logging Updates
 121 ---------------
 122 If config parameter "core.logAllRefUpdates" is true and the ref is one under
 123 "refs/heads/", "refs/remotes/", "refs/notes/", or the symbolic ref HEAD; or
 124 the file "$GIT_DIR/logs/<ref>" exists then `git update-ref` will append
 125 a line to the log file "$GIT_DIR/logs/<ref>" (dereferencing all
 126 symbolic refs before creating the log name) describing the change
 127 in ref value.  Log lines are formatted as:
 128
 129     . oldsha1 SP newsha1 SP committer LF
 130 +
 131 Where "oldsha1" is the 40 character hexadecimal value previously
 132 stored in <ref>, "newsha1" is the 40 character hexadecimal value of
 133 <newvalue> and "committer" is the committer's name, email address
 134 and date in the standard Git committer ident format.
 135
 136 Optionally with -m:
 137
 138     . oldsha1 SP newsha1 SP committer TAB message LF
 139 +
 140 Where all fields are as described above and "message" is the
 141 value supplied to the -m option.
 142
 143 An update will fail (without changing <ref>) if the current user is
 144 unable to create a new log file, append to the existing log file
 145 or does not have committer information available.
 146
 147 GIT
 148 ---
 149 Part of the linkgit:git[1] suite