From: Jeff King <peff@peff.net>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: git@vger.kernel.org, "Junio C Hamano" <gitster@pobox.com>,
"Ben Peart" <Ben.Peart@microsoft.com>,
"Eric Sunshine" <sunshine@sunshineco.com>,
"Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>
Subject: Re: [PATCH] config doc: add missing list separator for checkout.optimizeNewBranch
Date: Tue, 18 Sep 2018 13:13:17 -0400 [thread overview]
Message-ID: <20180918171317.GB15470@sigill.intra.peff.net> (raw)
In-Reply-To: <20180918053449.14047-1-avarab@gmail.com>
On Tue, Sep 18, 2018 at 05:34:49AM +0000, Ævar Arnfjörð Bjarmason wrote:
> The documentation added in fa655d8411 ("checkout: optimize "git
> checkout -b <new_branch>"", 2018-08-16) didn't add the double-colon
> needed for the labeled list separator, as a result the added
> documentation all got squashed into one paragraph. Fix that by adding
> the list separator.
Obviously the right thing to do, but your patch does not seem to apply
on that commit. Looks like you built it on a more recent commit that
also has checkout.defaultRemote (i.e., probably 'next')?
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index ac71ade256..1546833213 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -1153,7 +1153,7 @@ and by linkgit:git-worktree[1] when 'git worktree add' refers to a
> remote branch. This setting might be used for other checkout-like
> commands or functionality in the future.
>
> -checkout.optimizeNewBranch
> +checkout.optimizeNewBranch::
> Optimizes the performance of "git checkout -b <new_branch>" when
> using sparse-checkout. When set to true, git will not update the
> repo based on the current sparse-checkout settings. This means it
Now the real reason I responded. :)
I just want to plug the recently-added "doc-diff" script, which diffs a
rendered view and makes it easier to catch cases like this. E.g., after
applying your patch:
$ cd Documentation
$ ./doc-diff HEAD^ HEAD
[...]
diff --git a/6ad88fd5d99b8dcbb69c6f3239ad41e66516d8f7/none/share/man/man1/git-config.1 b/28e258682021a09cd7842e4edbb21ad231c8bb7a/none/share/man/man1/git-config.1
index 7298292112..fa91b5f2d1 100644
--- a/6ad88fd5d99b8dcbb69c6f3239ad41e66516d8f7/none/share/man/man1/git-config.1
+++ b/28e258682021a09cd7842e4edbb21ad231c8bb7a/none/share/man/man1/git-config.1
@@ -1533,12 +1533,13 @@ CONFIGURATION FILE
branch. This setting might be used for other checkout-like commands
or functionality in the future.
- checkout.optimizeNewBranch Optimizes the performance of "git checkout
- -b <new_branch>" when using sparse-checkout. When set to true, git will
- not update the repo based on the current sparse-checkout settings. This
- means it will not update the skip-worktree bit in the index nor
- add/remove files in the working directory to reflect the current sparse
- checkout settings nor will it show the local changes.
+ checkout.optimizeNewBranch
+ Optimizes the performance of "git checkout -b <new_branch>" when
+ using sparse-checkout. When set to true, git will not update the
+ repo based on the current sparse-checkout settings. This means it
+ will not update the skip-worktree bit in the index nor add/remove
+ files in the working directory to reflect the current sparse
+ checkout settings nor will it show the local changes.
clean.requireForce
A boolean to make git-clean do nothing unless given -f, -i or -n.
Obviously we knew this fix was going to help, but running it on the
original fa655d8411 (versus its parent) and eyeballing the result might
have caught this sooner.
(Though I would not be at all surprised to hear that the script does not
run on Windows, as it relies on things like "man"; patches certainly
welcome).
-Peff
next prev parent reply other threads:[~2018-09-18 17:13 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-07-24 18:01 [PATCH v1] checkout: optionally speed up "git checkout -b foo" Ben Peart
2018-07-24 18:42 ` Eric Sunshine
2018-07-24 19:45 ` Ben Peart
2018-07-26 15:04 ` Junio C Hamano
2018-07-26 18:59 ` Eric Sunshine
2018-07-26 19:08 ` Eric Sunshine
2018-07-24 19:21 ` Junio C Hamano
2018-07-24 20:47 ` Ben Peart
2018-07-31 16:39 ` [PATCH v2] checkout: optimize "git checkout -b <new_branch>" Ben Peart
2018-07-31 20:01 ` Junio C Hamano
2018-08-01 15:10 ` Duy Nguyen
2018-08-02 18:02 ` Ben Peart
2018-08-03 15:58 ` Duy Nguyen
2018-08-06 14:25 ` Ben Peart
2018-08-15 21:05 ` Ben Peart
2018-08-05 8:57 ` Duy Nguyen
2018-08-16 18:27 ` [PATCH v3] " Ben Peart
2018-08-16 18:37 ` Duy Nguyen
2018-08-17 12:37 ` Ben Peart
2018-08-19 1:44 ` Elijah Newren
2018-08-20 13:40 ` Ben Peart
2018-08-20 18:16 ` Elijah Newren
2018-08-21 14:51 ` Duy Nguyen
2018-08-30 17:22 ` Elijah Newren
2018-09-04 16:46 ` Duy Nguyen
2018-08-20 18:31 ` Junio C Hamano
2018-09-18 5:34 ` [PATCH] config doc: add missing list separator for checkout.optimizeNewBranch Ævar Arnfjörð Bjarmason
2018-09-18 16:57 ` Taylor Blau
2018-09-18 17:16 ` Jeff King
2018-09-18 17:20 ` Taylor Blau
2018-09-18 17:13 ` Jeff King [this message]
2018-09-19 4:41 ` Ævar Arnfjörð Bjarmason
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180918171317.GB15470@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=Ben.Peart@microsoft.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=pclouds@gmail.com \
--cc=sunshine@sunshineco.com \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).