summaryrefslogtreecommitdiff
path: root/Documentation/user-manual.txt
Commit message (Collapse)AuthorAgeFilesLines
* user-manual: todo updates and cleanupJ. Bruce Fields2007-09-151-13/+16
| | | | | Format a couple lists. Reminder that we may want to add submodule documentation some day.
* user-manual: fix introduction to packfilesJ. Bruce Fields2007-09-151-2/+2
| | | | | | | Actually I don't think we've previously mentioned .git/objects, so we need a different introduction here. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* user-manual: move packfile and dangling object discussionJ. Bruce Fields2007-09-151-148/+147
| | | | | | | The discussions of packfiles and dangling objects both belong in the object database section. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* user-manual: rewrite object database discussionJ. Bruce Fields2007-09-151-139/+196
| | | | | | | | Rewrite the introduction. Rewrite each section completely to make them work in the new order, to add some examples, and to move plumbing commands (like git-commit-tree) to the following chapter. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* user-manual: reorder commit, blob, tree discussionJ. Bruce Fields2007-09-151-41/+41
| | | | | | | | The bottom-up blog, tree, commit order makes sense unless you want to give explicit examples--it's easier to discover objects to examine if you go in the other order...., Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* user-manual: rewrite index discussionJ. Bruce Fields2007-09-151-49/+55
| | | | | | | | | Add an example using git-ls-files, standardize on the new "index" terminology (as opposed to "cache"), attempt to clarify discussion and make it a little shorter, avoid some unnecessary jargon ("write-back cache"). Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* user-manual: create new "low-level git operations" chapterJ. Bruce Fields2007-09-151-9/+24
| | | | | | | | The low-level index operations aren't as important to regular users as the rest of this "git concepts" chapter; so move it into a separate chapter, and do some minor cleanup. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* user-manual: rename "git internals" to "git concepts"J. Bruce Fields2007-09-151-6/+10
| | | | | | | | "git internals" sounds like something only git developers must know about, but this stuff should be of wider interest. Rename the chapter and give it a slightly friendlier introduction. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* user-manual: move object format details to hacking-git chapterJ. Bruce Fields2007-09-151-23/+32
| | | | | | Most of this is probably only of interest to git developers. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* user-manual: adjust section levels in "git internals"J. Bruce Fields2007-09-151-5/+12
| | | | | | | | | | | | | | | | | The descriptions of the various object types should all be a subsection of the "Object Database" section. I cribbed most of this chapter from the README (now core-intro.txt and git(7)), because there's stuff in there people need to know and I was too lazy to rewrite it. The audience isn't quite right, though--the chapter is a mixture of user- and developer- level documentation that isn't as appropriate now as it was originally. So, reserve this chapter for stuff users need to know, and move the source code introduction into a new "git hacking" chapter where we'll also move any hacker-only technical details. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* Porcelain level "log" family should recurse when diffing.Junio C Hamano2007-08-281-1/+1
| | | | | | | Most notably, "git log --name-status" stopped at top level directory changes without "-r" option. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Merge branch 'maint'J. Bruce Fields2007-08-261-84/+48
|\ | | | | | | | | | | Conflicts: Documentation/user-manual.txt
| * Documentation/user-manual.txt: fix a few omissions of gitlink commands.David Kastrup2007-08-261-6/+8
| | | | | | | | Signed-off-by: David Kastrup <dak@gnu.org>
| * user-manual: fix incorrect header levelJ. Bruce Fields2007-08-261-1/+1
| | | | | | | | | | | | This section is a subsection of the "Examples" section. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| * user-manual: use pithier example commitJ. Bruce Fields2007-08-261-25/+20
| | | | | | | | | | | | | | | | | | | | | | | | Actually, we should have a competition for the favorite example commit. Criteria: - length: one-line changes with one-line comments preferred, and no long lines - significance/memorability - comic value Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| * user-manual: introduce the word "commit" earlierJ. Bruce Fields2007-08-261-5/+5
| | | | | | | | | | | | Use the word "commit" as a synonym for "version" from the start. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| * user-manual: minor editing for concisenessJ. Bruce Fields2007-08-261-7/+3
| | | | | | | | | | | | Just cutting out a few unnecessary words. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| * user-manual: edit "ignoring files" for concisenessJ. Bruce Fields2007-08-261-45/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The immediate motivation for writing this section was to explain the various places ignore patterns could be used. However, I still think .gitignore is the case most people will want to learn about first. It also makes it a bit more concrete to introduce ignore patterns in the context of .gitignore first. And the existance of gitignore(5) relieves the pressure to explain it all here. So, stick to the .gitignore example, with only a brief mention of the others, explain the syntax only by example, and leave the rest to gitignore(5). Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Cc: Johan Herland <johan@herland.net>
* | Documentation/user-manual.txt: fix a few omissions of gitlink commands.David Kastrup2007-08-261-9/+11
| | | | | | | | Signed-off-by: David Kastrup <dak@gnu.org>
* | Documentation: Correct various misspellings and typos.Brian Hetro2007-08-241-6/+6
| | | | | | | | | | | | | | Fix minor typos throughout the documentation. Signed-off-by: Brian Hetro <whee@smaertness.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | user-manual: mention git-guiJ. Bruce Fields2007-08-051-2/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The git gui project seems to be still in early stages, but at a point where it's worth mentioning as an alternative way of creating commits. One feature of interest is the ability to manipulate individual diff hunks. However, people have found that feature not to be easily discoverable from the user-interface. Pending some ui improvements, a parenthetical hint here may help. (Thanks to Steffen Prohask and Junio Hamano for suggesting the language.) Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* | user-manual: mention git stashJunio C Hamano2007-08-051-0/+32
| | | | | | | | | | | | | | Mention the git-stash command as a way to temporarily set aside work in progress. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* | user-manual: update for new default --track behaviorJ. Bruce Fields2007-08-051-14/+9
| | | | | | | | | | | | | | | | | | Update documentation to reflect the --track default. That change seems to have happened in the 1.5.3 -rc's, so bump the "for version x.y.z or newer" warning as well. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* | user-manual: fix typolets.Junio C Hamano2007-07-241-4/+4
| | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Merge branch 'maint'Junio C Hamano2007-07-081-5/+22
|\ \ | |/ | | | | | | | | | | | | * maint: user-manual: fix directory name in git-archive example user-manual: more explanation of push and pull usage tutorial: Fix typo user-manual: grammar and style fixes
| * user-manual: fix directory name in git-archive exampleWilliam Pursell2007-07-081-1/+1
| | | | | | | | Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * user-manual: more explanation of push and pull usageJ. Bruce Fields2007-07-081-1/+18
| | | | | | | | | | | | | | | | | | | | | | | | Recently a user on the mailing list complained that they'd read the manual but couldn't figure out how to keep a couple private repositories in sync. They'd tried using push, and were surprised by the effect. Add a little text in an attempt to make it clear that: - Pushing to a branch that is checked out will have odd results. - It's OK to synchronize just using pull if that's simpler. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * user-manual: grammar and style fixesAndy Parkins2007-07-081-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | - "method of" is vulgar, "method for" is nicer - "recovery" becomes "recovering" from Steve Hoelzer's original version of this patch - "if you want" is nicer as "if you wish" - "you may" should be "you can"; "you may" is "you have permission to" rather than "you can"'s "it is possible to" Signed-off-by: Andy Parkins <andyparkins@gmail.com> Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* | Fixed a formulation mistake in Documentation/user-manual.txtMarcus Fritzsch2007-07-061-7/+7
| | | | | | | | | | | | | | | | This one fixes a small formulation weirdness in Documentation/user-manual.txt Signed-off-by: Marcus Fritzsch <m@fritschy.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Merge branch 'maint' to sync with GIT 1.5.2.2Junio C Hamano2007-06-161-2/+2
|\ \ | |/
| * Documentation: adjust to AsciiDoc 8Junio C Hamano2007-06-161-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | It turns out that the attribute definition we have had for a long time to hide "^" character from AsciiDoc 7 was not honored by AsciiDoc 8 even under "-a asciidoc7compatible" mode. There is a similar breakage with the "compatible" mode with + characters. The double colon at the end of definition list term needs to be attached to the term, without a whitespace. After this minimum fixups, AsciiDoc 8 (I used 8.2.1 on Debian) with compatibility mode seems to produce reasonably good results. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Merge branch 'maint'Junio C Hamano2007-06-101-6/+11
|\ \ | |/ | | | | | | | | | | | | | | * maint: tutorial: use "project history" instead of "changelog" in header Documentation: user-manual todo user-manual: add a missing section ID Fix typo in remote branch example in git user manual user-manual: quick-start updates
| * Documentation: user-manual todoJ. Bruce Fields2007-06-101-0/+4
| | | | | | | | | | | | | | Some more user-manual todo's: how to share objects between repositories, how to recover. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * user-manual: add a missing section IDJ. Bruce Fields2007-06-101-0/+1
| | | | | | | | | | | | I forgot to give an ID for this section. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * Fix typo in remote branch example in git user manualGerrit Pape2007-06-101-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | In Documentation/user-manual.txt the example $ git checkout --track -b origin/maint maint under "Getting updates with git pull", should read $ git checkout --track -b maint origin/maint This was noticed by Ron, and reported through http://bugs.debian.org/427502 Signed-off-by: Gerrit Pape <pape@smarden.org> Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * user-manual: quick-start updatesJ. Bruce Fields2007-06-101-5/+5
| | | | | | | | | | | | | | | | | | Update text to reflect new position in appendix. Update the name to reflect the fact that this is closer to reference than tutorial documentation (as suggested by Jonas Fonseca). Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* | War on whitespaceJunio C Hamano2007-06-071-19/+19
|/ | | | | | | | | This uses "git-apply --whitespace=strip" to fix whitespace errors that have crept in to our source files over time. There are a few files that need to have trailing whitespaces (most notably, test vectors). The results still passes the test, and build result in Documentation/ area is unchanged. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Create a new manpage for the gitignore format, and reference it elsewhereJosh Triplett2007-06-021-6/+6
| | | | | | | | | | | | | | | | | | Only git-ls-files(1) describes the gitignore format in detail, and it does so with reference to git-ls-files options. Most users don't use the plumbing command git-ls-files directly, and shouldn't have to look in its manpage for information on the gitignore format. Create a new manpage gitignore(5) (Documentation/gitignore.txt), and factor out the gitignore documentation into that file, changing it to refer to .gitignore and $GIT_DIR/info/exclude as used by porcelain commands. Reference gitignore(5) from other relevant manpages and documentation. Remove now-redundant information on exclude patterns from git-ls-files(1), leaving only information on how git-ls-files options specify exclude patterns and what precedence they have. Signed-off-by: Josh Triplett <josh@freedesktop.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* user-manual: fixed typo in exampleSteffen Prohaska2007-05-281-1/+1
| | | | | Signed-off-by: Steffen Prohaska <prohaska@zib.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Merge branch 'maint' to synchronize with 1.5.1.6Junio C Hamano2007-05-201-2/+106
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * maint: GIT 1.5.1.6 git-svn: don't minimize-url when doing an init that tracks multiple paths git-svn: avoid crashing svnserve when creating new directories user-manual: Add section on ignoring files user-manual: finding commits referencing given file content user-manual: discourage shared repository tutorial: revise index introduction tutorials: add user-manual links Conflicts: GIT-VERSION-GEN RelNotes
| * user-manual: Add section on ignoring filesJohan Herland2007-05-191-2/+69
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The todo list at the end of the user manual says that something must be said about .gitignore. Also, there seems to be a lack of documentation on how to choose between the various types of ignore files (.gitignore vs. .git/info/exclude, etc.). This patch adds a section on ignoring files which try to introduce how to tell git about ignored files, and how the different strategies complement eachother. The syntax of exclude patterns is explained in a simplified manner, with a reference to git-ls-files(1) which already contains a more thorough explanation. Signed-off-by: Johan Herland <johan@herland.net>
| * user-manual: finding commits referencing given file contentJ. Bruce Fields2007-05-191-0/+16
| | | | | | | | | | | | | | Another amusing git exploration example brought up in irc. (Credit to aeruder for the complete solution.) Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * user-manual: discourage shared repositoryJ. Bruce Fields2007-05-191-0/+21
| | | | | | | | | | | | | | | | | | I don't really want to look like we're encouraging the shared repository thing. Take down some of the argument for using purely single-developer-owned repositories and collaborating using patches and pulls instead. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* | Merge 1.5.1.5 inJunio C Hamano2007-05-181-280/+912
|\ \ | |/ | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
| * user-manual: reorganize public git repo discussionJ. Bruce Fields2007-05-171-40/+50
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Helping a couple people set up public repos recently, I wanted to point them at this piece of the user manual, but found it wasn't as helpful as it could be: - It starts with a big explanation of why you'd want a public repository, not necessary in their case since they already knew why they wanted that. So, separate that out. - It skimps on some of the git-daemon details, and puts the http export information first. Fix that. Also group all the public repo subsections into a single section, and do some miscellaneous related editing. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * user-manual: listing commits reachable from some refs not othersJ. Bruce Fields2007-05-171-0/+48
| | | | | | | | | | | | This is just an amusing example raised by someone in irc. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * user-manual: introduce gitJ. Bruce Fields2007-05-171-0/+3
| | | | | | | | | | | | Well, we should say at least something about what git is. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * user-manual: add a "counting commits" exampleJ. Bruce Fields2007-05-171-0/+19
| | | | | | | | | | | | This is partly just an excuse to mention --pretty= and rev-list. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * user-manual: move howto/using-topic-branches into manualJ. Bruce Fields2007-05-171-1/+296
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Move howto/using-topic-branches into the user manual as an example for the "sharing development" chapter. While we're at it, remove some discussion that's covered in earlier chapters, modernize somewhat (use separate-heads setup, remotes, replace "whatchanged" by "log", etc.), and replace syntax we'd need to explain by syntax we've already covered (e.g. old..new instead of new ^old). The result may not really describe what Tony Luck does any more.... Hope that's not annoying. Cc: Tony Luck <tony.luck@intel.com> Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * user-manual: move howto/make-dist.txt into user manualJ. Bruce Fields2007-05-171-0/+42
| | | | | | | | | | | | | | | | | | | | | | | | There seems to be a perception that the howto's are bit-rotting a little. The manual might be a more visible location for some of them, and make-dist.txt seems like a good candidate to include as an example in the manual. For now, incorporate much of it verbatim. Later we may want to update the example a bit. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
View Lorry Controller Status