Commit graph

82 commits

Author SHA1 Message Date
Jon Loeliger
d154dcc8b6 [PATCH] Retitle 'inspecting what happened' section.
In the tutorial, there is a section entitled "Checking it out"
that shows how to use diff log and whatchanged to insect some
of the repository state.

As the phrase "checkout" ususally carries some baggage WRT
other revision control mechanism, I suggest that we re-title
this section something like "Inspecting Changes".

Signed-off-by: Jon Loeliger <jdl@freescale.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-22 18:31:14 -07:00
Junio C Hamano
6f60300b54 Update tutorial with Octopus usage.
Making an Octopus is simply a natural extension of merging just one
branch into the current branch.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-21 00:37:17 -07:00
Yasushi SHOJI
e1ccf53a60 [PATCH] Escape asciidoc's built-in em-dash replacement
AsciiDoc replace '--' with em-dash (&#8212) by default. em-dash
looks a lot like a single long dash and it's very confusing when
we are talking about command options.

Section 21.2.8 'Replacements' of AsciiDoc's User Guide says that a
backslash in front of double dash prevent the replacement.  This
patch does just that.

Signed-off-by: Yasushi SHOJI <yashi@atmark-techno.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-11 10:51:36 -07:00
jdl@freescale.com
96768e3108 [PATCH] fix tutorial typo
Fix a minor typo in the tutorial.txt.

Signed-off-by: Jon Loeliger <jdl@freescale.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-09 09:59:03 -07:00
jdl@freescale.com
c87d41ebf7 [PATCH] Fix tutorial reference to git-*-scripts.
There was a lingering reference to the git-*-scripts in
the tutorial.  This patch reworks that paragraph a bit.

Signed-off-by: Jon Loeliger <jdl@freescale.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-09 09:58:50 -07:00
Junio C Hamano
215a7ad1ef Big tool rename.
As promised, this is the "big tool rename" patch.  The primary differences
since 0.99.6 are:

  (1) git-*-script are no more.  The commands installed do not
      have any such suffix so users do not have to remember if
      something is implemented as a shell script or not.

  (2) Many command names with 'cache' in them are renamed with
      'index' if that is what they mean.

There are backward compatibility symblic links so that you and
Porcelains can keep using the old names, but the backward
compatibility support  is expected to be removed in the near
future.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-07 17:45:20 -07:00
Junio C Hamano
953e5842f8 Mention post-update when we first talk about publishing a repository.
There is more detailed instruction for `project lead` later in
the tutorial to talk about the same, but at this point in the
flow of tutorial, the first time reader has no way of knowing it.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-02 11:46:43 -07:00
Junio C Hamano
a1d4aa7424 Add repository-layout document.
... and link to it from both the main index and the tutorial.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-01 16:56:13 -07:00
Junio C Hamano
914328ac02 Update tutorial.
Finally I bit the bullet and did a full sweep of this document.
The changes are mostly clarifications, adjusting old terminology
to the glossary compatible one, and asciidoc formatting.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-30 23:08:06 -07:00
Junio C Hamano
8db9307c9c Documentaion updates.
Mostly making the formatted html prettier.

Signed-off-by: Junio C Hamano <junkio@cox.net>
(cherry picked from 7adf1f15ebe074d4767df941817a6cf86d8e2533 commit)
2005-08-30 13:55:34 -07:00
Amos Waterland
928f74de22 [PATCH] tutorial note about git branch
Explain that an asterisk will be displayed in front of the current
branch when you run `git branch' to see which are available.

Signed-off-by: Amos Waterland <apw@rossby.metr.ou.edu>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-28 21:34:28 -07:00
Junio C Hamano
c95173410d Update tutorial to describe shared repository style a bit more.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-24 16:50:55 -07:00
Junio C Hamano
2a29da7c6d Tutorial updates.
- Use "working tree", "object name", "repository" as the canonical
   term consistenly.

 - Start formatting tutorial with asciidoc.

 - Mention shared repository style of cooperation.

 - Update with some usability enhancements recently made, such as
   the "-m" flag to the "git commit" command.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 15:28:34 -07:00
Greg Louis
cdacb6208f [PATCH] use it's and its correctly in documentation
At one place in Documentation/tutorial.txt and several in the base
README, its was wrongly used in place of it's or vice versa.  One
instance remains somewhere in Documentation/howto/, which I didn't
correct because it's in a quotation.

Signed-off-by: Greg Louis <glouis@dynamicro.ca>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-17 12:13:12 -07:00
Johannes Schindelin
ade75a59fd [PATCH] Updates to tutorial.txt
Fix a few typos.
Adapt to git-http-pull not borking on packed repositories.

Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-01 13:27:08 -07:00
Junio C Hamano
a05ed8cb0c Tutorial: use a bit longer sample filenames.
Darrin Thompson noticed when he was showing off GIT to others
that the use of filenames "a" and "b" in the tutorial example
was unnecessarily confusing, especially with our "patch -p1"
prefix a/ and b/, without giving us any patch.  I was very
tempted to change them back to l/ and k/ prefixes, but decided
to restrain myself and update the tutorial instead ;-).

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-07-29 10:23:38 -07:00
Linus Torvalds
f315724431 Tutorial typofix.
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-07-27 11:53:49 -07:00
Linus Torvalds
a7333f9e56 Update tutorial.txt branches/tags to use the nicer helper syntax
Teach people to use "git tag <tag-name>" instead of writing the current
HEAD by hand into the .git/refs/tags/<tag-name> file.  Most people
probably don't really want to know about how git does things internally.
2005-07-23 15:24:53 -07:00
Junio C Hamano
a692b9656a [PATCH] tutorial: mention "git clone" records .git/branches/origin
Update the recommended workflow for individual developers.
While they are tracking the origin, refs/heads/origin is updated
by "git fetch", so there is no need to manually copy FETCH_HEAD
to refs/heads/ anywhere.

Signed-off-by: Junio C Hamano <junkio@cox.net>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-07-22 20:34:17 -07:00
Junio C Hamano
0c04094bc1 [PATCH] Documentation: describe short-hand used in fetch/pull.
Describe short-hand for remote repository used in fetch/pull.

Signed-off-by: Junio C Hamano <junkio@cox.net>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
2005-07-16 09:23:06 -07:00
Junio C Hamano
a232a132ea [PATCH] Documentation: update recommended workflow when working with others.
Clarify that the hierarchy implied by the recommended workflow
is only informal.

Refer readers to nice illustration by Randy Dunlap.

Separate out the step to "push" to own public repository in the
workflow.

Signed-off-by: Junio C Hamano <junkio@cox.net>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
2005-07-15 21:53:22 -07:00
Junio C Hamano
3eb5128a10 [PATCH] Documentation: pull, push, packing repository and working with others.
Describe where you can pull from with a bit more detail.
Clarify description of pushing.

Add a section on packing repositories.

Add a section on recommended workflow for the project lead,
subsystem maintainers and individual developers.

Move "Tag" section around to make the flow of example simpler to
follow.

Signed-off-by: Junio C Hamano <junkio@cox.net>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
2005-07-15 12:08:15 -07:00
Junio C Hamano
e7c1ca4273 [PATCH] Documentation: update tutorial to talk about push.
Talk about publishing to a public repository.  Also fixes a
couple of typos.

Signed-off-by: Junio C Hamano <junkio@cox.net>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
2005-07-15 11:40:14 -07:00
Linus Torvalds
ed616049d7 Update the tutorial a bit
Add notes on branches, merging, tagging, and update some of the usage to
the friendlier "git cmd" syntax.

It's still ridiculously lacking, but perhaps it's a _bit_ more useful.
2005-07-08 18:26:19 -07:00
Linus Torvalds
ce30a4b68a Update tutorial a bit for scripted helpers. 2005-06-14 19:00:00 -07:00
Junio C Hamano
d327b89a22 [PATCH] Tutorial update to adjust for -B fix
Now -B does not say silly "complete rewrite" anymore for small
files such as the one in the tutorial example.

Signed-off-by: Junio C Hamano <junkio@cox.net>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
2005-06-12 20:40:19 -07:00
Linus Torvalds
a7b209091a Clarify git-diff-cache semantics in the tutorial.
Adam Kropelin points out that it wasn't all that clear
at all what the thing does. This hopefully helps a bit.
2005-06-02 17:15:32 -07:00
Linus Torvalds
cc29f73285 Run the tutorial through ispell once more
People are making fun of me for being a bad speeler.
2005-06-02 07:58:41 -07:00
Linus Torvalds
f35ca9ed3e tutorial.txt: start describing how to copy repositories
Both locally and remotely.
2005-06-01 17:48:33 -07:00
Linus Torvalds
81bb573ed8 Update tutorial for simplified "git" script.
Use "git commit" instead of "git-commit-script", and talk about using
"git log" before introducing the more complex "git-whatchanged".

In short, try to make it feel a bit more normal to those poor souls
using CVS.

Do some whitspace edits too, to make the side notes stand out a bit
more.
2005-06-01 09:27:22 -07:00
Linus Torvalds
837eedf41b tutorial.txt: fix typos and a'git-whatchanged' example
Pointed out by Junio. I kant't speel.
2005-06-01 07:39:36 -07:00
Linus Torvalds
8c7fa2478e Add first cut at a simple git tutorial.
This really is very basic stuff, no branches, no merging, no CVS
imports. Let's start small.
2005-05-31 19:50:34 -07:00