From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Jonathan Tan" <jonathantanmy@google.com>,
"Derrick Stolee" <stolee@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH v2 2/3] fetch: document the --negotiate-only option
Date: Thu, 8 Jul 2021 12:53:14 +0200 [thread overview]
Message-ID: <patch-2.3-f86f4fc0e6f-20210708T105034Z-avarab@gmail.com> (raw)
In-Reply-To: <cover-0.3-00000000000-20210708T105034Z-avarab@gmail.com>
There was no documentation for the --negotiate-only option added in
9c1e657a8fd (fetch: teach independent negotiation (no packfile),
2021-05-04), only documentation for the related push.negotiation
option added in the following commit in 477673d6f39 (send-pack:
support push negotiation, 2021-05-04).
Let's document it, and update the cross-linking I'd added between
--negotiation-tip=* and 'fetch.negotiationAlgorithm' in
526608284a7 (fetch doc: cross-link two new negotiation options,
2018-08-01).
I think it would be better to say "in common with the remote" here
than "...the server", but the documentation for --negotiation-tip=*
above this talks about "the server", so let's continue doing that in
this related option. See 3390e42adb3 (fetch-pack: support negotiation
tip whitelist, 2018-07-02) for that documentation.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
Documentation/config/fetch.txt | 3 ++-
Documentation/fetch-options.txt | 13 +++++++++++--
2 files changed, 13 insertions(+), 3 deletions(-)
diff --git a/Documentation/config/fetch.txt b/Documentation/config/fetch.txt
index 6af6f5edb27..63748c02b72 100644
--- a/Documentation/config/fetch.txt
+++ b/Documentation/config/fetch.txt
@@ -69,7 +69,8 @@ fetch.negotiationAlgorithm::
setting defaults to "skipping".
Unknown values will cause 'git fetch' to error out.
+
-See also the `--negotiation-tip` option for linkgit:git-fetch[1].
+See also the `--negotiate-only` and `--negotiation-tip` options to
+linkgit:git-fetch[1].
fetch.showForcedUpdates::
Set to false to enable `--no-show-forced-updates` in
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 9e7b4e189ce..e967ff1874c 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -62,8 +62,17 @@ The argument to this option may be a glob on ref names, a ref, or the (possibly
abbreviated) SHA-1 of a commit. Specifying a glob is equivalent to specifying
this option multiple times, one for each matching ref name.
+
-See also the `fetch.negotiationAlgorithm` configuration variable
-documented in linkgit:git-config[1].
+See also the `fetch.negotiationAlgorithm` and `push.negotiate`
+configuration variables documented in linkgit:git-config[1], and the
+`--negotiate-only` option below.
+
+--negotiate-only::
+ Do not fetch anything from the server, and instead print the
+ ancestors of the provided `--negotiation-tip=*` arguments,
+ which we have in common with the server.
++
+Internally this is used to implement the `push.negotiate` option, see
+linkgit:git-config[1].
--dry-run::
Show what would be done, without making any changes.
--
2.32.0.636.g43e71d69cff
next prev parent reply other threads:[~2021-07-08 10:53 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-30 16:38 [PATCH 0/3] fetch: fix segfault, missing docs in --negotiate-only Ævar Arnfjörð Bjarmason
2021-06-30 16:38 ` [PATCH 1/3] send-pack.c: move "no refs in common" abort earlier Ævar Arnfjörð Bjarmason
2021-06-30 16:38 ` [PATCH 2/3] fetch: document the --negotiate-only option Ævar Arnfjörð Bjarmason
2021-06-30 16:38 ` [PATCH 3/3] fetch: fix segfault in --negotiate-only without --negotiation-tip=* Ævar Arnfjörð Bjarmason
2021-06-30 18:01 ` Jonathan Tan
2021-07-08 10:53 ` [PATCH v2 0/3] fetch: fix segfault, missing docs in --negotiate-only Ævar Arnfjörð Bjarmason
2021-07-08 10:53 ` [PATCH v2 1/3] send-pack.c: move "no refs in common" abort earlier Ævar Arnfjörð Bjarmason
2021-07-08 10:53 ` Ævar Arnfjörð Bjarmason [this message]
2021-07-08 10:53 ` [PATCH v2 3/3] fetch: fix segfault in --negotiate-only without --negotiation-tip=* Æ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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=patch-2.3-f86f4fc0e6f-20210708T105034Z-avarab@gmail.com \
--to=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jonathantanmy@google.com \
--cc=stolee@gmail.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.
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 NNTP newsgroup(s).