All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Julia Evans via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org,  "D. Ben Knoble" <ben.knoble@gmail.com>,
	 Julia Evans <julia@jvns.ca>
Subject: Re: [PATCH v4 0/7] doc: git-checkout: clarify DESCRIPTION section
Date: Wed, 17 Sep 2025 11:38:48 -0700	[thread overview]
Message-ID: <xmqq8qicdivb.fsf@gitster.g> (raw)
In-Reply-To: <pull.1962.v4.git.1757531669.gitgitgadget@gmail.com> (Julia Evans via GitGitGadget's message of "Wed, 10 Sep 2025 19:14:22 +0000")

"Julia Evans via GitGitGadget" <gitgitgadget@gmail.com> writes:

> Changes in v4:
>
>  * Rewrite all the commit messages to try to take a more Problem / Solution
>    approach, from Junio's review and thanks to help from @nasamuffin in
>    Discord. Also change the cover letter format to match the style in
>    https://lore.kernel.org/git/CAOLa=ZStgwBN0fMK3YxoqeR+1i772f621supva3Kvr7YPq4g8g@mail.gmail.com/T/#m8c99a3144cbdfb445e04f8f83a79364bfe8d797d
>    , which hopefully matches the norms of this mailing list better.
>  * Try a different approach to the "left unchanged...", from Junio's review
>  * Bring back "index" (with a few hints about what the word might mean),
>    from Junio's review.
>  * Bring back the numbered list at the beginning from v1, since I think I
>    misunderstood a comment about lists, and that the original was clearer
>  * Fix an issue I noticed in -B ("instead of failing", not "instead of
>    creating it")
>  * Add a comma after branch or commit, to try to make it clear what "either"
>    refers to in that sentence
>  * Replace "will fail without making any changes" throughout with just "will
>    fail". I think the default assumption is that Git will fail operations in
>    a clean way, and that cases where it does not fail cleanly are the
>    exceptions that the documentation should flag.

Thanks for updating.  After re-reading these over, I think the
updated text is a vast improvement.  Also, after waiting for a
while, we haven't heard much more comments on these changes.

Shall we congratulate a job very well done, declare victory, and
merge these down to 'next' now?

Thanks.

      parent reply	other threads:[~2025-09-17 18:38 UTC|newest]

Thread overview: 68+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-25 19:08 [PATCH 0/5] doc: git-checkout: clarify DESCRIPTION section Julia Evans via GitGitGadget
2025-08-25 19:08 ` [PATCH 1/5] doc: git-checkout: clarify intro Julia Evans via GitGitGadget
2025-08-26 18:46   ` Junio C Hamano
2025-08-26 18:51     ` Junio C Hamano
2025-08-26 20:56     ` Julia Evans
2025-08-28 14:00   ` D. Ben Knoble
2025-08-28 22:34     ` Julia Evans
2025-08-28 23:44       ` Junio C Hamano
2025-08-29 13:39         ` D. Ben Knoble
2025-08-29 21:00     ` Junio C Hamano
2025-09-03 23:48       ` D. Ben Knoble
2025-08-25 19:08 ` [PATCH 2/5] doc: git-checkout: clarify `git checkout <branch>` Julia Evans via GitGitGadget
2025-08-26 21:38   ` Junio C Hamano
2025-08-28 12:11     ` Julia Evans
2025-08-28 15:45       ` Junio C Hamano
2025-08-28 18:24         ` Julia Evans
2025-08-25 19:08 ` [PATCH 3/5] doc: git-checkout: don't use "reset" Julia Evans via GitGitGadget
2025-08-25 19:08 ` [PATCH 4/5] doc: git-checkout: deduplicate --detach explanation Julia Evans via GitGitGadget
2025-08-25 19:08 ` [PATCH 5/5] doc: git-checkout: clarify restoring files section Julia Evans via GitGitGadget
2025-08-26 22:43   ` Junio C Hamano
2025-08-28 13:26     ` Julia Evans
2025-08-28 19:08   ` D. Ben Knoble
2025-08-28 19:59     ` Julia Evans
2025-08-28 20:38       ` Junio C Hamano
2025-08-29 13:48       ` D. Ben Knoble
2025-08-29 11:45 ` [PATCH v2 0/5] doc: git-checkout: clarify DESCRIPTION section Julia Evans via GitGitGadget
2025-08-29 11:45   ` [PATCH v2 1/5] doc: git-checkout: clarify intro Julia Evans via GitGitGadget
2025-08-29 15:58     ` Junio C Hamano
2025-09-02 17:14       ` Julia Evans
2025-08-29 11:45   ` [PATCH v2 2/5] doc: git-checkout: clarify `git checkout <branch>` Julia Evans via GitGitGadget
2025-08-29 16:03     ` Junio C Hamano
2025-09-02 17:16       ` Julia Evans
2025-08-29 11:45   ` [PATCH v2 3/5] doc: git-checkout: don't use "reset" Julia Evans via GitGitGadget
2025-08-29 16:22     ` Junio C Hamano
2025-09-01 14:28       ` Julia Evans
2025-09-02 16:10         ` Junio C Hamano
2025-08-29 11:45   ` [PATCH v2 4/5] doc: git-checkout: deduplicate --detach explanation Julia Evans via GitGitGadget
2025-08-29 11:45   ` [PATCH v2 5/5] doc: git-checkout: clarify restoring files section Julia Evans via GitGitGadget
2025-09-03 16:49   ` [PATCH v3 0/6] doc: git-checkout: clarify DESCRIPTION section Julia Evans via GitGitGadget
2025-09-03 16:49     ` [PATCH v3 1/6] doc: git-checkout: clarify intro Julia Evans via GitGitGadget
2025-09-03 16:49     ` [PATCH v3 2/6] doc: git-checkout: clarify `git checkout <branch>` Julia Evans via GitGitGadget
2025-09-03 16:49     ` [PATCH v3 3/6] doc: git-checkout: clarify `-b` and `-B` Julia Evans via GitGitGadget
2025-09-03 16:50     ` [PATCH v3 4/6] doc: git-checkout: deduplicate --detach explanation Julia Evans via GitGitGadget
2025-09-03 16:50     ` [PATCH v3 5/6] doc: git-checkout: split up restoring files section Julia Evans via GitGitGadget
2025-09-03 16:50     ` [PATCH v3 6/6] doc: git-checkout: clarify " Julia Evans via GitGitGadget
2025-09-03 21:29       ` Junio C Hamano
2025-09-03 21:09     ` [PATCH v3 0/6] doc: git-checkout: clarify DESCRIPTION section Junio C Hamano
2025-09-03 21:28       ` Julia Evans
2025-09-10 19:14     ` [PATCH v4 0/7] " Julia Evans via GitGitGadget
2025-09-10 19:14       ` [PATCH v4 1/7] doc: git-checkout: clarify intro sentence Julia Evans via GitGitGadget
2025-09-10 19:14       ` [PATCH v4 2/7] doc: git-checkout: clarify ARGUMENT DISAMBIGUATION Julia Evans via GitGitGadget
2025-09-10 19:14       ` [PATCH v4 3/7] doc: git-checkout: clarify `git checkout <branch>` Julia Evans via GitGitGadget
2025-09-10 19:14       ` [PATCH v4 4/7] doc: git-checkout: clarify `-b` and `-B` Julia Evans via GitGitGadget
2025-09-29 18:07         ` Kristoffer Haugsbakk
2025-10-02 18:37           ` [PATCH] doc: git-checkout: fix placeholder markup kristofferhaugsbakk
2025-10-16 22:11             ` [PATCH resend] " kristofferhaugsbakk
2025-10-17 13:56               ` Julia Evans
2025-10-17 15:50               ` [PATCH v2] " kristofferhaugsbakk
2025-09-10 19:14       ` [PATCH v4 5/7] doc: git-checkout: deduplicate --detach explanation Julia Evans via GitGitGadget
2025-09-10 19:14       ` [PATCH v4 6/7] doc: git-checkout: split up restoring files section Julia Evans via GitGitGadget
2025-09-10 19:14       ` [PATCH v4 7/7] doc: git-checkout: clarify " Julia Evans via GitGitGadget
2025-09-11 13:01       ` [PATCH v4 0/7] doc: git-checkout: clarify DESCRIPTION section Ben Knoble
2025-09-12 14:05         ` Julia Evans
2025-09-12 14:26           ` Kristoffer Haugsbakk
2025-09-15 23:22             ` Junio C Hamano
2025-09-16  6:41               ` Kristoffer Haugsbakk
2025-09-12 16:23           ` Junio C Hamano
2025-09-17 18:38       ` Junio C Hamano [this message]

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=xmqq8qicdivb.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=ben.knoble@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=julia@jvns.ca \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.