From: Stephen P. Smith Date: Wed, 23 Dec 2015 03:53:47 GMT Subject: [PATCH V3 2/2] user-manual: add section documenting shallow clones Message-ID: <1450842827-14115-1-git-send-email-ischis2@cox.net> In-Reply-To: Rather than merely pointing readers at the 1.5 release notes to learn about shallow clones, document them formally. Signed-off-by: Stephen P. Smith --- Documentation/user-manual.txt | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 1c790ac..bdfe984 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -2128,6 +2128,24 @@ 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 <> is useful when the recent +history of a project is needed and getting real history recorded in +the upstream is expensive. The resultant cloned <> +has truncated history. This clone could be used to look at history +near the tip of a branch and contribute email patches to the project. + +A <> is created by specifying the +depth when creating a clone of a repository using the +linkgit:git-clone[1] `--depth` switch. The depth can later be changed +by using the linkgit:git-fetch[1] `--depth` switch. If there is later +a need to fetch the entire history and if the source repository is +complete, the linkgit:git-fetch[1] `--unshallow` switch can be used to +convert a shallow repository to a complete one. + [[sharing-development-examples]] Examples -------- @@ -4645,9 +4663,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. -- 2.6.3.368.gf34be46