From: "Stephen P. Smith" <ischis2@cox.net>
To: Git List <git@vger.kernel.org>
Cc: Eric Sunshine <sunshine@sunshineco.com>,
"Stephen P. Smith" <ischis2@cox.net>
Subject: [PATCH V2 2/2] user-manual: add section documenting shallow clones
Date: Tue, 22 Dec 2015 11:40:23 -0700 [thread overview]
Message-ID: <1450809623-1502-1-git-send-email-ischis2@cox.net> (raw)
In-Reply-To: <CAPig+cQOAGzQMj5oNMEsD0u7Wqj80kyyYcOwi-Y0q1yHtX4s4A@mail.gmail.com>
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 <<def_shallow_clone,shallow clone>> is useful when the recent
+history of a project is needed and getting real history recorded in
+the upstream is expensive. The resultant cloned <<def_repository,repository>>
+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 <<def_shallow_clone,shallow clone>> 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
next prev parent reply other threads:[~2015-12-22 18:39 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-12-22 2:09 [PATCH 1/2] Define the term shallow clone Stephen P. Smith
2015-12-22 2:09 ` [PATCH 2/2] Add a section to the users manual documenting shallow clones Stephen P. Smith
2015-12-22 3:47 ` Eric Sunshine
2015-12-22 18:40 ` Stephen P. Smith [this message]
2015-12-23 3:49 ` [PATCH V2 x/2] user-manual: add section " Stephen & Linda Smith
2015-12-23 3:53 ` [PATCH V3 2/2] " Stephen P. Smith
2015-12-23 7:47 ` Eric Sunshine
2015-12-23 20:36 ` [PATCH V4 " Stephen P. Smith
2015-12-28 22:57 ` Junio C Hamano
2015-12-29 18:54 ` [PATCH V4 1/2] glossary: define the term shallow clone Stephen P. Smith
2015-12-29 18:54 ` [PATCH V5 2/2] user-manual: add section documenting shallow clones Stephen P. Smith
2015-12-29 19:24 ` Junio C Hamano
2015-12-29 21:47 ` Stephen & Linda Smith
2015-12-29 23:12 ` Junio C Hamano
2015-12-29 23:31 ` [PATCH V6 " Stephen P. Smith
2015-12-29 23:39 ` [PATCH V5 " Junio C Hamano
2015-12-30 0:03 ` [PATCH V7 " Stephen P. Smith
2015-12-29 0:00 ` [PATCH V4 " Stephen & Linda Smith
2015-12-22 16:18 ` [PATCH 2/2] Add a section to the users manual " Stephen & Linda Smith
2015-12-22 3:12 ` [PATCH 1/2] Define the term shallow clone Eric Sunshine
2015-12-22 18:38 ` [PATCH V2 1/2] glossary: define " Stephen P. Smith
2015-12-23 3:53 ` [PATCH V3 " Stephen P. Smith
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1450809623-1502-1-git-send-email-ischis2@cox.net \
--to=ischis2@cox.net \
--cc=git@vger.kernel.org \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).