git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* Bug: git-fetch man page does not document --filter
       [not found] <DM6PR15MB359467B7277CDA31029A6630BB089@DM6PR15MB3594.namprd15.prod.outlook.com>
@ 2021-06-23  9:36 ` Mike Moreton
  2021-06-23 16:56   ` Taylor Blau
  0 siblings, 1 reply; 2+ messages in thread
From: Mike Moreton @ 2021-06-23  9:36 UTC (permalink / raw)
  To: git@vger.kernel.org

See subject.  Looking at https://git-scm.com/docs/git-fetch

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: Bug: git-fetch man page does not document --filter
  2021-06-23  9:36 ` Bug: git-fetch man page does not document --filter Mike Moreton
@ 2021-06-23 16:56   ` Taylor Blau
  0 siblings, 0 replies; 2+ messages in thread
From: Taylor Blau @ 2021-06-23 16:56 UTC (permalink / raw)
  To: Mike Moreton; +Cc: git@vger.kernel.org

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


^ permalink raw reply related	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2021-06-23 16:56 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
     [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

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).