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@xxxxxxx>
---
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
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html