summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorStephen P. Smith <ischis2@cox.net>2015-12-29 17:03:50 -0700
committerJunio C Hamano <gitster@pobox.com>2015-12-30 11:44:56 -0800
commit9cfde9ee8f6dc82365f1e977935960f34108076b (patch)
tree7ce2b0482750323e1d6a84b6fa1cd901140724dc /Documentation
parentbac58749bb2cd04720a4d5a1f58ebc428869f9a2 (diff)
downloadgit-9cfde9ee8f6dc82365f1e977935960f34108076b.tar.gz
user-manual: add section documenting shallow clones
Signed-off-by: Stephen P. Smith <ischis2@cox.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/user-manual.txt23
1 files changed, 20 insertions, 3 deletions
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index a56a206039..456457b047 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -2128,6 +2128,26 @@ The gitweb cgi script provides users an easy way to browse your
project's files and history without having to install Git; see the file
gitweb/INSTALL in the Git source tree for instructions on setting it up.
+[[how-to-get-a-git-repository-with-minimal-history]]
+How to get a Git repository with minimal history
+------------------------------------------------
+
+A <<def_shallow_clone,shallow clone>>, with its truncated
+history, is useful when one is interested only in recent history
+of a project and getting full history from the upstream is
+expensive.
+
+A <<def_shallow_clone,shallow clone>> is created by specifying
+the linkgit:git-clone[1] `--depth` switch. The depth can later be
+changed with the linkgit:git-fetch[1] `--depth` switch, or full
+history restored with `--unshallow`.
+
+Merging inside a <<def_shallow_clone,shallow clone>> will work as long
+as a merge base is in the recent history.
+Otherwise, it will be like merging unrelated histories and may
+have to result in huge conflicts. This limitation may make such
+a repository unsuitable to be used in merge based workflows.
+
[[sharing-development-examples]]
Examples
--------
@@ -4642,9 +4662,6 @@ standard end-of-chapter section?
Include cross-references to the glossary, where appropriate.
-Document shallow clones? See draft 1.5.0 release notes for some
-documentation.
-
Add a section on working with other version control systems, including
CVS, Subversion, and just imports of series of release tarballs.