Skip to content

Commit a85feca

Browse files
author
J. Bruce Fields
committed
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>
1 parent 40dac51 commit a85feca

File tree

1 file changed

+10
-22
lines changed

1 file changed

+10
-22
lines changed

Documentation/core-tutorial.txt

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,24 @@ A git core tutorial for developers
44
Introduction
55
------------
66

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.
109

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.
1716

1817
The core git is often called "plumbing", with the prettier user
1918
interfaces on top of it called "porcelain". You may not want to use the
2019
plumbing directly very often, but it can be good to know what the
2120
plumbing does for when the porcelain isn't flushing.
2221

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-
2722
[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.
3525

3626

3727
Creating a git repository
@@ -1686,5 +1676,3 @@ merge two at a time, documenting how you resolved the conflicts,
16861676
and the reason why you preferred changes made in one side over
16871677
the other. Otherwise it would make the project history harder
16881678
to follow, not easier.
1689-
1690-
[ to be continued.. cvsimports ]

0 commit comments

Comments
 (0)