From: Taylor Blau <me@ttaylorr.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Jakub Wilk <jwilk@jwilk.net>,
git@vger.kernel.org, Eric Wong <normalperson@yhbt.net>
Subject: Re: [PATCH] git-clone.txt: document -4 and -6
Date: Tue, 2 Jan 2024 14:56:50 -0500 [thread overview]
Message-ID: <ZZRqgmDycyAXCrGZ@nand.local> (raw)
In-Reply-To: <xmqq1qivd8d0.fsf@gitster.g>
On Thu, Jun 01, 2023 at 03:06:35PM +0900, Junio C Hamano wrote:
> Jakub Wilk <jwilk@jwilk.net> writes:
>
> > These options were added in c915f11eb4 ("connect & http: support -4 and
> > -6 switches for remote operations").
> >
> > Signed-off-by: Jakub Wilk <jwilk@jwilk.net>
> > ---
> > Documentation/git-clone.txt | 8 ++++++++
> > 1 file changed, 8 insertions(+)
>
> The patch is not _wrong_ per-se, but there are other options that
> are common among the "fetch" family of commands. I counted at least
> these should be shared between "fetch" and "clone", by splitting
> them out of "fetch-options.txt" into a new file, and including that
> new file from "fetch-options.txt" and "git-clone.txt". Those marked
> with (?) are described in different phrasing between "clone" and
> "fetch", and may fall into the "let's keep them separate, because
> they mean different things" category (later):
>
> * --jobs
> * --upload-pack
> * --quiet (?)
> * --verbose (?)
> * --progress
> * --server-option
> * --ipv[46]
>
> Note that these happen to share the same name, but to "clone" and
> "fetch" they different things, so leaving them separate is the right
> thing to do.
>
> * --no-tags
> * --recurse-submodules
I wrote this ugly shell incantation to find an exhaustive list of
potentially shareable options:
$ grep '^-.*::$' <Documentation/fetch-options.txt |
tr -d ':' | sed -e 's/\[=/=[/' -e 's/<[^>]*>//' |
grep -Eo '^[^=]+' | awk -F] '
/\[no-\]/ { print "--" $2; print "--no-" $2; next }
{ print $0 }
' |
while read arg
do
if grep -Fwq -- $arg Documentation/fetch-options.txt &&
grep -Fwq -- $arg Documentation/git-clone.txt
then
echo $arg;
fi
done
It turned up the following results:
-a
--depth
--shallow-since
--shallow-exclude
--no-tags
--recurse-submodules
-j, --jobs
-u, --upload-pack
-q, --quiet
-v, --verbose
--progress
-o, --server-option
-a is a false-positive (it comes from "you can simply run `git repack
-a`", which is in the clone documentation).
Even though depth, and the shallow options are shared by both fetch and
clone, they have different wording in each context, so they should be
kept separate.
I agree with your thinking that `--no-tags` and `--recurse-submodules`
should be kept separate.
That makes our two lists equal (modulo the --ipv[46] options, which were
previously not documented in git-clone(1) until this patch).
Thanks,
Taylor
next prev parent reply other threads:[~2024-01-02 19:56 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-27 12:38 [PATCH] git-clone.txt: document -4 and -6 Jakub Wilk
2023-06-01 6:06 ` Junio C Hamano
2024-01-02 18:58 ` Jakub Wilk
2024-01-02 19:56 ` Taylor Blau [this message]
2024-01-02 20:36 ` Taylor Blau
2024-01-02 22:15 ` Junio C Hamano
2024-01-02 22:25 ` Taylor Blau
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=ZZRqgmDycyAXCrGZ@nand.local \
--to=me@ttaylorr.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jwilk@jwilk.net \
--cc=normalperson@yhbt.net \
/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 read-only IMAP folder(s) and NNTP newsgroup(s).