summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)AuthorFilesLines
2007-05-07user-manual: fix clone and fetch typosLibravatar J. Bruce Fields1-7/+6
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-06Documentation: don't reference non-existent 'git-cvsapplycommit'Libravatar Jeff King1-1/+1
Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-05-07user-manual: stop deprecating the manualLibravatar J. Bruce Fields1-4/+3
It's just as much a work-in-progress, but at least now it's gotten enough technical review to shake out most of the really bad lies, so hopefully it doesn't do any actual damage. And if we encourage people to read it, they'll be more likely to whine about it, which will help get it fixed faster. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-05-07user-manual: miscellaneous editingLibravatar J. Bruce Fields1-35/+47
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 examplesLibravatar J. Bruce Fields1-4/+3
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 sectionsLibravatar J. Bruce Fields1-33/+40
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'sLibravatar J. Bruce Fields1-2/+82
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 typosLibravatar J. Bruce Fields1-5/+15
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-05Documentation: fix typo in git-remote.txtLibravatar James Bowes1-1/+1
Signed-off-by: James Bowes <jbowes@dangerouslyinc.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-05-04diff format documentation: describe raw combined diff formatLibravatar Jakub Narebski1-0/+22
Add description of raw combined diff format to diff-formats.txt, as "diff format for merges" section, before "Generating patches..." section. Signed-off-by: Jakub Narebski <jnareb@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-05-04Mention version 1.5.1 in tutorial and user-manualLibravatar Carl Worth2-4/+4
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-05-04Add --no-rebase option to git-svn dcommitLibravatar Karl Hasselström1-0/+3
git-svn dcommit exports commits to Subversion, then imports them back to git again, and last but not least rebases or resets HEAD to the last of the new commits. I guess this rebasing is convenient when using just git, but when the commits to be exported are managed by StGIT, it's really annoying. So add an option to disable this behavior. And document it, too! Signed-off-by: Karl Hasselström <kha@treskal.com> Acked-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-05-04Fix markup in git-svn man pageLibravatar Karl Hasselström1-19/+13
Some of the existing markup was just plain broken, and some subcommand options weren't indented properly. Signed-off-by: Karl Hasselström <kha@treskal.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-05-03Document 'opendiff' value in config.txt and git-mergetool.txtLibravatar Arjen Laarhoven2-2/+2
Signed-off-by: Arjen Laarhoven <arjen@yaph.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-30GIT v1.5.1.3Libravatar Junio C Hamano1-6/+14
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-30send-email documentation: clarify --smtp-serverLibravatar Jari Aalto1-3/+4
It can be either hostname/address, or a full path to a local executable. Signed-off-by: Jari Aalto <jari.aalto@cante.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-30git.7: Mention preformatted html doc locationLibravatar Jari Aalto1-0/+4
Signed-off-by: Jari Aalto <jari.aalto@cante.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-30Clarify SubmittingPatches ChecklistLibravatar Jari Aalto1-1/+9
Separate things to be checked when making commits, and things to be checked when sending patches. Signed-off-by: Jari Aalto <jari.aalto@cante.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-30git-svn: Add 'find-rev' commandLibravatar Adam Roben1-2/+3
This patch adds a new 'find-rev' command to git-svn that lets you easily translate between SVN revision numbers and git tree-ish. Signed-off-by: Adam Roben <aroben@apple.com> Acked-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-29Add missing reference to GIT_COMMITTER_DATE in git-commit-tree documentationLibravatar Josh Triplett2-0/+2
Signed-off-by: Josh Triplett <josh@freedesktop.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-27git-svn: Added 'find-rev' commandLibravatar Adam Roben1-0/+5
This patch adds a new 'find-rev' command to git-svn that lets you easily translate between SVN revision numbers and git tree-ish. Signed-off-by: Adam Roben <aroben@apple.com> Acked-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-27git shortlog documentation: add long options and fix a typoLibravatar Michele Ballabio1-4/+4
Signed-off-by: Michele Ballabio <barra_cuda@katamail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-26Update git-http-fetch documentationLibravatar Andrew Ruder1-0/+4
Documentation/git-http-fetch.txt: --recover to resume a failed fetch operation. Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-26Update git-local-fetch documentationLibravatar Andrew Ruder1-0/+14
Documentation/git-local-fetch.txt: -s to use symbolic links instead of file-to-file copy, -l to use hardlinks, -n to never use file-to-file copies, --recover to resume a failed fetch. Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-26Update git-http-push documentationLibravatar Andrew Ruder1-2/+11
Documentation/git-http-push.txt: Changing --complete to --all. Added documentation for -d and -D to remote remote refs. Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-26Update -L documentation for git-blame/git-annotateLibravatar Andrew Ruder1-2/+22
Documenting alternate ways to use -L: -L /regex/,end -L start,+offset Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-26Update git-grep documentationLibravatar Andrew Ruder1-4/+15
Documentation/git-grep.txt: Document -F/--fixed-strings to search for non-regexp patterns. Document -I to not search binary files. Document -<num> as a shortcut for -C<num>. Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-26Update git-fmt-merge documentationLibravatar Andrew Ruder1-1/+24
Documentation/git-fmt-merge-msg.txt: --summary to list commit summaries on merge --no-summary --file to take merged objects from a file. Configuration option merge.summary Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-26Document additional options for git-fetchLibravatar Andrew Ruder1-5/+12
Document --quiet/-q and --verbose/-v Add -n as an alternate for --no-tags Fix some whitespace issues Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-26Removing -n option from git-diff-files documentationLibravatar Andrew Ruder1-2/+2
-n is not a short form of --no-index as the documentation suggests. Removing it from the documentation and command usage string. Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-25Start preparing for 1.5.1.3Libravatar Junio C Hamano1-0/+38
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-25Document --dry-run and envelope-sender for git-send-email.Libravatar Robin H. Johnson1-0/+9
Catch the documentation up with the rest of this patchset. Signed-off-by: Robin H. Johnson <robbat2@gentoo.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-23Documentation/git-reset.txt: suggest git commit --amend in example.Libravatar Gerrit Pape1-0/+2
In example 'Undo a commit and redo', refer to 'git commit --amend', as this is the easier alternative. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-23Ignore all man sections as they are generated files.Libravatar Brian Gernhardt1-2/+1
Signed-off-by: Brian Gernhardt <benji@silverinsanity.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-23Reverse the order of -b and --track in the man page.Libravatar Brian Gernhardt1-1/+1
Using "-b --track newbranch oldbranch" gives the error: git checkout: updating paths is incompatible with switching branches/forcing However, "--track -b ..." works just fine. Signed-off-by: Brian Gernhardt <benji@silverinsanity.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-21GIT 1.5.1.2Libravatar Junio C Hamano1-7/+20
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-18Update git-config documentationLibravatar Andrew Ruder1-10/+14
Documentation/git-config.txt: Added documentation for --system Documentation/builtin-config.c: Added --system to the short usage Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-18Fix unmatched emphasis tag in git-tutorialLibravatar Andrew Ruder1-1/+1
In asciidoc 7.1.2 and prior there is no obvious way to get: 'add'ing to emphasize only the "add", instead it treats the first apostrophe as the beginning of an emphasis, and the second apostrophe as a regular apostrophe and makes the rest of the line an emphasis since there is no closing apostrophe. In the newer asciidoc you can do it pretty easily with __add__ing but I'm not sure it would be best to make that a prereq for something as silly as this. Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-18Update git-cherry-pick documentationLibravatar Andrew Ruder1-1/+1
Documentation/git-cherry-pick.txt: Remove --replay as it is not handled by the code (-r is however). Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-18Update git-archive documentationLibravatar Andrew Ruder1-1/+4
Documentation/git-archive.txt: Document -v/--verbose option. Add -l as short form of --list. Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-18git-tar-tree: complete deprecation conversion messageLibravatar Sam Vilain1-1/+1
The syntax for git-archive is different; warn about it in the deprecation message on the manual page. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-18git-shortlog: Fix two formatting errors in asciidoc documentationLibravatar Frank Lichtenheld1-1/+3
First use [verse] in the SYNOPSIS so that the line break actually shows. Secondly drop the quotes around '.mailmap' since this exposes a bug in our toolchain (didn't bother enough yet to find out wether it is asciidoc's fault or that of the XSL templates) that leads to the dot not getting escaped correctly in the roff output and thereby swallowing the line. Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-18git-svn: don't allow globs to match regular filesLibravatar Eric Wong1-0/+4
git only tracks the histories of full directories, not that of individual files. Sometimes, SVN users will place[1] a regular file in the directory designated for subdirectories of branches or tags. Thanks to jrockway on #git for pointing this out. [1] mistakenly or otherwise, such as a README Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-17Start preparing for 1.5.1.2Libravatar Junio C Hamano1-0/+37
2007-04-16Update git-annotate/git-blame documentationLibravatar Andrew Ruder3-64/+82
Moved options that pertained to both git-blame and git-annotate to a common file blame-options.txt. builtin-blame.c: Removed --compatibility, --long, --time from the short usage as they are not handled in the code. Documentation/git-blame.txt: Removed common options to git-annotate. Added documentation for --score-debug. Removed --compatibility. Adjusted usage at top to not wrap on 80 columns. Documentation/git-annotate.txt: Using common options blame-options.txt. Documentation/blame-options.txt: Added -b note about associated config option, added --root note about associated config option, added documentation for --show-stats. Removed --long, --time, --rev-file as those options do not really exist. Added documentation for -M/-C taking an optional score argument for detection of moved lines. Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-16Update git-apply documentationLibravatar Andrew Ruder1-6/+7
Document -v (short form of --verbose). Redo usage to not wrap on 80 column terminal with typical settings. Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-16Update git-applymbox documentationLibravatar Andrew Ruder1-4/+10
Documentation/git-applymbox.txt: updating -u documentation to include fact that it encodes to the i18n.commitencoding setting, not just utf-8. Added documentation of -n option to pass -n to git-mailinfo. Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-16Update git-am documentationLibravatar Andrew Ruder1-9/+16
Documentation/git-am.txt missing several short versions of options. Added documentation for --resolvemsg=<msg> command-line option. Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-04-16user-manual: use detached head when rewriting historyLibravatar J. Bruce Fields1-7/+8
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" chapterLibravatar J. Bruce Fields1-18/+20
Minor revisions, cross-references. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>