summaryrefslogtreecommitdiff
path: root/Documentation/tutorial.txt
AgeCommit message (Collapse)Author
2006-06-07Some doc typo fixesFrancis Daly
All should be clear enough, except perhaps committish / commitish. I just kept the more-used one within the current docs. [jc: with rephrasing of check-ref-format description later discussed on the list] Signed-off-by: Francis Daly <francis@daoine.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-06-04Documentation: Spelling fixesHorst H. von Brand
Signed-off-by: Horst H. von Brand <vonbrand@inf.utfsm.cl> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-05-30documentation: add brief mention of cat-file to tutorial part IJ. Bruce Fields
I'd rather avoid git cat-file so early on, but the git-cat-file -p old-commit:/path/to/file trick is too useful.... Also fix a nearby typo while we're at it. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-05-30documentation: mention gitk font adjustment in tutorialJ. Bruce Fields
Kind of silly, but the font I get by default in gitk makes it mostly unusable for me, so this is the first thing I'd want to know about. (But maybe there's a better suggestion than just Ctrl-='ing until satisfied.) Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-05-22tutorial: add discussion of index file, object databaseJ. Bruce Fields
Add a sequel to tutorial.txt which discusses the index file and the object database. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-05-22tutorial: expanded discussion of commit historyJ. Bruce Fields
Expand the history-browsing section of the tutorial a bit, in part to address Junio's suggestion that we mention "git grep" and Linus's complaint that people are missing the flexibility of the commandline interfaces for selecting commits. This reads a little more like a collection of examples than a "tutorial", but maybe that's what people need at this point. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-05-22tutorial: replace "whatchanged" by "log"J. Bruce Fields
Junio suggested changing references to git-whatchanged to git-log. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-03-04AsciiDoc fix for tutorialFrancis Daly
RE \^.+\^ becomes <sup>. Not wanted here Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-23Documentation: finishing touches to the new tutorial.Junio C Hamano
We forgot to update the primary link from git.html leading to the tutorial, and also forgot to build and install the renamed core-tutorial document. Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-23New tutorialJ. Bruce Fields
The current Documentation/tutorial.txt concentrates on the lower-level git interfaces. So it's useful to people developing alternative porcelains, to advanced users, etc., but not so much to beginning users. I think it makes sense for the main tutorial to address those beginnning users, so with this patch I'm proposing that we move Documentation/tutorial.txt to Documentation/core-tutorial.txt and replace it by a new tutorial. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-15show-branch: make the current branch and merge commits stand out.Junio C Hamano
This changes the character used to mark the commits that is on the branch from '+' to '*' for the current branch, to make it stand out. Also we show '-' for merge commits. When you have a handful branches with relatively long diversion, it is easier to see which one is the current branch this way. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-24Tutorial: mention shared repository management.Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-21A shared repository should be writable by members.Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-17Documentation: HTTP needs update-server-info.Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-15Documentation: tutorialJunio C Hamano
At the beginning of tutorial, refer the reader to everyday if she has not done so yet. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-13Documentation: not learning core git commands.Junio C Hamano
The initial section of tutorial was too heavy on internal workings for the first-time readers, so rewrite the introductory section of git(7) to start with "not learning core git commands" section and refer them to README to grasp the basic concepts, then Everyday to give overview with task/role oriented examples for minimum set of commands, and finally the tutorial. Also add to existing note in the tutorial that many too technical descriptions can be skipped by a casual reader. I initially started to review the tutorial, with the objective of ripping out the detailed technical information altogether, but I found that the level of details in the initial couple of sections that talk about refs and the object database in a hands-on fashion was about rigth, and left all of them there. I feel that reading about fsck-index and repack is too abstract without being aware of these directories and files. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-08Documentation(tutorial): adjust merge example to the new merge world order.Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-05Documentation: shared repository management in tutorial.Junio C Hamano
The branch policy script I outlined was improved and polished by Carl and posted on the list twice since then. It is a shame not to pick it up, so replace the original outline in howto/update-hook-example.txt with the latest from Carl. Also talk about setting up git-shell to allow git-push/git-fetch only SSH access to a shared repository host in the tutorial. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-30Tutorial: adjust merge example to recursive strategy.Junio C Hamano
Current default, merge-recursive, gives slightly different message while working from merge-resolve which was used to prepare the illustration in the tutorial. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-21tutorial: setting up a tree for subsystem maintainersJunio C Hamano
The "copying over packs" step is to prevent the objects available in upstream repository to get expanted in the subsystem maintainer tree, and is still valid if the upstream repository do not live on the same machine. But if they are on the same machine using objects/info/alternates is cleaner. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-11Change 'cache' to 'index' in the docsLukas_Sandström
This patch makes the documentation refer to the index as index instead of cache, but some references still remain. (e.g. git-update-index.txt) Signed-off-by: Lukas Sandström <lukass@etek.chalmers.se> Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-08Use consistent shell prompts and example style.Jon Loeliger
Signed-off-by: Jon Loeliger <jdl@freescale.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-08Tutorial: do not use 'git resolve'.Junio C Hamano
Use 'git merge' instead. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-07Documentation: talk about guts of merge in tutorial.Junio C Hamano
While discussing Jon's ASCII art on merge operations with him, I realized that the tutorial stops talking about the plumbing details halfway. So fill in the gory details, and update the examples to use 'git-merge', not 'git-resolve'. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-03Illustration: "Git Diff Types"Junio C Hamano
Jon Loeliger's ASCII art in the Tutorial. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-01Document the use of "current directory" as pull source.Junio C Hamano
The repository to pull from can be a local repository, and as a special case the current directory can be specified to perform merges across local branches. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-15Merge branch 'fixes'Junio C Hamano
2005-10-13tutorial: update the initial commit example.Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-13Adapt tutorial to cygwin and add test caseJohannes Schindelin
Lacking reliable symlinks, the instructions in the tutorial did not work in a cygwin setup. Also, a few outputs were not correct. This patch fixes these, and adds a test case which follows the instructions of the tutorial (except git-clone, -fetch and -push, which I have not done yet). Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-10Convert usage of GIT and Git into gitChristian Meder
Convert usage of GIT and Git into git. Signed-off-by: Christian Meder <chris@absolutegiganten.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-10Remove the version tags from the manpagesJunio C Hamano
Signed-off-by: Christian Meder <chris@absolutegiganten.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-23[PATCH] Retitle 'inspecting what happened' section.Jon Loeliger
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-21Update tutorial with Octopus usage.Junio C Hamano
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-11[PATCH] Escape asciidoc's built-in em-dash replacementYasushi SHOJI
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-09[PATCH] fix tutorial typojdl@freescale.com
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[PATCH] Fix tutorial reference to git-*-scripts.jdl@freescale.com
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-08Big tool rename.Junio C Hamano
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-02Mention post-update when we first talk about publishing a repository.Junio C Hamano
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-01Add repository-layout document.Junio C Hamano
... and link to it from both the main index and the tutorial. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-31Update tutorial.Junio C Hamano
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-30Documentaion updates.Junio C Hamano
Mostly making the formatted html prettier. Signed-off-by: Junio C Hamano <junkio@cox.net> (cherry picked from 7adf1f15ebe074d4767df941817a6cf86d8e2533 commit)
2005-08-29[PATCH] tutorial note about git branchAmos Waterland
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-24Update tutorial to describe shared repository style a bit more.Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23Tutorial updates.Junio C Hamano
- 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-17[PATCH] use it's and its correctly in documentationGreg Louis
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-01[PATCH] Updates to tutorial.txtJohannes Schindelin
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-07-29Tutorial: use a bit longer sample filenames.Junio C Hamano
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-27Tutorial typofix.Linus Torvalds
Signed-off-by: Linus Torvalds <torvalds@osdl.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-07-23Update tutorial.txt branches/tags to use the nicer helper syntaxLinus Torvalds
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[PATCH] tutorial: mention "git clone" records .git/branches/originJunio C Hamano
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>