git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Taylor Blau <me@ttaylorr.com>
To: Mike Moreton <mmoreton@lifesize.com>
Cc: "git@vger.kernel.org" <git@vger.kernel.org>
Subject: Re: Bug: git-fetch man page does not document --filter
Date: Wed, 23 Jun 2021 12:56:34 -0400	[thread overview]
Message-ID: <YNNnwm3xxstHMn1M@nand.local> (raw)
In-Reply-To: <DM6PR15MB35943E5232F67765D4FAFFD1BB089@DM6PR15MB3594.namprd15.prod.outlook.com>

On Wed, Jun 23, 2021 at 09:36:53AM +0000, Mike Moreton wrote:
> See subject.  Looking at https://git-scm.com/docs/git-fetch

Thanks for noticing. It seems like an oversight to me, so I added a
little bit of text in the patch below.

--- >8 ---

Subject: [PATCH] Documentation/git-fetch.txt: add documentation on '--filter'

`git fetch` accepts a `--filter=<spec>` option, but does not document
it. Make sure that git-fetch(1) mentions that --filter is accepted.

The documentation itself is just the first and last sentence of what is
mentioned in git-clone(1), with an additional detail about interacting
with non-promisor remotes.

Reported-by: Mike Moreton <mmoreton@lifesize.com>
Signed-off-by: Taylor Blau <me@ttaylorr.com>
---
 Documentation/fetch-options.txt | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 9e7b4e189c..52755572a9 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -11,6 +11,16 @@
 	Use an atomic transaction to update local refs. Either all refs are
 	updated, or on error, no refs are updated.

+ifndef::git-pull[]
+--filter=<filter-spec>::
+	Use the partial clone feature and request that the server sends
+	a subset of reachable objects according to a given object
+	filter. When using a `--filter` while fetching from a
+	non-promisor remote, that remote is registered as a promisor.
+	For more details on filter specifications, see the `--filter`
+	option in linkgit:git-rev-list[1].
+endif::git-pull[]
+
 --depth=<depth>::
 	Limit fetching to the specified number of commits from the tip of
 	each remote branch history. If fetching to a 'shallow' repository
--
2.31.1.163.ga65ce7f831


      reply	other threads:[~2021-06-23 16:56 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <DM6PR15MB359467B7277CDA31029A6630BB089@DM6PR15MB3594.namprd15.prod.outlook.com>
2021-06-23  9:36 ` Bug: git-fetch man page does not document --filter Mike Moreton
2021-06-23 16:56   ` Taylor Blau [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=YNNnwm3xxstHMn1M@nand.local \
    --to=me@ttaylorr.com \
    --cc=git@vger.kernel.org \
    --cc=mmoreton@lifesize.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).