git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Stephen P. Smith" <ischis2@cox.net>
To: git@vger.kernel.org
Cc: "Stephen P. Smith" <ischis2@cox.net>
Subject: [PATCH 2/2] Add a section to the users manual documenting shallow clones.
Date: Mon, 21 Dec 2015 19:09:39 -0700	[thread overview]
Message-ID: <1450750180-1811-2-git-send-email-ischis2@cox.net> (raw)
In-Reply-To: <1450750180-1811-1-git-send-email-ischis2@cox.net>

The todo section previously noted that documentation of shallow clones
was not in the manual and had references to the 1.5.0 release notes.

The patch adds a section to the manual and removes the entry in the
ToDo list.

Signed-off-by: Stephen P. Smith <ischis2@cox.net>
---

Notes:
    I considered adding a paragraph to each of several sections noting the
    issues with regard to clone, fetch, merge and push.
    
    After looking for other such notes and finding none in the
    manual I chose to not add the paragraphs.

 Documentation/user-manual.txt | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 1c790ac..15825e0 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -39,7 +39,6 @@ without any explanation.
 Finally, see <<todo>> for ways that you can help make this manual more
 complete.
 
-
 [[repositories-and-branches]]
 Repositories and Branches
 =========================
@@ -72,6 +71,25 @@ called the <<def_working_tree,working tree>>, together with a special
 top-level directory named `.git`, which contains all the information
 about the history of the project.
 
+[[how-to-get-a-git-repository-with-minimal-history]]
+How to get a Git repository with minimal history
+------------------------------------------------
+
+Sometimes there is a need to view recent history or send email patches
+for a project with lots of history. In such cases a <<def_shallow_clone,shallow
+clone>> can be used to create a <<def_shallow_repository,shallow
+repository>>.
+
+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.
+
+------------------------------------------------
+	# the Linux kernel:
+$ git clone --depth=20 git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
+------------------------------------------------
+
 [[how-to-check-out]]
 How to check out a different version of a project
 -------------------------------------------------
@@ -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

  reply	other threads:[~2015-12-22  2:10 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 ` Stephen P. Smith [this message]
2015-12-22  3:47   ` [PATCH 2/2] Add a section to the users manual documenting shallow clones Eric Sunshine
2015-12-22 18:40     ` [PATCH V2 2/2] user-manual: add section " Stephen P. Smith
2015-12-23  3:49     ` [PATCH V2 x/2] " 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=1450750180-1811-2-git-send-email-ischis2@cox.net \
    --to=ischis2@cox.net \
    --cc=git@vger.kernel.org \
    /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).