Merge branch 'qn/clone-doc-use-long-form' into maint

The "git clone" documentation refers to command line options in its
description in the short form; they have been replaced with long
forms to make them more recognisable.

* qn/clone-doc-use-long-form:
  docs: git-clone: list short form of options first
  docs: git-clone: refer to long form of options
This commit is contained in:
Junio C Hamano 2019-07-29 12:38:18 -07:00
Родитель 9c65991abd bfc8c84ed5
Коммит 1cf76b7010
1 изменённых файлов: 17 добавлений и 17 удалений

Просмотреть файл

@ -22,7 +22,7 @@ DESCRIPTION
Clones a repository into a newly created directory, creates Clones a repository into a newly created directory, creates
remote-tracking branches for each branch in the cloned repository remote-tracking branches for each branch in the cloned repository
(visible using `git branch -r`), and creates and checks out an (visible using `git branch --remotes`), and creates and checks out an
initial branch that is forked from the cloned repository's initial branch that is forked from the cloned repository's
currently active branch. currently active branch.
@ -40,8 +40,8 @@ configuration variables.
OPTIONS OPTIONS
------- -------
--local::
-l:: -l::
--local::
When the repository to clone from is on a local machine, When the repository to clone from is on a local machine,
this flag bypasses the normal "Git aware" transport this flag bypasses the normal "Git aware" transport
mechanism and clones the repository by making a copy of mechanism and clones the repository by making a copy of
@ -62,8 +62,8 @@ Git transport instead.
directory instead of using hardlinks. This may be desirable directory instead of using hardlinks. This may be desirable
if you are trying to make a back-up of your repository. if you are trying to make a back-up of your repository.
--shared::
-s:: -s::
--shared::
When the repository to clone is on the local machine, When the repository to clone is on the local machine,
instead of using hard links, automatically setup instead of using hard links, automatically setup
`.git/objects/info/alternates` to share the objects `.git/objects/info/alternates` to share the objects
@ -80,13 +80,13 @@ which automatically call `git gc --auto`. (See linkgit:git-gc[1].)
If these objects are removed and were referenced by the cloned repository, If these objects are removed and were referenced by the cloned repository,
then the cloned repository will become corrupt. 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 cloned with `--shared` will copy objects from the source repository into a pack
in the cloned repository, removing the disk space savings of `clone -s`. in the cloned repository, removing the disk space savings of `clone --shared`.
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. default.
+ +
If you want to break the dependency of a repository cloned with `-s` on If you want to break the dependency of a repository cloned with `--shared` on
its source repository, you can simply run `git repack -a` to copy all its source repository, you can simply run `git repack -a` to copy all
objects from the source repository into a pack in the cloned repository. objects from the source repository into a pack in the cloned repository.
@ -115,19 +115,19 @@ objects from the source repository into a pack in the cloned repository.
same repository, and this option can be used to stop the same repository, and this option can be used to stop the
borrowing. borrowing.
--quiet::
-q:: -q::
--quiet::
Operate quietly. Progress is not reported to the standard Operate quietly. Progress is not reported to the standard
error stream. error stream.
--verbose::
-v:: -v::
--verbose::
Run verbosely. Does not affect the reporting of progress status Run verbosely. Does not affect the reporting of progress status
to the standard error stream. to the standard error stream.
--progress:: --progress::
Progress status is reported on the standard error stream 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 is specified. This flag forces progress status even if the
standard error stream is not directed to a terminal. standard error stream is not directed to a terminal.
@ -139,15 +139,15 @@ objects from the source repository into a pack in the cloned repository.
When multiple `--server-option=<option>` are given, they are all When multiple `--server-option=<option>` are given, they are all
sent to the other side in the order listed on the command line. sent to the other side in the order listed on the command line.
--no-checkout::
-n:: -n::
--no-checkout::
No checkout of HEAD is performed after the clone is complete. No checkout of HEAD is performed after the clone is complete.
--bare:: --bare::
Make a 'bare' Git repository. That is, instead of Make a 'bare' Git repository. That is, instead of
creating `<directory>` and placing the administrative creating `<directory>` and placing the administrative
files in `<directory>/.git`, make the `<directory>` files in `<directory>/.git`, make the `<directory>`
itself the `$GIT_DIR`. This obviously implies the `-n` itself the `$GIT_DIR`. This obviously implies the `--no-checkout`
because there is nowhere to check out the working tree. because there is nowhere to check out the working tree.
Also the branch heads at the remote are copied directly Also the branch heads at the remote are copied directly
to corresponding local branch heads, without mapping to corresponding local branch heads, without mapping
@ -163,13 +163,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 that all these refs are overwritten by a `git remote update` in the
target repository. target repository.
--origin <name>::
-o <name>:: -o <name>::
--origin <name>::
Instead of using the remote name `origin` to keep track Instead of using the remote name `origin` to keep track
of the upstream repository, use `<name>`. of the upstream repository, use `<name>`.
--branch <name>::
-b <name>:: -b <name>::
--branch <name>::
Instead of pointing the newly created HEAD to the branch pointed Instead of pointing the newly created HEAD to the branch pointed
to by the cloned repository's HEAD, point to `<name>` branch to by the cloned repository's HEAD, point to `<name>` branch
instead. In a non-bare repository, this is the branch that will instead. In a non-bare repository, this is the branch that will
@ -177,8 +177,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 `--branch` can also take tags and detaches the HEAD at that commit
in the resulting repository. in the resulting repository.
--upload-pack <upload-pack>::
-u <upload-pack>:: -u <upload-pack>::
--upload-pack <upload-pack>::
When given, and the repository to clone from is accessed When given, and the repository to clone from is accessed
via ssh, this specifies a non-default path for the command via ssh, this specifies a non-default path for the command
run on the other end. run on the other end.
@ -187,8 +187,8 @@ objects from the source repository into a pack in the cloned repository.
Specify the directory from which templates will be used; Specify the directory from which templates will be used;
(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].) (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
--config <key>=<value>::
-c <key>=<value>:: -c <key>=<value>::
--config <key>=<value>::
Set a configuration variable in the newly-created repository; Set a configuration variable in the newly-created repository;
this takes effect immediately after the repository is this takes effect immediately after the repository is
initialized, but before the remote history is fetched or any initialized, but before the remote history is fetched or any