mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

core-tutorial: minor cleanup

Browse Source 
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>
This commit is contained in:
J. Bruce Fields
2007-09-03 10:34:27 -04:00
parent 40dac517ee
commit a85fecafe6
1 changed files with 10 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
Documentation/core-tutorial.txt
View File

@ -4,34 +4,24 @@ A git core tutorial for developers
Introduction Introduction
------------ ------------
This is trying to be a short tutorial on setting up and using a git This tutorial explains how to use the "core" git programs to set up and
repository, mainly because being hands-on and using explicit examples is work with a git repository.
often the best way of explaining what is going on.
In normal life, most people wouldn't use the "core" git programs If you just need to use git as a revision control system you may prefer
directly, but rather script around them to make them more palatable. to start with link:tutorial.html[a tutorial introduction to git] or
Understanding the core git stuff may help some people get those scripts link:user-manual.html[the git user manual].
done, though, and it may also be instructive in helping people
understand what it is that the higher-level helper scripts are actually However, an understanding of these low-level tools can be helpful if
doing. you want to understand git's internals.
The core git is often called "plumbing", with the prettier user 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 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 directly very often, but it can be good to know what the
plumbing does for when the porcelain isn't flushing. 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] [NOTE]
And those "too deep" descriptions are often marked as Note. Deeper technical details are often marked as Notes, which you can
skip on your first reading.
[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.
Creating a git repository Creating a git repository
@ -1686,5 +1676,3 @@ merge two at a time, documenting how you resolved the conflicts,
and the reason why you preferred changes made in one side over and the reason why you preferred changes made in one side over
the other. Otherwise it would make the project history harder the other. Otherwise it would make the project history harder
to follow, not easier. to follow, not easier.
[ to be continued.. cvsimports ]