git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: bfields@fieldses.org
To: Junio C Hamano <junkio@cox.net>
Cc: git@vger.kernel.org
Subject: [PATCH 4/5] Documentation: rewrite the core-tutorial introduction
Date: Mon, 29 May 2006 19:31:35 -0400	[thread overview]
Message-ID: <11489454963586-git-send-email-bfields@fieldses.org> (raw)
In-Reply-To: <11489454963995-git-send-email-bfields@fieldses.org>

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

  reply	other threads:[~2006-05-29 23:32 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-05-29 23:31 [PATCH 1/5] documentation: mention gitk font adjustment in tutorial bfields
2006-05-29 23:31 ` [PATCH 2/5] documentation: add brief mention of cat-file to tutorial part I bfields
2006-05-29 23:31   ` [PATCH 3/5] Documentation: retitle the git-core tutorial bfields
2006-05-29 23:31     ` bfields [this message]
2006-05-29 23:31       ` [PATCH 5/5] Documentation: fix a tutorial-2 typo bfields

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=11489454963586-git-send-email-bfields@fieldses.org \
    --to=bfields@fieldses.org \
    --cc=git@vger.kernel.org \
    --cc=junkio@cox.net \
    /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.
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 NNTP newsgroup(s).