Re: [PATCH 0/6] doc: update-ref: amend old material and discuss symrefs

From: Taylor Blau <me@ttaylorr.com>
Date: Oct 16, 2024, 20:54 UTC
Message-ID: <ZxAoFUDmdfZ8rlLs@nand.local>
In-Reply-To: <cover.1729017728.git.code@khaugsbakk.name>

On Tue, Oct 15, 2024 at 09:03:09PM +0200, kristofferhaugsbakk@fastmail.com wrote:

Show 11 quoted lines

> Kristoffer Haugsbakk (6):
>   doc: update-ref: drop “flag”
>   doc: update-ref: remove safety paragraphs
>   doc: update-ref: demote symlink to last section
>   doc: update-ref: remove confusing paragraph
>   doc: update-ref: discuss symbolic links
>   doc: mutually link update-ref and symbolic-ref
>
>  Documentation/git-symbolic-ref.txt |  4 +++
>  Documentation/git-update-ref.txt   | 48 +++++++++++++-----------------
>  2 files changed, 25 insertions(+), 27 deletions(-)

Thanks for working on this. These changes generally looked good to me (although seeing smart-quotes in the commit messages was a little surprising ;-)).

I'm making a note for the next WC report to expect a new round that corrects the subject line of the penultimate patch "doc: update-ref: discuss symbolic links".

As a general note, prefixing commits with "doc: update-ref: " is a little strange to me. I think I might have instead written:

    Documentation/git-update-ref.txt: remove safety paragraphs

, and so on. I left a couple of other small notes, but I don't think any of them are urgent to address, though it would be nice.

Thanks for working on this and improving Git's documentation.

Thanks, Taylor