From: Junio C Hamano <gitster@pobox.com>
To: "Quentin Nerden via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Quentin Nerden <quentin.nerden@gmail.com>
Subject: Re: [PATCH 1/1] docs: update git-clone doc: refer to long options
Date: Thu, 27 Jun 2019 13:10:51 -0700 [thread overview]
Message-ID: <xmqqmui2aiwk.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <0dd1b017698dd9d15f291f1133eb40dac8d85a68.1561663019.git.gitgitgadget@gmail.com> (Quentin Nerden via GitGitGadget's message of "Thu, 27 Jun 2019 12:17:00 -0700 (PDT)")
"Quentin Nerden via GitGitGadget" <gitgitgadget@gmail.com> writes:
> From: Quentin Nerden <quentin.nerden@gmail.com>
>
> To make the doc of git-clone easier to read,
> refer to the long version of the options
> (it is easier to guess what --verbose is doing than -v).
>
> Also:
> put the short options first, to match the doc of git-add, git-commit, git-clean, git-branch...
This "also" makes the patch unnecessarily harder to review.
Splitting it into two patches would make it reviewable.
Thanks.
>
> Signed-off-by: Quentin Nerden <quentin.nerden@gmail.com>
> ---
> Documentation/git-clone.txt | 28 ++++++++++++++--------------
> 1 file changed, 14 insertions(+), 14 deletions(-)
>
> diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
> index 5fc97f14de..4edc713a4b 100644
> --- a/Documentation/git-clone.txt
> +++ b/Documentation/git-clone.txt
> @@ -41,8 +41,8 @@ configuration variables.
>
> OPTIONS
> -------
> ---local::
> -l::
> +--local::
> When the repository to clone from is on a local machine,
> this flag bypasses the normal "Git aware" transport
> mechanism and clones the repository by making a copy of
> @@ -63,8 +63,8 @@ Git transport instead.
> directory instead of using hardlinks. This may be desirable
> if you are trying to make a back-up of your repository.
>
> ---shared::
> -s::
> +--shared::
> When the repository to clone is on the local machine,
> instead of using hard links, automatically setup
> `.git/objects/info/alternates` to share the objects
> @@ -81,10 +81,10 @@ which automatically call `git gc --auto`. (See linkgit:git-gc[1].)
> If these objects are removed and were referenced by the cloned repository,
> then the cloned repository will become corrupt.
> +
> -Note that running `git repack` without the `-l` option in a repository
> +Note that running `git repack` without the `--local` option in a repository
> cloned with `-s` will copy objects from the source repository into a pack
> in the cloned repository, removing the disk space savings of `clone -s`.
> -It is safe, however, to run `git gc`, which uses the `-l` option by
> +It is safe, however, to run `git gc`, which uses the `--local` option by
> default.
> +
> If you want to break the dependency of a repository cloned with `-s` on
> @@ -116,19 +116,19 @@ objects from the source repository into a pack in the cloned repository.
> same repository, and this option can be used to stop the
> borrowing.
>
> ---quiet::
> -q::
> +--quiet::
> Operate quietly. Progress is not reported to the standard
> error stream.
>
> ---verbose::
> -v::
> +--verbose::
> Run verbosely. Does not affect the reporting of progress status
> to the standard error stream.
>
> --progress::
> Progress status is reported on the standard error stream
> - by default when it is attached to a terminal, unless -q
> + by default when it is attached to a terminal, unless `--quiet`
> is specified. This flag forces progress status even if the
> standard error stream is not directed to a terminal.
>
> @@ -140,15 +140,15 @@ objects from the source repository into a pack in the cloned repository.
> When multiple `--server-option=<option>` are given, they are all
> sent to the other side in the order listed on the command line.
>
> ---no-checkout::
> -n::
> +--no-checkout::
> No checkout of HEAD is performed after the clone is complete.
>
> --bare::
> Make a 'bare' Git repository. That is, instead of
> creating `<directory>` and placing the administrative
> files in `<directory>/.git`, make the `<directory>`
> - itself the `$GIT_DIR`. This obviously implies the `-n`
> + itself the `$GIT_DIR`. This obviously implies `--no-checkout`
> because there is nowhere to check out the working tree.
> Also the branch heads at the remote are copied directly
> to corresponding local branch heads, without mapping
> @@ -164,13 +164,13 @@ objects from the source repository into a pack in the cloned repository.
> that all these refs are overwritten by a `git remote update` in the
> target repository.
>
> ---origin <name>::
> -o <name>::
> +--origin <name>::
> Instead of using the remote name `origin` to keep track
> of the upstream repository, use `<name>`.
>
> ---branch <name>::
> -b <name>::
> +--branch <name>::
> Instead of pointing the newly created HEAD to the branch pointed
> to by the cloned repository's HEAD, point to `<name>` branch
> instead. In a non-bare repository, this is the branch that will
> @@ -178,8 +178,8 @@ objects from the source repository into a pack in the cloned repository.
> `--branch` can also take tags and detaches the HEAD at that commit
> in the resulting repository.
>
> ---upload-pack <upload-pack>::
> -u <upload-pack>::
> +--upload-pack <upload-pack>::
> When given, and the repository to clone from is accessed
> via ssh, this specifies a non-default path for the command
> run on the other end.
> @@ -188,8 +188,8 @@ objects from the source repository into a pack in the cloned repository.
> Specify the directory from which templates will be used;
> (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
>
> ---config <key>=<value>::
> -c <key>=<value>::
> +--config <key>=<value>::
> Set a configuration variable in the newly-created repository;
> this takes effect immediately after the repository is
> initialized, but before the remote history is fetched or any
> @@ -274,8 +274,8 @@ or `--mirror` is given)
> The result is Git repository can be separated from working
> tree.
>
> --j <n>::
> --jobs <n>::
> +-j <n>::
> The number of submodules fetched at the same time.
> Defaults to the `submodule.fetchJobs` option.
next prev parent reply other threads:[~2019-06-27 20:11 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-27 19:16 [PATCH 0/1] Update git-clone doc: refer to long option Quentin Nerden via GitGitGadget
2019-06-27 19:17 ` [PATCH 1/1] docs: update git-clone doc: refer to long options Quentin Nerden via GitGitGadget
2019-06-27 20:10 ` Junio C Hamano [this message]
2019-06-28 11:55 ` Johannes Schindelin
2019-07-02 14:37 ` [PATCH v2 0/2] Update git-clone doc: refer to long form of the options and list short form of the options first Quentin Nerden via GitGitGadget
2019-07-02 14:37 ` [PATCH v2 1/2] docs: git-clone: refer to long form of options Quentin Nerden via GitGitGadget
2019-07-02 14:37 ` [PATCH v2 2/2] docs: git-clone: list short form of options first Quentin Nerden via GitGitGadget
2019-07-02 19:14 ` Junio C Hamano
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqmui2aiwk.fsf@gitster-ct.c.googlers.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=quentin.nerden@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.
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).