From mboxrd@z Thu Jan 1 00:00:00 1970 From: "Stephen P. Smith" Subject: [PATCH V2 2/2] user-manual: add section documenting shallow clones Date: Tue, 22 Dec 2015 11:40:23 -0700 Message-ID: <1450809623-1502-1-git-send-email-ischis2@cox.net> References: Cc: Eric Sunshine , "Stephen P. Smith" To: Git List X-From: git-owner@vger.kernel.org Tue Dec 22 19:39:48 2015 Return-path: Envelope-to: gcvg-git-2@plane.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1aBRqc-0007zk-08 for gcvg-git-2@plane.gmane.org; Tue, 22 Dec 2015 19:39:46 +0100 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753965AbbLVSjm (ORCPT ); Tue, 22 Dec 2015 13:39:42 -0500 Received: from fed1rmfepo203.cox.net ([68.230.241.148]:35445 "EHLO fed1rmfepo203.cox.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753292AbbLVSjl (ORCPT ); Tue, 22 Dec 2015 13:39:41 -0500 Received: from fed1rmimpo110 ([68.230.241.159]) by fed1rmfepo203.cox.net (InterMail vM.8.01.05.15 201-2260-151-145-20131218) with ESMTP id <20151222183940.ZINZ26406.fed1rmfepo203.cox.net@fed1rmimpo110> for ; Tue, 22 Dec 2015 13:39:40 -0500 Received: from thunderbird ([68.231.74.134]) by fed1rmimpo110 with cox id wifg1r0052tqoqC01ifgDj; Tue, 22 Dec 2015 13:39:40 -0500 X-CT-Class: Clean X-CT-Score: 0.00 X-CT-RefID: str=0001.0A020204.567998EC.0197,ss=1,re=0.000,fgs=0 X-CT-Spam: 0 X-Authority-Analysis: v=2.0 cv=B55nJpRM c=1 sm=1 a=/Rt4pg3TtX3KzfzhvVoEow==:17 a=kviXuzpPAAAA:8 a=wUQvQvOEmiQA:10 a=1PfJBRKZKCHrU5mnAFQA:9 a=/Rt4pg3TtX3KzfzhvVoEow==:117 X-CM-Score: 0.00 Authentication-Results: cox.net; none Received: from thunderbird.smith.home (thunderbird [127.0.0.1]) by thunderbird (Postfix) with ESMTP id D222D13F6F3; Tue, 22 Dec 2015 11:40:27 -0700 (MST) X-Mailer: git-send-email 2.6.3.368.gf34be46 In-Reply-To: Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: Rather than merely pointing readers at the 1.5 release notes to learn about shallow clones, document them formally. --- 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