public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail•com>
To: "Karthik Nayak" <karthik.188@gmail•com>,
	"Phillip Wood" <phillip.wood@dunelm•org.uk>,
	"Junio C Hamano" <gitster@pobox•com>,
	"Bence Ferdinandy" <bence@ferdinandy•com>
Cc: git@vger•kernel.org
Subject: Re: with git update-ref?
Date: Sun, 13 Oct 2024 17:39:30 +0200	[thread overview]
Message-ID: <ef5a38af-e2bf-49f3-8611-6134970f829b@app.fastmail.com> (raw)
In-Reply-To: <CAOLa=ZQJy1ZkQqBoWwJJvL0f+NCP=3SAfyeSNuztgApzNH1mGg@mail.gmail.com>


On Sun, Oct 13, 2024, at 14:09, karthik nayak wrote:
>
> I agree, the documentation here could use some cleanup. The confusion
> here lies around
>
>     It also allows a "ref" file to be a symbolic pointer to another ref
>     file by starting with the four-byte header sequence of "ref:".
>
> This is added to talk about how the command de-references symbolic refs,
> but it can be misinterpreted to mean that it does support symbolic refs
> on the top level.
>
> Do either of you want to take a stab at updating the documentation here?
>
>> That seems in line with a plumbing command.
>>
>> --
>> Kristoffer Haugsbakk
>
> Attachments:
> * signature.asc

I wonder if the third (It also) and the fourth
(about FS symlinks) could be removed. The
third is confusing like Bernard said and the
fourth doesn't seem relevant enough any more. Not relevant enough to be part of Description.

And the "safety" paragraphs could be moved
to its own section. Because it looks like it's meant as an advice to unlearn the habits of a Git user from, I don't know, 2005 maybe.

  reply	other threads:[~2024-10-13 15:40 UTC|newest]

Thread overview: 54+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-11 20:51 ref: with git update-ref? Bence Ferdinandy
2024-10-11 20:56 ` Kristoffer Haugsbakk
2024-10-11 21:04   ` Bence Ferdinandy
2024-10-11 21:28     ` Junio C Hamano
2024-10-12 19:41       ` Bence Ferdinandy
2024-10-13  9:34       ` Phillip Wood
2024-10-13 10:07         ` Kristoffer Haugsbakk
2024-10-13 12:09           ` karthik nayak
2024-10-13 15:39             ` Kristoffer Haugsbakk [this message]
2024-10-13 20:40               ` Bence Ferdinandy
2024-10-14 15:06             ` Kristoffer Haugsbakk
2024-10-15 19:03             ` [PATCH 0/6] doc: update-ref: amend old material and discuss symrefs kristofferhaugsbakk
2024-10-15 19:03               ` [PATCH 1/6] doc: update-ref: drop “flag” kristofferhaugsbakk
2024-10-16 20:45                 ` Taylor Blau
2024-10-16 22:08                   ` Eric Sunshine
2024-10-16 22:09                     ` Taylor Blau
2024-10-17 15:30                       ` Kristoffer Haugsbakk
2024-10-17 16:31                         ` Eric Sunshine
2024-10-17 18:50                           ` Taylor Blau
2024-10-15 19:03               ` [PATCH 2/6] doc: update-ref: remove safety paragraphs kristofferhaugsbakk
2024-10-16 20:47                 ` Taylor Blau
2024-10-15 19:03               ` [PATCH 3/6] doc: update-ref: demote symlink to last section kristofferhaugsbakk
2024-10-15 19:03               ` [PATCH 4/6] doc: update-ref: remove confusing paragraph kristofferhaugsbakk
2024-10-16 20:51                 ` Taylor Blau
2024-10-16 20:55                   ` Kristoffer Haugsbakk
2024-10-16 20:57                     ` Taylor Blau
2024-10-15 19:03               ` [PATCH 5/6] doc: update-ref: discuss symbolic links kristofferhaugsbakk
2024-10-15 19:08                 ` Kristoffer Haugsbakk
2024-10-16 20:52                   ` Taylor Blau
2024-10-15 19:03               ` [PATCH 6/6] doc: mutually link update-ref and symbolic-ref kristofferhaugsbakk
2024-10-16  8:51               ` [PATCH 0/6] doc: update-ref: amend old material and discuss symrefs Bence Ferdinandy
2024-10-16 20:54               ` Taylor Blau
2024-10-16 21:00                 ` Kristoffer Haugsbakk
2024-10-19 19:59               ` [PATCH v2 " kristofferhaugsbakk
2024-10-19 19:59                 ` [PATCH v2 1/6] Documentation/git-update-ref.txt: drop “flag” kristofferhaugsbakk
2024-10-20 11:09                   ` karthik nayak
2024-10-19 19:59                 ` [PATCH v2 2/6] Documentation/git-update-ref.txt: remove safety paragraphs kristofferhaugsbakk
2024-10-20 11:13                   ` karthik nayak
2024-10-20 12:30                     ` Kristoffer Haugsbakk
2024-10-20 16:24                     ` Kristoffer Haugsbakk
2024-10-19 19:59                 ` [PATCH v2 3/6] Documentation/git-update-ref.txt: demote symlink to last section kristofferhaugsbakk
2024-10-19 19:59                 ` [PATCH v2 4/6] Documentation/git-update-ref.txt: remove confusing paragraph kristofferhaugsbakk
2024-10-19 19:59                 ` [PATCH v2 5/6] Documentation/git-update-ref.txt: discuss symbolic refs kristofferhaugsbakk
2024-10-19 19:59                 ` [PATCH v2 6/6] Documentation: mutually link update-ref and symbolic-ref kristofferhaugsbakk
2024-10-20 11:16                 ` [PATCH v2 0/6] doc: update-ref: amend old material and discuss symrefs karthik nayak
2024-10-21 20:47                 ` [PATCH v3 " kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 1/6] Documentation/git-update-ref.txt: drop “flag” kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 2/6] Documentation/git-update-ref.txt: remove safety paragraphs kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 3/6] Documentation/git-update-ref.txt: demote symlink to last section kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 4/6] Documentation/git-update-ref.txt: remove confusing paragraph kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 5/6] Documentation/git-update-ref.txt: discuss symbolic refs kristofferhaugsbakk
2024-10-21 20:47                   ` [PATCH v3 6/6] Documentation: mutually link update-ref and symbolic-ref kristofferhaugsbakk
2024-10-21 20:50                   ` [PATCH v3 0/6] doc: update-ref: amend old material and discuss symrefs Taylor Blau
2024-10-12  6:25 ` ref: with git update-ref? Andreas Schwab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ef5a38af-e2bf-49f3-8611-6134970f829b@app.fastmail.com \
    --to=kristofferhaugsbakk@fastmail$(echo .)com \
    --cc=bence@ferdinandy$(echo .)com \
    --cc=git@vger$(echo .)kernel.org \
    --cc=gitster@pobox$(echo .)com \
    --cc=karthik.188@gmail$(echo .)com \
    --cc=phillip.wood@dunelm$(echo .)org.uk \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox