man1/git-update-ref.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "GIT-UPDATE-REF" 1 "" "" ""
  21 .SH NAME
  22 git-update-ref \- update the object name stored in a ref safely
  23 .SH "SYNOPSIS"
  24
  25
  26 \fIgit\-update\-ref\fR [\-m <reason>] <ref> <newvalue> [<oldvalue>]
  27
  28 .SH "DESCRIPTION"
  29
  30
  31 Given two arguments, stores the <newvalue> in the <ref>, possibly dereferencing the symbolic refs\&. E\&.g\&. git\-update\-ref HEAD <newvalue> updates the current branch head to the new object\&.
  32
  33
  34 Given three arguments, stores the <newvalue> in the <ref>, possibly dereferencing the symbolic refs, after verifying that the current value of the <ref> matches <oldvalue>\&. E\&.g\&. git\-update\-ref refs/heads/master <newvalue> <oldvalue> updates the master branch head to <newvalue> only if its current value is <oldvalue>\&.
  35
  36
  37 It also allows a "ref" file to be a symbolic pointer to another ref file by starting with the four\-byte header sequence of "ref:"\&.
  38
  39
  40 More importantly, it allows the update of a ref file to follow these symbolic pointers, whether they are symlinks or these "regular file symbolic refs"\&. It follows \fIreal\fR symlinks only if they start with "refs/": otherwise it will just try to read them and update them as a regular file (i\&.e\&. it will allow the filesystem to follow them, but will overwrite such a symlink to somewhere else with a regular filename)\&.
  41
  42
  43 In general, using
  44
  45 .nf
  46 git\-update\-ref HEAD "$head"
  47 .fi
  48
  49
  50 should be a _lot_ safer than doing
  51
  52 .nf
  53 echo "$head" > "$GIT_DIR/HEAD"
  54 .fi
  55
  56
  57 both from a symlink following standpoint \fIand\fR an error checking standpoint\&. The "refs/" rule for symlinks means that symlinks that point to "outside" the tree are safe: they'll be followed 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)\&.
  58
  59 .SH "LOGGING UPDATES"
  60
  61
  62 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:
  63
  64 .TP 3
  65 1.
  66 oldsha1 SP newsha1 SP committer LF
  67
  68 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\&.
  69 .LP
  70
  71
  72 Optionally with \-m:
  73
  74 .TP 3
  75 1.
  76 oldsha1 SP newsha1 SP committer TAB message LF
  77
  78 Where all fields are as described above and "message" is the value supplied to the \-m option\&.
  79 .LP
  80
  81
  82 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\&.
  83
  84 .SH "AUTHOR"
  85
  86
  87 Written by Linus Torvalds <torvalds@osdl\&.org>\&.
  88
  89 .SH "GIT"
  90
  91
  92 Part of the \fBgit\fR(7) suite
  93