Re: Bug: git-fetch man page does not document --filter

From: Taylor Blau <me@ttaylorr.com>
Date: Jun 23, 2021, 16:56 UTC
Message-ID: <YNNnwm3xxstHMn1M@nand.local>
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