SYNOPSIS

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 <new-oid> in the <ref>, possibly dereferencing the symbolic refs. E.g. git update-ref HEAD <new-oid> updates the current branch head to the new object.

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 <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.

The final arguments are object names; this command without any options does not support updating a symbolic ref to point to another ref (see git-symbolic-ref(1)). But git update-ref --stdin does have the symref-* commands so that regular refs and symbolic refs can be committed in the same transaction.

--no-deref を指定すると、シンボリックポインターをたどった結果ではなく、<ref>自体が上書きされます。

With -d, it deletes the named <ref> after verifying that it still contains <old-oid>.

--stdin を使用すると、update-refは標準入力から命令を読み取り、すべての変更を一緒に実行します。 以下の形式のコマンドを指定します:

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
symref-update SP <ref> SP <new-target> [SP (ref SP <old-target> | oid SP <old-oid>)] LF
symref-create SP <ref> SP <new-target> LF
symref-delete SP <ref> [SP <old-target>] LF
symref-verify SP <ref> [SP <old-target>] LF
option SP <opt> LF
start LF
prepare LF
commit LF
abort LF

--create-reflog を使用すると、update-refは、通常は作成されない場合でも、各refのreflogを作成します。

Cソースコードの文字列であるかのように空白を含むフィールドをクォートします。 つまり、二重引用符で囲まれ、バックスラッシュ(\)でエスケープされます。 ゼロ値(zero value)を指定するには、40個の "0" 文字または空の文字列を使用します。 欠落している値(missing value)を指定するには、値とその前のSPを完全に省略します。

あるいは、 -z を使用して、クォートせずに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
symref-update SP <ref> NUL <new-target> [NUL (ref NUL <old-target> | oid NUL <old-oid>)] NUL
symref-create SP <ref> NUL <new-target> NUL
symref-delete SP <ref> [NUL <old-target>] NUL
symref-verify SP <ref> [NUL <old-target>] NUL
option SP <opt> NUL
start NUL
prepare NUL
commit NUL
abort NUL

この形式では、40個の "0" を使用してゼロ値(zero value)を指定し、空の文字列を使用して欠落している値(missing value)を指定します。

どちらの形式でも、Gitがオブジェクト名として認識する任意の形式で値を指定できます。他の形式のコマンドまたは繰り返される<ref>は、エラーを生成します。 コマンドの意味は以下のとおりです:

update

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 <new-oid> after verifying it does not exist. The given <new-oid> may not be zero.

delete

Delete <ref> after verifying it exists with <old-oid>, if given. If given, <old-oid> may not be zero.

symref-update

Set <ref> to <new-target> after verifying <old-target> or <old-oid>, if given. Specify a zero <old-oid> to ensure that the ref does not exist before the update.

verify

Verify <ref> against <old-oid> but do not change it. If <old-oid> is zero or missing, the ref must not exist.

symref-create: Create symbolic ref <ref> with <new-target> after verifying it does not exist.

symref-delete

Delete <ref> after verifying it exists with <old-target>, if given.

symref-verify

Verify symbolic <ref> against <old-target> but do not change it. If <old-target> is missing, the ref must not exist. Can only be used in no-deref mode.

option

Modify the behavior of the next command naming a <ref>. The only valid option is no-deref to avoid dereferencing a symbolic ref.

start

トランザクションを開始します。 非トランザクションセッションとは対照的に、セッションが明示的なコミットなしで終了すると、トランザクションは自動的に中止(abort)されます。 このコマンドは、現在のトランザクションがすでにコミットまたは中止(abort)されている場合に、新しい空のトランザクションを作成する場合があります。

prepare

トランザクションをコミットする準備をします。 これにより、キューに入れられたすべての参照更新のロックファイルが作成されます。 ロックできない参照がある場合、トランザクションは中止(abort)されます。

commit

トランザクションのためにキューに入れられたすべての参照更新をコミットし、トランザクションを終了(ending)します。

abort

トランザクションを中止(abort)し、トランザクションが準備済み状態(prepared state)の場合はすべてのロックを解除します。

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 still see a subset of the modifications.

LOGGING UPDATES

構成パラメーター core.logAllRefUpdates `がtrueで、参照が `refs/heads/ の下にある場合、 refs/remotes/ または refs/notes/ または HEADやORIG_HEADのような疑似参照 または ファイル $GIT_DIR/logs/<ref> が存在する場合に、 git update-ref はログファイル $GIT_DIR/logs/<ref> にref値の変更を説明する行を追加します(ログ名を作成する前に、すべてのシンボリックrefを間接参照します)。 ログ行は以下のようにフォーマットされます:

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 <new-oid> and "committer" is the committer’s name, email address and date in the standard Git committer ident format.

オプションで -m と一緒に使用すると:

oldsha1 SP newsha1 SP committer TAB message LF

これは、すべてのフィールドが上記のとおりであり、「message」が -m オプションに指定された値です。

現在のユーザーが新しいログファイルを作成できない場合、既存のログファイルに追加できない場合、またはコミッター情報が利用できない場合、更新は（<ref>を変更せずに）失敗します。

NOTES

Symbolic refs were initially implemented using symbolic links. This is now deprecated since not all filesystems support symbolic links.

This command follows real 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).

SEE ALSO

git-symbolic-ref(1)

GIT

Part of the git(1) suite