OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-update-ref.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-update-ref(1)">\r
5 <articleinfo>\r
6     <title>git-update-ref(1)</title>\r
7         <indexterm>\r
8                 <primary>git-update-ref(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-update-ref - Update the object name stored in a ref safely</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <simpara><emphasis>git update-ref</emphasis> [-m &lt;reason&gt;] (-d &lt;ref&gt; [&lt;oldvalue&gt;] | [--no-deref] &lt;ref&gt; &lt;newvalue&gt; [&lt;oldvalue&gt;])</simpara>\r
18 </simplesect>\r
19 <simplesect id="_description">\r
20 <title>DESCRIPTION</title>\r
21 <simpara>Given two arguments, stores the &lt;newvalue&gt; in the &lt;ref&gt;, possibly\r
22 dereferencing the symbolic refs.  E.g. <literal>git update-ref HEAD\r
23 &lt;newvalue&gt;</literal> updates the current branch head to the new object.</simpara>\r
24 <simpara>Given three arguments, stores the &lt;newvalue&gt; in the &lt;ref&gt;,\r
25 possibly dereferencing the symbolic refs, after verifying that\r
26 the current value of the &lt;ref&gt; matches &lt;oldvalue&gt;.\r
27 E.g. <literal>git update-ref refs/heads/master &lt;newvalue&gt; &lt;oldvalue&gt;</literal>\r
28 updates the master branch head to &lt;newvalue&gt; only if its current\r
29 value is &lt;oldvalue&gt;.  You can specify 40 "0" or an empty string\r
30 as &lt;oldvalue&gt; to make sure that the ref you are creating does\r
31 not exist.</simpara>\r
32 <simpara>It also allows a "ref" file to be a symbolic pointer to another\r
33 ref file by starting with the four-byte header sequence of\r
34 "ref:".</simpara>\r
35 <simpara>More importantly, it allows the update of a ref file to follow\r
36 these symbolic pointers, whether they are symlinks or these\r
37 "regular file symbolic refs".  It follows <emphasis role="strong">real</emphasis> symlinks only\r
38 if they start with "refs/": otherwise it will just try to read\r
39 them and update them as a regular file (i.e. it will allow the\r
40 filesystem to follow them, but will overwrite such a symlink to\r
41 somewhere else with a regular filename).</simpara>\r
42 <simpara>If --no-deref is given, &lt;ref&gt; itself is overwritten, rather than\r
43 the result of following the symbolic pointers.</simpara>\r
44 <simpara>In general, using</simpara>\r
45 <literallayout class="monospaced">git update-ref HEAD "$head"</literallayout>\r
46 <simpara>should be a <emphasis>lot</emphasis> safer than doing</simpara>\r
47 <literallayout class="monospaced">echo "$head" &gt; "$GIT_DIR/HEAD"</literallayout>\r
48 <simpara>both from a symlink following standpoint <emphasis role="strong">and</emphasis> an error checking\r
49 standpoint.  The "refs/" rule for symlinks means that symlinks\r
50 that point to "outside" the tree are safe: they&#8217;ll be followed\r
51 for reading but not for writing (so we&#8217;ll never write through a\r
52 ref symlink to some other tree, if you have copied a whole\r
53 archive by creating a symlink tree).</simpara>\r
54 <simpara>With <literal>-d</literal> flag, it deletes the named &lt;ref&gt; after verifying it\r
55 still contains &lt;oldvalue&gt;.</simpara>\r
56 </simplesect>\r
57 <simplesect id="_logging_updates">\r
58 <title>Logging Updates</title>\r
59 <simpara>If config parameter "core.logAllRefUpdates" is true or the file\r
60 "$GIT_DIR/logs/&lt;ref&gt;" exists then <literal>git update-ref</literal> will append\r
61 a line to the log file "$GIT_DIR/logs/&lt;ref&gt;" (dereferencing all\r
62 symbolic refs before creating the log name) describing the change\r
63 in ref value.  Log lines are formatted as:</simpara>\r
64 <orderedlist numeration="arabic">\r
65 <listitem>\r
66 <simpara>\r
67 oldsha1 SP newsha1 SP committer LF\r
68 </simpara>\r
69 <simpara>Where "oldsha1" is the 40 character hexadecimal value previously\r
70 stored in &lt;ref&gt;, "newsha1" is the 40 character hexadecimal value of\r
71 &lt;newvalue&gt; and "committer" is the committer&#8217;s name, email address\r
72 and date in the standard GIT committer ident format.</simpara>\r
73 </listitem>\r
74 </orderedlist>\r
75 <simpara>Optionally with -m:</simpara>\r
76 <orderedlist numeration="arabic">\r
77 <listitem>\r
78 <simpara>\r
79 oldsha1 SP newsha1 SP committer TAB message LF\r
80 </simpara>\r
81 <simpara>Where all fields are as described above and "message" is the\r
82 value supplied to the -m option.</simpara>\r
83 </listitem>\r
84 </orderedlist>\r
85 <simpara>An update will fail (without changing &lt;ref&gt;) if the current user is\r
86 unable to create a new log file, append to the existing log file\r
87 or does not have committer information available.</simpara>\r
88 </simplesect>\r
89 <simplesect id="_author">\r
90 <title>Author</title>\r
91 <simpara>Written by Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt;.</simpara>\r
92 </simplesect>\r
93 <simplesect id="_git">\r
94 <title>GIT</title>\r
95 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
96 </simplesect>\r
97 </article>\r