summaryrefslogtreecommitdiff
path: root/Documentation/user-manual.txt
AgeCommit message (Collapse)Author
2007-05-16Fixed link in user-manualSteffen Prohaska
link to git-mergetool was broken. Signed-off-by: Steffen Prohaska <prohaska@zib.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-05-08user-manual: fix clone and fetch typosJ. Bruce Fields
More typo fixes from Santi Béjar, plus a couple other mistakes I noticed along the way. Cc: Santi Béjar <sbejar@gmail.com> Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-05-07user-manual: miscellaneous editingJ. Bruce Fields
I cherry-picked some additional miscellaneous fixes from those suggested by Santi Béjar, including fixes to: - correct discussion of repository/HEAD->repository shortcut - add mention of git-mergetool - add mention of --track - mention "-f" as well as "+" for fetch Cc: Santi Béjar <sbejar@gmail.com> Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-05-07user-manual: fix .gitconfig editing examplesJ. Bruce Fields
Santi Béjar points out that when telling people how to "introduce themselves" to git we're advising them to replace their entire .gitconfig file. Fix that. Cc: "Santi Béjar <sbejar@gmail.com> Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-05-07user-manual: clean up fast-forward and dangling-objects sectionsJ. Bruce Fields
The previous commit calls attention to the fact that we have two sections each devoted to fast-forwards and to dangling objects. Revise and attempt to differentiate them a bit. Some more reorganization may be required later.... Signed-off-by: J. Bruce Fields
2007-05-07user-manual: add section ID'sJ. Bruce Fields
Any section lacking an id gets an annoying warning when you build the manual. More seriously, the table of contents then generates volatile id's which change with every build, with the effect that we get URL's that change all the time. The ID's are manually generated and sometimes inconsistent, but that's OK. XXX: what to do about the preface? Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-05-07user-manual: more discussion of detached heads, fix typosJ. Bruce Fields
Nicolas Pitre pointed out a couple typos and some room for improvement in the discussion of detached heads. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Cc: Nicolas Pitre <nico@cam.org>
2007-05-04Mention version 1.5.1 in tutorial and user-manualCarl Worth
Most other documentation will frequently be read from an installation of git so will naturally be associated with the installed version. But these two documents in particular are often read from web pages while users are still exploring git. It's important to mention version 1.5.1 since these documents provide example commands that won't work with previous versions of git. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-16user-manual: use detached head when rewriting historyJ. Bruce Fields
This is slightly simpler if we use a detached head. And it's probably good to have another example that uses this feature. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-16user-manual: start revising "internals" chapterJ. Bruce Fields
Minor revisions, cross-references. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-16user-manual: detached HEADJ. Bruce Fields
Add a brief mention of detached HEADs and .git/HEAD. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-16user-manual: fix discussion of default cloneJ. Bruce Fields
The name "master" isn't actually quite so special. Also, fix some bad grammar. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-07usermanual.txt: some capitalization nitsArjen Laarhoven
Signed-off-by: Arjen Laarhoven <arjen@yaph.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-04Documentation: A few minor fixes to Git User's ManualJakub Narebski
Mainly consistent usage of "git command" and not "git-command" syntax Signed-off-by: Jakub Narebski <jnareb@gmail.com> Acked-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-25Merge branch 'maint'Junio C Hamano
* maint: user-manual: introduce "branch" and "branch head" differently glossary: clean up cross-references glossary: stop generating automatically user-manual: Use def_ instead of ref_ for glossary references. user-manual.txt: fix a tiny typo. user-manual: run xsltproc without --nonet option
2007-03-19user-manual: introduce "branch" and "branch head" differentlyJ. Bruce Fields
I was using "branch" to mean "head", but that's perhaps a little sloppy; so instead start by using the terms "branch head" and "head", while still quickly falling back on "branch", since that's what people actually say more frequently. Also include glossary references on the first uses of "head" and "tag". Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-03-19glossary: stop generating automaticallyJ. Bruce Fields
The sort_glossary.pl script sorts the glossary, checks for duplicates, and automatically adds cross-references. But it's not so hard to do all that by hand, and sometimes the automatic cross-references are a little wrong; so let's run the script one last time and check in its output. Note: to make the output fit better into the user manual I also deleted the acknowledgements at the end, which was maybe a little rude; feel free to object and I can find a different solution. Cc: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-03-19user-manual.txt: fix a tiny typo.Jim Meyering
"file patch" was doubtless intended to be "file path", but "directory name" is clearer. Signed-off-by: Jim Meyering <jim@meyering.net> Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-03-11Merge branch 'maint'Junio C Hamano
* maint: git.el: Retrieve commit log information from .dotest directory. git.el: Avoid appending a signoff line that is already present. setup_git_directory_gently: fix off-by-one error user-manual: install user manual stylesheet with other web documents user-manual: fix rendering of history diagrams user-manual: fix missing colon in git-show example user-manual: fix inconsistent use of pull and merge user-manual: fix inconsistent example glossary: fix overoptimistic automatic linking of defined terms Documentation: s/seperator/separator/ Adjust reflog filemode in shared repository
2007-03-11user-manual: fix rendering of history diagramsJ. Bruce Fields
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>
2007-03-11user-manual: fix missing colon in git-show exampleJ. Bruce Fields
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>
2007-03-11user-manual: fix inconsistent use of pull and mergeJ. Bruce Fields
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>
2007-03-11user-manual: fix inconsistent exampleJ. Bruce Fields
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>
2007-03-05Merge branch 'maint'Junio C Hamano
* maint: GIT 1.5.0.3 glossary: Add definitions for dangling and unreachable objects user-manual: more detailed merge discussion user-manual: how to replace commits older than most recent user-manual: insert earlier of mention content-addressable architecture user-manual: ensure generated manual references stylesheet user-manual: reset to ORIG_HEAD not HEAD to undo merge Documentation: mention module option to git-cvsimport
2007-03-05user-manual: more detailed merge discussionJ. Bruce Fields
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>
2007-03-05user-manual: how to replace commits older than most recentJ. Bruce Fields
"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>
2007-03-05user-manual: insert earlier of mention content-addressable architectureJ. Bruce Fields
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>
2007-03-05user-manual: reset to ORIG_HEAD not HEAD to undo mergeJ. Bruce Fields
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>
2007-02-28Merge branch 'maint'Junio C Hamano
* maint: builtin-fmt-merge-msg: fix bugs in --file option index-pack: Loop over pread until data loading is complete. blameview: Fix the browse behavior in blameview Fix minor typos/grammar in user-manual.txt Correct ordering in git-cvsimport's option documentation git-show: Reject native ref Fix git-show man page formatting in the EXAMPLES section
2007-02-28Fix minor typos/grammar in user-manual.txtMichael Coleman
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-13Remove git-resolve.Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-04Assorted typo fixesPavel Roskin
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-02Fix some documentation typos and grammarMike Coleman
Also suggest user manual mention .gitignore. Signed-off-by: Michael Coleman <tutufan@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-30user-manual: todo'sJ. Bruce Fields
Update todo's. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-30user-manual: point to README for gitweb informationJ. Bruce Fields
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>
2007-01-29Two small typofixes.Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-29user-manual: SHA1 -> object nameJ. Bruce Fields
Prefer "object name" to SHA1, at least in higher level documentation. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-29user-manual: document git-show-branch exampleJ. Bruce Fields
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>
2007-01-29user-manual: minor "TODO" updatesJ. Bruce Fields
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>
2007-01-29user-manual: rewrap a few long linesJ. Bruce Fields
Rewrap some long lines. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-29user-manual: reflogs, other recoveryJ. Bruce Fields
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>
2007-01-29user-manual: fix a header levelJ. Bruce Fields
Oops. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-29user-manual: typo fixJ. Bruce Fields
Oops Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-29user-manual: add references to git-config man pageJ. Bruce Fields
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>
2007-01-29user-manual: repo-config -> configJ. Bruce Fields
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>
2007-01-29user-manual: fsck-objects -> fsckJ. Bruce Fields
There seems to be an agreement to rename fsck-objects to fsck. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-29user-manual: git-fsck, dangling objectsJ. Bruce Fields
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>
2007-01-27user-manual: reorganize fetch discussion, add internals, etc.J. Bruce Fields
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>
2007-01-26user-manual: stub discussion of fsck and reflogJ. Bruce Fields
Have some sort of recovery/reliability section that deals with reflog and fsck. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-22user-manual: update git-gc discussionJ. Bruce Fields
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>