summaryrefslogtreecommitdiff
path: root/Documentation/user-manual.txt
Commit message (Collapse)AuthorAgeFilesLines
* user-manual: fix rendering of history diagramsJ. Bruce Fields2007-03-101-4/+21
| | | | | | | | | | | | | | | | | | Asciidoc appears to interpret a backslash at the end of a line as escaping the end-of-line character, which screws up the display of history diagrams like o--o--o \ o--... The obvious fix (replacing "\" by "\\") doesn't work. The only workaround I've found is to include all such diagrams in a LiteralBlock. Asciidoc claims that should be equivalent to a literal paragraph, so I don't understand why the difference--perhaps it's an asciidoc bug. Cc: Ramsay Jones <ramsay@ramsay1.demon.co.uk> Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: fix missing colon in git-show exampleJ. Bruce Fields2007-03-101-1/+1
| | | | | | | There should be a colon in this git-show example. Cc: Ramsay Jones <ramsay@ramsay1.demon.co.uk> Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: fix inconsistent use of pull and mergeJ. Bruce Fields2007-03-101-11/+3
| | | | | | | | | I used "git pull ." instead of "git merge" here without any explanation. Stick instead to "git merge" for now (the equivalent pull syntax is still covered in a later chapter). Cc: Ramsay Jones <ramsay@ramsay1.demon.co.uk> Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: fix inconsistent exampleJ. Bruce Fields2007-03-101-2/+2
| | | | | | | | The configuration file fragment here is inconsistent with the text above. Thanks to Ramsay Jones for the correction. Cc: Ramsay Jones <ramsay@ramsay1.demon.co.uk> Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: more detailed merge discussionJ. Bruce Fields2007-03-041-25/+77
| | | | | | | Add more details on conflict, including brief discussion of file stages. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
* user-manual: how to replace commits older than most recentJ. Bruce Fields2007-03-041-0/+46
| | | | | | | | | "Modifying" an old commit by checking it out, --amend'ing it, then rebasing on top of it, is a slightly cumbersome technique, but I've found it useful frequently enough to make it seem worth documenting. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
* user-manual: insert earlier of mention content-addressable architectureJ. Bruce Fields2007-03-041-9/+15
| | | | | | | | The content-addressable design is too important not to be worth at least a brief mention a little earlier on. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
* user-manual: reset to ORIG_HEAD not HEAD to undo mergeJ. Bruce Fields2007-03-041-1/+1
| | | | | | | | | | | | As Linus pointed out recently on the mailing list, git reset --hard HEAD^ doesn't undo a merge in the case where the merge did a fast-forward. So the rcommendation here is a little dangerous. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Fix minor typos/grammar in user-manual.txtMichael Coleman2007-02-271-17/+14
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Assorted typo fixesPavel Roskin2007-02-031-5/+5
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Fix some documentation typos and grammarMike Coleman2007-02-011-3/+5
| | | | | | | Also suggest user manual mention .gitignore. Signed-off-by: Michael Coleman <tutufan@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* user-manual: todo'sJ. Bruce Fields2007-01-301-1/+3
| | | | | | Update todo's. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: point to README for gitweb informationJ. Bruce Fields2007-01-301-1/+4
| | | | | | | I'd like complete gitweb setup instructions some day, but for now just refer to the gitweb README. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* Two small typofixes.Junio C Hamano2007-01-291-2/+2
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* user-manual: SHA1 -> object nameJ. Bruce Fields2007-01-291-5/+5
| | | | | | Prefer "object name" to SHA1, at least in higher level documentation. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: document git-show-branch exampleJ. Bruce Fields2007-01-291-2/+28
| | | | | | | Document Junio's show-branch trick for finding out which tags are descendents of a given comit. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: minor "TODO" updatesJ. Bruce Fields2007-01-291-9/+6
| | | | | | | | I still really want a section on interoperability with CVS, subversion, etc., but I'm not getting around to it very fast, so just add this to the TODO section for now. And a few other minor todo updates. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: rewrap a few long linesJ. Bruce Fields2007-01-291-56/+59
| | | | | | Rewrap some long lines. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: reflogs, other recoveryJ. Bruce Fields2007-01-291-15/+78
| | | | | | | | Add a brief discussion of reflogs. Also recovery of dangling commits seems to fit in here, so move some of the discussion out of Linus's email to here. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: fix a header levelJ. Bruce Fields2007-01-291-1/+1
| | | | | | Oops. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: typo fixJ. Bruce Fields2007-01-291-1/+1
| | | | | | Oops Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: add references to git-config man pageJ. Bruce Fields2007-01-291-3/+7
| | | | | | | | | | Direct editing of config files may be more natural for users than using the git-config commandline; but we should still reference the git-config man page when we describe such editing, so people know where to go for details on the config file syntax and meanings of the variables. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: repo-config -> configJ. Bruce Fields2007-01-281-9/+9
| | | | | | | Looks like we're going to allow git-config as the preferred alias to git-repo-config, so let's document that instead. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: fsck-objects -> fsckJ. Bruce Fields2007-01-281-8/+8
| | | | | | There seems to be an agreement to rename fsck-objects to fsck. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: git-fsck, dangling objectsJ. Bruce Fields2007-01-281-6/+118
| | | | | | | Initial import of fsck and dangling objects discussion, mostly lifted from an email from Linus. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: reorganize fetch discussion, add internals, etc.J. Bruce Fields2007-01-271-204/+954
| | | | | | | | | | | | | | Keep git remote discussion in the first chapter, but postpone lower-level git fetch usage (to fetch individual branches) till later. Import a bunch of slightly modified text from the readme to give an architectural overview at the end. Add more discussion of history rewriting. And a bunch of other miscellaneous changes.... Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: stub discussion of fsck and reflogJ. Bruce Fields2007-01-261-0/+21
| | | | | | | Have some sort of recovery/reliability section that deals with reflog and fsck. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: update git-gc discussionJ. Bruce Fields2007-01-211-5/+3
| | | | | | | It appears git-gc will no longer prune automatically, so we don't need to tell people not to do other stuff while running it. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: update references discussionJ. Bruce Fields2007-01-211-27/+19
| | | | | | | Since references may be packed, it's no longer as helpful to introduce references as paths relative to .git. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: clarify difference between tag and branchJ. Bruce Fields2007-01-211-0/+3
| | | | | | | Explain the difference (well, one of the differences) between a tag and a branch. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: minor quickstart reorganizationJ. Bruce Fields2007-01-211-8/+22
| | | | | | Move around some stuff in the quickstart, add "push" examples. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: add "quick start" as chapter 1J. Bruce Fields2007-01-201-2/+200
| | | | | | | Add a "quick start" guide, modelled after Mercurial's, as the first chapter. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: rewrap, fix heading levelsJ. Bruce Fields2007-01-141-17/+23
| | | | | | Fix some heading levels that prevented compile; rewrap some stuff. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: reindentJ. Bruce Fields2007-01-141-9/+22
| | | | | | Just some minor reindenting Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: replace init-db by initJ. Bruce Fields2007-01-111-2/+2
| | | | | | Replace mentions of init-db by mentions of init. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* user manual: answer some comments from JunioJ. Bruce Fields2007-01-101-23/+10
| | | | | | | Junio left a few comments in his previous patch; deal with each of them. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* User manual: fix typos in examplesJunio C Hamano2007-01-101-10/+26
| | | | | | | | | Correct command line examples of repo-config, format-patch and am. A full object name is 40-hexdigit; it may be 20-byte but 20-digit is misleading. Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation: rev-list -> rev-parse, other typos, start examplesJ. Bruce Fields2007-01-101-2/+57
| | | | | | Fix some typos, start adding some more simple examples. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* Documentation: begin discussion of git-remote in user manualJ. Bruce Fields2007-01-091-14/+54
| | | | | | Start discussion of git-remote. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* Documentation: reorder development section, todo'sJ. Bruce Fields2007-01-081-120/+123
| | | | | | | Update todo's. Split out "sharing development" section into a separate chapter, reorder. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* Documentation: more user-manual todo'sJ. Bruce Fields2007-01-081-1/+16
| | | | | | Add some more todo's for the user manual. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* Documentation: git-rebase discussion, miscellaneous user-manual updatesJ. Bruce Fields2007-01-071-4/+157
| | | | | | | | | | Add discussion of git-rebase, patch series, history rewriting. Mention "pull ." as a synonym for "merge". Remind myself of another case I want to cover in the other-vcs's chapter. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* Documentation: expand preface and todo'sJ. Bruce Fields2007-01-071-3/+28
| | | | | | | | Add a brief description of the organization to the preface, expand the final notes/todo's section, in hopes maybe some others will want to contribute. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* Documentation: add git user's manualJ. Bruce Fields2007-01-071-0/+1460
The goals are: - Readable from beginning to end in order without having read any other git documentation beforehand. - Helpful section names and cross-references, so it's not too hard to skip around some if you need to. - Organized to allow it to grow much larger (unlike the tutorials) It's more liesurely than tutorial.txt, but tries to stay focused on practical how-to stuff. It adds a discussion of how to resolve merge conflicts, and partial instructions on setting up and dealing with a public repository. I've lifted a little bit from "branching and merging" (e.g., some of the discussion of history diagrams), and could probably steal more if that's OK. (Similarly anyone should of course feel free to reuse bits of this if any parts seem more useful than the whole.) There's a lot of detail on managing branches and using git-fetch, just because those are essential even to people needing read-only access (e.g., kernel testers). I think those sections will be much shorter once the new "git remote" command and the disconnected checkouts are taken into account. I do feel bad about adding yet another piece of documentation, but I we need something that goes through all the basics in a logical order, and I wasn't seeing how to grow the tutorials into that. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
View Lorry Controller Status