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

Re: [PATCH v3 4/5] builtin/refs: add "create" subcommand

From
Patrick Steinhardt <ps@pks.im>
Date
Jul 6, 2026, 07:12 UTC
Message-ID
<aktVdaB2xRk-iI_8@pks.im>
In-Reply-To
<87qzlk2m0h.fsf@emacs.iotcl.com>
On Fri, Jul 03, 2026 at 04:19:58PM +0200, Toon Claes wrote:
Show 37 quoted lines
> Patrick Steinhardt <ps@pks.im> writes:
> > diff --git a/Documentation/git-refs.adoc b/Documentation/git-refs.adoc
> > index 6475bdcc62..e6a3528349 100644
> > --- a/Documentation/git-refs.adoc
> > +++ b/Documentation/git-refs.adoc
> > @@ -181,6 +184,53 @@ static int cmd_refs_optimize(int argc, const char **argv, const char *prefix,
> >  	return pack_refs_core(argc, argv, prefix, repo, refs_optimize_usage);
> >  }
> >  
> > +static int cmd_refs_create(int argc, const char **argv, const char *prefix,
> > +			   struct repository *repo)
> > +{
> > +	static char const * const refs_create_usage[] = {
> > +		REFS_CREATE_USAGE,
> > +		NULL
> > +	};
> > +	const char *message = NULL;
> > +	unsigned flags = 0;
> > +	struct option opts[] = {
> > +		OPT_STRING(0, "message", &message, N_("reason"),
> > +			   N_("reason of the update")),
> > +		OPT_BIT(0 ,"no-deref", &flags,
> > +			N_("update <refname> not the one it points to"),
> > +			REF_NO_DEREF),
> 
> Can `git refs create --no-deref` be used to create symrefs? Should we
> add a test for that? Or can it not
> 
> I understand the symmetry, but does it make sense to ask the user to
> create symrefs with `--no-deref`? Feels a bit obscure. The docs say:
> 
> `--no-deref`::
> 	Operate on <ref> itself rather than the reference it points to via a
> 	symbolic ref.
> 
> That's far from obvious for a user to realize they need to pass that
> option if they want to create a symref.

It doesn't cause them to create a symref. What this flag controls is whether the command would fail when the refname exists already as a symbolic ref. That is:

    $ git symbolic-ref refs/heads/symref refs/heads/target
    $ git refs create refs/heads/symref $OID
    $ git refs exists refs/heads/target

The git-refs(1) command would have created "refs/heads/target" in this case, and by passing "--no-deref" you'd instead make it fail.

This flag is somewhat weird. Having it is probably a sensible think to do, but now that I think about it I wonder whether the default makes all that much sense in the first place. That being said, _if_ we want to change it then we should change it for all subcommands.

Show 6 quoted lines
> > diff --git a/t/t1466-refs-create.sh b/t/t1466-refs-create.sh
> > new file mode 100755
> > index 0000000000..cfb21bf863
> > --- /dev/null
> > +++ b/t/t1466-refs-create.sh
> > @@ -0,0 +1,151 @@
[snip]
Show 29 quoted lines
> > +test_expect_success 'create fails when the reference already exists' '
> > +	test_when_finished "rm -rf repo" &&
> > +	setup_repo repo &&
> > +	(
> > +		cd repo &&
> > +		A=$(git rev-parse A) &&
> > +		B=$(git rev-parse B) &&
> > +		git refs create refs/heads/foo $A &&
> > +		test_must_fail git refs create refs/heads/foo $B 2>err &&
> > +		test_grep "reference already exists" err &&
> > +		test_ref_matches refs/heads/foo "$A"
> > +	)
> > +'
> 
> I was curious about this test:
> 
> 	test_expect_success 'create succeed when the reference exists with the same value' '
> 		test_when_finished "rm -rf repo" &&
> 		setup_repo repo &&
> 		(
> 			cd repo &&
> 			A=$(git rev-parse A) &&
> 			git refs create refs/heads/foo $A &&
> 			git refs create refs/heads/foo $A &&
> 			test_ref_matches refs/heads/foo "$A"
> 		)
> 	'
> 
> That fails. It that intentional?

Yes, this is intentional. We didn't end up creating the reference, which is what the user has asked us to do, and hence we fail.

[snip]
Show 32 quoted lines
> > +test_expect_success 'create with symref target and --no-deref refuses to create reference' '
> > +	test_when_finished "rm -rf repo" &&
> > +	setup_repo repo &&
> > +	(
> > +		cd repo &&
> > +		A=$(git rev-parse A) &&
> > +		git symbolic-ref refs/heads/symref refs/heads/target &&
> > +		test_must_fail git refs create --no-deref refs/heads/symref $A 2>err &&
> > +		test_grep "dangling symref already exists" err &&
> > +		test_must_fail git reflog exists refs/heads/target
> > +	)
> > +'
> 
> Would it make sense to add this test:
> 
> 	test_expect_success 'create with symref target with --no-deref' '
> 		test_when_finished "rm -rf repo" &&
> 		setup_repo repo &&
> 		(
> 			cd repo &&
> 			A=$(git rev-parse A) &&
> 			git refs create refs/heads/target $A &&
> 			git refs create --no-deref refs/heads/symref refs/heads/target &&
> 			git reflog exists refs/heads/symref && false
> 		)
> 	'
> 
> But that makes me think, this option `--no-deref` is pretty obscure for
> use with `git refs create`. There are two situations:
> 
> * The symref doesn't exists: so --no-deref basically is forcing the
>   command to create a symref. That's confusing

No, it's not. It tells us that we only want to create the reference if it doesn't exist and is not a symref. Otherwise, we'd potentially create the reference that the symref is pointing to.

Patrick
Previous: Toon ClaesNext: Toon Claes
Message 33 of 47 in “builtin/refs: add ability to write references”
  1. 0/4 builtin/refs: add ability to write referencesPatrick Steinhardt, Jun 16, 2026
  2. 1/4 builtin/refs: drop `the_repository`Patrick Steinhardt, Jun 16, 2026
  3. 2/4 builtin/refs: add "delete" subcommandPatrick Steinhardt, Jun 16, 2026
  4. 3/4 builtin/refs: add "update" subcommandPatrick Steinhardt, Jun 16, 2026
  5. Junio C HamanoJun 16, 2026
  6. Patrick SteinhardtJun 17, 2026
  7. Junio C HamanoJun 17, 2026
  8. Junio C HamanoJun 16, 2026
  9. Patrick SteinhardtJun 17, 2026
  10. 4/4 builtin/refs: add "rename" subcommandPatrick Steinhardt, Jun 16, 2026
  11. Junio C HamanoJun 16, 2026
  12. Patrick SteinhardtJun 17, 2026
  13. Junio C HamanoJun 17, 2026
  14. 0/5 builtin/refs: add ability to write referencesPatrick Steinhardt, Jun 17, 2026
  15. 1/5 builtin/refs: drop `the_repository`Patrick Steinhardt, Jun 17, 2026
  16. 2/5 builtin/refs: add "delete" subcommandPatrick Steinhardt, Jun 17, 2026
  17. 3/5 builtin/refs: add "update" subcommandPatrick Steinhardt, Jun 17, 2026
  18. 4/5 builtin/refs: add "create" subcommandPatrick Steinhardt, Jun 17, 2026
  19. Junio C HamanoJun 29, 2026
  20. Patrick SteinhardtJun 30, 2026
  21. 5/5 builtin/refs: add "rename" subcommandPatrick Steinhardt, Jun 17, 2026
  22. Junio C HamanoJun 17, 2026
  23. Junio C HamanoJun 29, 2026
  24. Patrick SteinhardtJun 30, 2026
  25. 0/5 builtin/refs: add ability to write referencesPatrick Steinhardt, Jun 30, 2026
  26. 1/5 builtin/refs: drop `the_repository`Patrick Steinhardt, Jun 30, 2026
  27. 2/5 builtin/refs: add "delete" subcommandPatrick Steinhardt, Jun 30, 2026
  28. Toon ClaesJul 3, 2026
  29. Patrick SteinhardtJul 3, 2026
  30. 3/5 builtin/refs: add "update" subcommandPatrick Steinhardt, Jun 30, 2026
  31. 4/5 builtin/refs: add "create" subcommandPatrick Steinhardt, Jun 30, 2026
  32. Toon ClaesJul 3, 2026
  33. Patrick SteinhardtJul 6, 2026
  34. Toon ClaesJul 9, 2026
  35. Toon ClaesJul 9, 2026
  36. 5/5 builtin/refs: add "rename" subcommandPatrick Steinhardt, Jun 30, 2026
  37. Toon ClaesJul 3, 2026
  38. Patrick SteinhardtJul 6, 2026
  39. Junio C HamanoJun 30, 2026
  40. 0/5 builtin/refs: add ability to write referencesPatrick Steinhardt, Jul 6, 2026
  41. 1/5 builtin/refs: drop `the_repository`Patrick Steinhardt, Jul 6, 2026
  42. 2/5 builtin/refs: add "delete" subcommandPatrick Steinhardt, Jul 6, 2026
  43. Toon ClaesJul 9, 2026
  44. 3/5 builtin/refs: add "update" subcommandPatrick Steinhardt, Jul 6, 2026
  45. 4/5 builtin/refs: add "create" subcommandPatrick Steinhardt, Jul 6, 2026
  46. 5/5 builtin/refs: add "rename" subcommandPatrick Steinhardt, Jul 6, 2026
  47. Junio C HamanoJul 6, 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.