@matheusbsbs / matheus-bagliano / commits / a85fecafe6
Fork 0

core-tutorial: minor cleanup

Revise the introduction for concision, add pointers to the tutorial and user manual as appropriate, delete cvsimport note from the end, as that work's been done elsewhere already. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>

J. Bruce Fields committed Sep 3, 2007 at 10:34 UTC a85fecafe63b49f89e0c055db6fb24b057db88c6
1 file changed +10 -22
Documentation/core-tutorial.txt
+10 -22
@@ -4,34 +4,24 @@ A git core tutorial for developers
4 Introduction
5 ------------
6
7 -This is trying to be a short tutorial on setting up and using a git
8 -repository, mainly because being hands-on and using explicit examples is
9 -often the best way of explaining what is going on.
7 +This tutorial explains how to use the "core" git programs to set up and
8 +work with a git repository.
9
11 -In normal life, most people wouldn't use the "core" git programs
12 -directly, but rather script around them to make them more palatable.
13 -Understanding the core git stuff may help some people get those scripts
14 -done, though, and it may also be instructive in helping people
15 -understand what it is that the higher-level helper scripts are actually
16 -doing.
10 +If you just need to use git as a revision control system you may prefer
11 +to start with link:tutorial.html[a tutorial introduction to git] or
12 +link:user-manual.html[the git user manual].
13 +
14 +However, an understanding of these low-level tools can be helpful if
15 +you want to understand git's internals.
16
17 The core git is often called "plumbing", with the prettier user
18 interfaces on top of it called "porcelain". You may not want to use the
19 plumbing directly very often, but it can be good to know what the
20 plumbing does for when the porcelain isn't flushing.
21
23 -The material presented here often goes deep describing how things
24 -work internally. If you are mostly interested in using git as a
25 -SCM, you can skip them during your first pass.
26 -
22 [NOTE]
28 -And those "too deep" descriptions are often marked as Note.
29 -
30 -[NOTE]
31 -If you are already familiar with another version control system,
32 -like CVS, you may want to take a look at
33 -link:everyday.html[Everyday GIT in 20 commands or so] first
34 -before reading this.
23 +Deeper technical details are often marked as Notes, which you can
24 +skip on your first reading.
25
26
27 Creating a git repository
@@ -1686,5 +1676,3 @@ merge two at a time, documenting how you resolved the conflicts,
1676 and the reason why you preferred changes made in one side over
1677 the other. Otherwise it would make the project history harder
1678 to follow, not easier.
1689 -
1690 -[ to be continued.. cvsimports ]