docs: clarify that --depth for git-fetch works with newly initialized repos
The original wording sounded as if --depth could only be used to deepen or shorten the history of existing repos. However, that is not the case. In a workflow like $ git init $ git remote add origin https://github.com/git/git.git $ git fetch --depth=1 The newly initialized repo is properly created as a shallow repo. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Sebastian Schuberth committed
Jan 8, 2016 at 10:32 UTC
60253a605d230a7fd2b32e77e94bd620c1399b72
1 file changed
+5
-4
Documentation/fetch-options.txt
+5
-4
@@ -8,10 +8,11 @@
8
option old data in `.git/FETCH_HEAD` will be overwritten.
9
10
--depth=<depth>::
11
- Deepen or shorten the history of a 'shallow' repository created by
12
- `git clone` with `--depth=<depth>` option (see linkgit:git-clone[1])
13
- to the specified number of commits from the tip of each remote
14
- branch history. Tags for the deepened commits are not fetched.
11
+ Limit fetching to the specified number of commits from the tip of
12
+ each remote branch history. If fetching to a 'shallow' repository
13
+ created by `git clone` with `--depth=<depth>` option (see
14
+ linkgit:git-clone[1]), deepen or shorten the history to the specified
15
+ number of commits. Tags for the deepened commits are not fetched.
16
17
--unshallow::
18
If the source repository is complete, convert a shallow