undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'bg/clone-doc'

Browse Source 
* bg/clone-doc:
  git-clone.txt: Fix grammar and formatting
This commit is contained in:
Junio C Hamano 2009-10-25 18:40:20 -07:00
commit c9155dcc0c
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Documentation/git-clone.txt
View File

@ -39,7 +39,7 @@ OPTIONS
--local:: --local::
-l:: -l::
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 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
HEAD and everything under objects and refs directories. HEAD and everything under objects and refs directories.
The files under `.git/objects/` directory are hardlinked The files under `.git/objects/` directory are hardlinked
@ -60,7 +60,7 @@ OPTIONS
-s:: -s::
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
with the source repository. The resulting repository with the source repository. The resulting repository
starts out without any object of its own. starts out without any object of its own.
+ +
@ -69,7 +69,7 @@ it unless you understand what it does. If you clone your
repository using this option and then delete branches (or use any repository using this option and then delete branches (or use any
other git command that makes any existing commit unreferenced) in the other git command that makes any existing commit unreferenced) in the
source repository, some objects may become unreferenced (or dangling). source repository, some objects may become unreferenced (or dangling).
These objects may be removed by normal git operations (such as 'git-commit') These objects may be removed by normal git operations (such as `git commit`)
which automatically call `git gc --auto`. (See linkgit:git-gc[1].) 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.
@ -86,13 +86,13 @@ objects from the source repository into a pack in the cloned repository.
--reference <repository>:: --reference <repository>::
If the reference repository is on the local machine, If the reference repository is on the local machine,
automatically setup .git/objects/info/alternates to automatically setup `.git/objects/info/alternates` to
obtain objects from the reference repository. Using obtain objects from the reference repository. Using
an already existing repository as an alternate will an already existing repository as an alternate will
require fewer objects to be copied from the repository require fewer objects to be copied from the repository
being cloned, reducing network and local storage costs. being cloned, reducing network and local storage costs.
+ +
*NOTE*: see NOTE to --shared option. *NOTE*: see the NOTE for the `--shared` option.
--quiet:: --quiet::
-q:: -q::
@ -101,7 +101,7 @@ objects from the source repository into a pack in the cloned repository.
--verbose:: --verbose::
-v:: -v::
Display the progressbar, even in case the standard output is not Display the progress bar, even in case the standard output is not
a terminal. a terminal.
--no-checkout:: --no-checkout::
@ -121,17 +121,17 @@ objects from the source repository into a pack in the cloned repository.
configuration variables are created. configuration variables are created.
--mirror:: --mirror::
Set up a mirror of the remote repository. This implies --bare. Set up a mirror of the remote repository. This implies `--bare`.
--origin <name>:: --origin <name>::
-o <name>:: -o <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>:: --branch <name>::
-b <name>:: -b <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
be checked out. be checked out.
@ -158,7 +158,7 @@ objects from the source repository into a pack in the cloned repository.
--recursive:: --recursive::
After the clone is created, initialize all submodules within, After the clone is created, initialize all submodules within,
using their default settings. This is equivalent to running using their default settings. This is equivalent to running
'git submodule update --init --recursive' immediately after `git submodule update --init --recursive` immediately after
the clone is finished. This option is ignored if the cloned the clone is finished. This option is ignored if the cloned
repository does not have a worktree/checkout (i.e. if any of repository does not have a worktree/checkout (i.e. if any of
`--no-checkout`/`-n`, `--bare`, or `--mirror` is given) `--no-checkout`/`-n`, `--bare`, or `--mirror` is given)
@ -171,8 +171,8 @@ objects from the source repository into a pack in the cloned repository.
<directory>:: <directory>::
The name of a new directory to clone into. The "humanish" The name of a new directory to clone into. The "humanish"
part of the source repository is used if no directory is part of the source repository is used if no directory is
explicitly given ("repo" for "/path/to/repo.git" and "foo" explicitly given (`repo` for `/path/to/repo.git` and `foo`
for "host.xz:foo/.git"). Cloning into an existing directory for `host.xz:foo/.git`). Cloning into an existing directory
is only allowed if the directory is empty. is only allowed if the directory is empty.
:git-clone: 1 :git-clone: 1