git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v3] update-ref: add --rename option

From
Patrick Steinhardt <ps@pks.im>
Date
Jun 12, 2026, 06:00 UTC
Message-ID
<aiugat0gvprSX5yr@pks.im>
In-Reply-To
<xmqq7bo4n4ge.fsf@gitster.g>
On Thu, Jun 11, 2026 at 02:37:53PM -0700, Junio C Hamano wrote:
Show 9 quoted lines
> Add a "--rename" option to "git update-ref" with the syntax:
> 
>  $ git update-ref --rename <old-refname> <new-refname>
> 
> It renames <old-refname> together with its reflog to <new-refname>;
> even when used on a local branch ref, the current value and the
> reflog of the ref are the only things that are renamed.  Document it
> and redirect casual users to "git branch -m" if that is what they
> wanted to do.
This reads much better, thanks.
Show 11 quoted lines
> diff --git a/Documentation/git-update-ref.adoc b/Documentation/git-update-ref.adoc
> index 37a5019a8b..3b4df23a86 100644
> --- a/Documentation/git-update-ref.adoc
> +++ b/Documentation/git-update-ref.adoc
> @@ -9,6 +9,7 @@ SYNOPSIS
>  --------
>  [synopsis]
>  git update-ref [-m <reason>] [--no-deref] -d <ref> [<old-oid>]
> +git update-ref [-m <reason>] --rename <old-refname> <new-refname>
>  git update-ref [-m <reason>] [--no-deref] [--create-reflog] <ref> <new-oid> [<old-oid>]
>  git update-ref [-m <reason>] [--no-deref] --stdin [-z] [--batch-updates]
This slightly triggers my OCD, but oh, well. No need to change this.
Show 13 quoted lines
> diff --git a/builtin/update-ref.c b/builtin/update-ref.c
> index 2d68c40ecb..65ee8af08c 100644
> --- a/builtin/update-ref.c
> +++ b/builtin/update-ref.c
> @@ -800,6 +802,32 @@ int cmd_update_ref(int argc,
>  	if (end_null)
>  		usage_with_options(git_update_ref_usage, options);
>  
> +	if (rename) {
> +		const char *oldref, *newref;
> +
> +		if (delete || argc != 2)
> +			usage_with_options(git_update_ref_usage, options);

Arguably, we should also complain when either "--no-deref" or "--deref" were given, as they don't have any effect.

A slight tangent: this is part of why I really don't like commands that determine their mode via flags: you now have to worry about every combination of flags and whether they even make sense. With subcommands we at least only have to worry about the set of flags that directly apply to that given subcommand.

Makes me wonder whether I should have a look at extending git-refs(1) further:

    git refs delete <ref> [<oldvalue>]
    git refs update <ref> <newvalue> [<oldvalue>]
    git refs rename <ref> <oldname> <newname>

I always wanted to do this eventually so that we have one top-level command that knows how to do "everything refs".

Anyway, except for this nit the patch looks good to me, thanks!
Patrick
Previous: Junio C HamanoNext: Junio C Hamano
Message 8 of 12 in “update-ref: add --rename option”
  1. update-ref: add --rename optionJunio C Hamano, Jun 9, 2026
  2. update-ref: add --rename optionJunio C Hamano, Jun 10, 2026
  3. Patrick SteinhardtJun 11, 2026
  4. Junio C HamanoJun 11, 2026
  5. Patrick SteinhardtJun 12, 2026
  6. Junio C HamanoJun 12, 2026
  7. update-ref: add --rename optionJunio C Hamano, Jun 11, 2026
  8. Patrick SteinhardtJun 12, 2026
  9. Junio C HamanoJun 12, 2026
  10. Patrick SteinhardtJun 15, 2026
  11. Junio C HamanoJun 15, 2026
  12. Patrick SteinhardtJun 16, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.