[PATCH V4 2/2] user-manual: add section documenting shallow clones
- From
- Stephen P. Smith <ischis2@cox.net>
- Date
- Dec 23, 2015, 20:36 UTC
- Message-ID
- <1450902961-1528-1-git-send-email-ischis2@cox.net>
- In-Reply-To
- <CAPig+cRMdpJ-k9L33jE01ubfK6MOWNGwuoUULuQqOv8C0we+DQ@mail.gmail.com>
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 <ischis2@cox.net> ---
I replaced the paragraphs that I wrote with Eric Shunshine's since it was cleaner.
I like the idea of linking to the preceeding effort, but gmane.org is currently undergoing maintance and therefore giving me errors when I attempt to access it.
Documentation/user-manual.txt | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-)
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 1c790ac..5c13683 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -2128,6 +2128,20 @@ 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`. + [[sharing-development-examples]] Examples -------- @@ -4645,9 +4659,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