Skip to content

Commit

Permalink
Merge branch 'ss/clone-depth-single-doc' into maint
Browse files Browse the repository at this point in the history
Documentation for "git fetch --depth" has been updated for clarity.

* ss/clone-depth-single-doc:
  docs: clarify that --depth for git-fetch works with newly initialized repos
  docs: say "commits" in the --depth option wording for git-clone
  docs: clarify that passing --depth to git-clone implies --single-branch
  • Loading branch information
Junio C Hamano committed Feb 5, 2016
2 parents 0298675 + 60253a6 commit 2db7d79
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
9 changes: 5 additions & 4 deletions Documentation/fetch-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@
option old data in `.git/FETCH_HEAD` will be overwritten.

--depth=<depth>::
Deepen or shorten the history of a 'shallow' repository created by
`git clone` with `--depth=<depth>` option (see linkgit:git-clone[1])
to the specified number of commits from the tip of each remote
branch history. Tags for the deepened commits are not fetched.
Limit fetching to the specified number of commits from the tip of
each remote branch history. If fetching to a 'shallow' repository
created by `git clone` with `--depth=<depth>` option (see
linkgit:git-clone[1]), deepen or shorten the history to the specified
number of commits. Tags for the deepened commits are not fetched.

--unshallow::
If the source repository is complete, convert a shallow
Expand Down
9 changes: 4 additions & 5 deletions Documentation/git-clone.txt
Original file line number Diff line number Diff line change
Expand Up @@ -190,15 +190,14 @@ objects from the source repository into a pack in the cloned repository.

--depth <depth>::
Create a 'shallow' clone with a history truncated to the
specified number of revisions.
specified number of commits. Implies `--single-branch` unless
`--no-single-branch` is given to fetch the histories near the
tips of all branches.

--[no-]single-branch::
Clone only the history leading to the tip of a single branch,
either specified by the `--branch` option or the primary
branch remote's `HEAD` points at. When creating a shallow
clone with the `--depth` option, this is the default, unless
`--no-single-branch` is given to fetch the histories near the
tips of all branches.
branch remote's `HEAD` points at.
Further fetches into the resulting repository will only update the
remote-tracking branch for the branch this option was used for the
initial cloning. If the HEAD at the remote did not point at any
Expand Down

0 comments on commit 2db7d79

Please sign in to comment.