[PATCH 4/5] Documentation: rewrite the core-tutorial introduction
From: J. Bruce Fields <bfields@citi.umich.edu>
Revise for conciseness, clarify the intended audience.
Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
---
3bb93812a96e602729e52ab1ac5a555f453470be
Documentation/core-tutorial.txt | 30 +++++++++---------------------
1 files changed, 9 insertions(+), 21 deletions(-)
3bb93812a96e602729e52ab1ac5a555f453470be
diff --git a/Documentation/core-tutorial.txt b/Documentation/core-tutorial.txt
index 5a831ad..3ab3317 100644
--- a/Documentation/core-tutorial.txt
+++ b/Documentation/core-tutorial.txt
@@ -4,35 +4,23 @@ A git core tutorial for developers
Introduction
------------
-This is trying to be a short tutorial on setting up and using a git
-repository, mainly because being hands-on and using explicit examples is
-often the best way of explaining what is going on.
+If you primarily interested in using git to manage your own projects,
+see link:tutorial.txt[A tutorial introduction to git] before reading
+this.
-In normal life, most people wouldn't use the "core" git programs
-directly, but rather script around them to make them more palatable.
-Understanding the core git stuff may help some people get those scripts
-done, though, and it may also be instructive in helping people
-understand what it is that the higher-level helper scripts are actually
-doing.
+However, git also provides commands that provide low-level access to
+git internals. These "core" git commands will be useful to advanced
+users, to git hackers, and to anyone developing software on top of
+the git core.
The core git is often called "plumbing", with the prettier user
interfaces on top of it called "porcelain". You may not want to use the
plumbing directly very often, but it can be good to know what the
plumbing does for when the porcelain isn't flushing.
-The material presented here often goes deep describing how things
-work internally. If you are mostly interested in using git as a
-SCM, you can skip them during your first pass.
-
-[NOTE]
-And those "too deep" descriptions are often marked as Note.
-
[NOTE]
-If you are already familiar with another version control system,
-like CVS, you may want to take a look at
-link:everyday.html[Everyday GIT in 20 commands or so] first
-before reading this.
-
+Notes like this mark descriptions of deep git internals that can
+be skipped on a first reading.
Creating a git repository
-------------------------
--
1.3.3.gff62