update-ref: use {old,new}-oid instead of {old,new}value

[thirdparty/git.git] / Documentation / git-update-ref.txt

diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt
index 0561808cca04a6873909ad18a6fd5f6e9af8b8de..374a2ebd2b0bdaa1e0a8cb09e172f27d1fb5fada 100644 (file)
--- a/Documentation/git-update-ref.txt
+++ b/Documentation/git-update-ref.txt
@@ -8,21 +8,21 @@ git-update-ref - Update the object name stored in a ref safely
 SYNOPSIS
 --------
 [verse]
-'git update-ref' [-m <reason>] [--no-deref] (-d <ref> [<oldvalue>] | [--create-reflog] <ref> <newvalue> [<oldvalue>] | --stdin [-z])
+'git update-ref' [-m <reason>] [--no-deref] (-d <ref> [<old-oid>] | [--create-reflog] <ref> <new-oid> [<old-oid>] | --stdin [-z])
 
 DESCRIPTION
 -----------
-Given two arguments, stores the <newvalue> in the <ref>, possibly
+Given two arguments, stores the <new-oid> in the <ref>, possibly
 dereferencing the symbolic refs.  E.g. `git update-ref HEAD
-<newvalue>` updates the current branch head to the new object.
+<new-oid>` updates the current branch head to the new object.
 
-Given three arguments, stores the <newvalue> in the <ref>,
+Given three arguments, stores the <new-oid> 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>.  You can specify 40 "0" or an empty string
-as <oldvalue> to make sure that the ref you are creating does
+the current value of the <ref> matches <old-oid>.
+E.g. `git update-ref refs/heads/master <new-oid> <old-oid>`
+updates the master branch head to <new-oid> only if its current
+value is <old-oid>.  You can specify 40 "0" or an empty string
+as <old-oid> to make sure that the ref you are creating does
 not exist.
 
 It also allows a "ref" file to be a symbolic pointer to another
@@ -56,15 +56,15 @@ ref symlink to some other tree, if you have copied a whole
 archive by creating a symlink tree).
 
 With `-d` flag, it deletes the named <ref> after verifying it
-still contains <oldvalue>.
+still contains <old-oid>.
 
 With `--stdin`, update-ref reads instructions from standard input and
 performs all modifications together.  Specify commands of the form:
 
-       update SP <ref> SP <newvalue> [SP <oldvalue>] LF
-       create SP <ref> SP <newvalue> LF
-       delete SP <ref> [SP <oldvalue>] LF
-       verify SP <ref> [SP <oldvalue>] LF
+       update SP <ref> SP <new-oid> [SP <old-oid>] LF
+       create SP <ref> SP <new-oid> LF
+       delete SP <ref> [SP <old-oid>] LF
+       verify SP <ref> [SP <old-oid>] LF
        option SP <opt> LF
        start LF
        prepare LF
@@ -82,10 +82,10 @@ specify a missing value, omit the value and its preceding SP entirely.
 Alternatively, use `-z` to specify in NUL-terminated format, without
 quoting:
 
-       update SP <ref> NUL <newvalue> NUL [<oldvalue>] NUL
-       create SP <ref> NUL <newvalue> NUL
-       delete SP <ref> NUL [<oldvalue>] NUL
-       verify SP <ref> NUL [<oldvalue>] NUL
+       update SP <ref> NUL <new-oid> NUL [<old-oid>] NUL
+       create SP <ref> NUL <new-oid> NUL
+       delete SP <ref> NUL [<old-oid>] NUL
+       verify SP <ref> NUL [<old-oid>] NUL
        option SP <opt> NUL
        start NUL
        prepare NUL
@@ -100,22 +100,22 @@ recognizes as an object name.  Commands in any other format or a
 repeated <ref> produce an error.  Command meanings are:
 
 update::
-       Set <ref> to <newvalue> after verifying <oldvalue>, if given.
-       Specify a zero <newvalue> to ensure the ref does not exist
-       after the update and/or a zero <oldvalue> to make sure the
+       Set <ref> to <new-oid> after verifying <old-oid>, if given.
+       Specify a zero <new-oid> to ensure the ref does not exist
+       after the update and/or a zero <old-oid> to make sure the
        ref does not exist before the update.
 
 create::
-       Create <ref> with <newvalue> after verifying it does not
-       exist.  The given <newvalue> may not be zero.
+       Create <ref> with <new-oid> after verifying it does not
+       exist.  The given <new-oid> may not be zero.
 
 delete::
-       Delete <ref> after verifying it exists with <oldvalue>, if
-       given.  If given, <oldvalue> may not be zero.
+       Delete <ref> after verifying it exists with <old-oid>, if
+       given.  If given, <old-oid> may not be zero.
 
 verify::
-       Verify <ref> against <oldvalue> but do not change it.  If
-       <oldvalue> is zero or missing, the ref must not exist.
+       Verify <ref> against <old-oid> but do not change it.  If
+       <old-oid> is zero or missing, the ref must not exist.
 
 option::
        Modify the behavior of the next command naming a <ref>.
@@ -141,7 +141,7 @@ abort::
        Abort the transaction, releasing all locks if the transaction is in
        prepared state.
 
-If all <ref>s can be locked with matching <oldvalue>s
+If all <ref>s can be locked with matching <old-oid>s
 simultaneously, all modifications are performed.  Otherwise, no
 modifications are performed.  Note that while each individual
 <ref> is updated or deleted atomically, a concurrent reader may
@@ -161,7 +161,7 @@ formatted as:
 
 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
+<new-oid> and "committer" is the committer's name, email address
 and date in the standard Git committer ident format.
 
 Optionally with -m: