{"thread":{"id":"65420","subject":"[PATCH] docs: correct information about reftable","startedAt":"2026-04-02T22:42:56Z","lastAt":"2026-04-08T14:20:15Z","messageCount":3,"participants":["brian m. carlson","Patrick Steinhardt","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"540806","messageId":"20260402224241.4104726-1-sandals@crustytoothpaste.net","threadId":"65420","inReplyTo":null,"subject":"[PATCH] docs: correct information about reftable","fromName":"brian m. carlson","fromEmail":"sandals@crustytoothpaste.net","sentAt":"2026-04-02T22:42:41Z","receivedAt":"2026-04-02T22:42:56Z","isPatch":true,"body":"Our description of the reftable format is that it is experimental and\nsubject to change, but that is no longer true.  Remove this statement so\nas not to mislead users.\n\nIn addition, the documentation says that the files format is the\ndefault, but that is not true if breaking changes mode is on.  Correct\nthis information with a conditional.\n\nSigned-off-by: brian m. carlson <sandals@crustytoothpaste.net>\n---\nSomeone who was asking a question on the list pointed out that the docs\nstill said reftable was experimental and I said I'd send a patch to fix\nthat, so here it is.\n\nMoreover, I think the with-breaking-changes item is helpful for us to\nfind all the places that we'll need to change for Git 3.0, in addition\nto our goal of having strictly accurate documentation.\n\n Documentation/ref-storage-format.adoc | 11 ++++++++---\n 1 file changed, 8 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/ref-storage-format.adoc b/Documentation/ref-storage-format.adoc\nindex 6a8db4712b..c5e29ec831 100644\n--- a/Documentation/ref-storage-format.adoc\n+++ b/Documentation/ref-storage-format.adoc\n@@ -1,3 +1,8 @@\n-`files`;; for loose files with packed-refs. This is the default.\n-`reftable`;; for the reftable format. This format is experimental and its\n-  internals are subject to change.\n+`files`;; for loose files with packed-refs.\n+ifndef::with-breaking-changes[]\n+\tThis is the default.\n+endif::with-breaking-changes[]\n+`reftable`;; for the reftable format.\n+ifdef::with-breaking-changes[]\n+\tThis is the default.\n+endif::with-breaking-changes[]\n"},{"id":"541118","messageId":"adX65j-4Vb24GpF8@pks.im","threadId":"65420","inReplyTo":"20260402224241.4104726-1-sandals@crustytoothpaste.net","subject":"Re: [PATCH] docs: correct information about reftable","fromName":"Patrick Steinhardt","fromEmail":"ps@pks.im","sentAt":"2026-04-08T06:51:18Z","receivedAt":"2026-04-08T06:51:25Z","isPatch":true,"body":"On Thu, Apr 02, 2026 at 10:42:41PM +0000, brian m. carlson wrote:\n> Our description of the reftable format is that it is experimental and\n> subject to change, but that is no longer true.  Remove this statement so\n> as not to mislead users.\n> \n> In addition, the documentation says that the files format is the\n> default, but that is not true if breaking changes mode is on.  Correct\n> this information with a conditional.\n\nMakes sense to me, thanks!\n\nPatrick\n"},{"id":"541132","messageId":"xmqqy0ix1qlf.fsf@gitster.g","threadId":"65420","inReplyTo":"adX65j-4Vb24GpF8@pks.im","subject":"Re: [PATCH] docs: correct information about reftable","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2026-04-08T14:20:12Z","receivedAt":"2026-04-08T14:20:15Z","isPatch":true,"body":"Patrick Steinhardt <ps@pks.im> writes:\n\n> On Thu, Apr 02, 2026 at 10:42:41PM +0000, brian m. carlson wrote:\n>> Our description of the reftable format is that it is experimental and\n>> subject to change, but that is no longer true.  Remove this statement so\n>> as not to mislead users.\n>> \n>> In addition, the documentation says that the files format is the\n>> default, but that is not true if breaking changes mode is on.  Correct\n>> this information with a conditional.\n>\n> Makes sense to me, thanks!\n>\n> Patrick\n\nThanks for this ack---the patch message somehow escaped from my\nradar.  Will apply.\n\n\n\n"}]}