summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)AuthorFilesLines
2007-03-18GIT 1.5.0.5Libravatar Junio C Hamano1-0/+28
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-14GIT 1.5.0.4Libravatar Junio C Hamano1-0/+24
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-14Clarify doc for git-config --unset-all.Libravatar Yann Dirson1-1/+1
Previous formulation could make it appear as removing all lines matching a regexp (at least, I was looking for such a flag, and confused this flag for what I was looking for). Signed-off-by: Yann Dirson <ydirson@altern.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-13cvsserver: asciidoc formatting changesLibravatar Frank Lichtenheld1-8/+11
Format some lists really as lists. Improves both html and man output. Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-11git-send-email: Document configuration optionsLibravatar Avi Kivity1-0/+13
Wishing to implement an email aliases file, I found that they were already implmented. Document them for the next user. Signed-off-by: Avi Kivity <avi@qumranet.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-10Merge branch 'maint' of git://linux-nfs.org/~bfields/git into maintLibravatar Junio C Hamano3-20/+29
* 'maint' of git://linux-nfs.org/~bfields/git: 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
2007-03-10user-manual: install user manual stylesheet with other web documentsLibravatar J. Bruce Fields1-1/+1
Install the stylesheet needed for the user manual. This should solve the problem of, e.g., http://www.kernel.org/pub/software/scm/git/docs/user-manual.html lacking a lot of formatting. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-03-10user-manual: fix rendering of history diagramsLibravatar J. Bruce Fields1-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>
2007-03-10user-manual: fix missing colon in git-show exampleLibravatar J. Bruce Fields1-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>
2007-03-10user-manual: fix inconsistent use of pull and mergeLibravatar J. Bruce Fields1-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>
2007-03-10user-manual: fix inconsistent exampleLibravatar J. Bruce Fields1-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>
2007-03-10glossary: fix overoptimistic automatic linking of defined termsLibravatar J. Bruce Fields1-1/+1
The script sort_glossary.pl turns each use of "term" into a link to the definition of "term". To avoid mangling links like gitlink:git-term[1] it doesn't replace any occurence of "term" preceded by "link:git-". This fails for gitlink:git-symbolic-ref[1] when substituting for "ref". So instead just refuse to replace anything preceded by a "-". That could result in missing some opportunities, but that's a less annoying error. Actually I find the automatic substitution a little distracting; some day maybe we should just run it once and commit the result, so it can be hand-tuned. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-03-09Documentation: s/seperator/separator/Libravatar Jeff King1-3/+3
Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-05Fix diff-options references in git-diff and git-format-patchLibravatar Brian Gernhardt2-3/+5
Most of the git-diff-* documentation used [<common diff options>] instead of [--diff-options], so make that change in git-diff and git-format-patch. In addition, git-format-patch didn't include the meanings of the diff options. Signed-off-by: Brian Gernhardt <benji@silverinsanity.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-05Add definition of <commit-ish> to the main git man page.Libravatar Theodore Ts'o1-0/+6
Signed-off-by: "Theodore Ts'o" <tytso@mit.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-05Begin SubmittingPatches with a check listLibravatar Johannes Schindelin1-0/+27
It seems that some people prefer a short list to a long text. But even for the latter group, a quick reminder list is useful. So, add a check list to Documentation/SubmittingPatches of what to do to get your patch accepted. Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-04GIT 1.5.0.3Libravatar Junio C Hamano1-11/+14
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-04glossary: Add definitions for dangling and unreachable objectsLibravatar Yasushi SHOJI1-0/+9
Define "dangling" and "unreachable" objects. Modified from original text proposed by Yasushi Shoji. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-04user-manual: more detailed merge discussionLibravatar J. Bruce Fields1-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>
2007-03-04user-manual: how to replace commits older than most recentLibravatar J. Bruce Fields1-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>
2007-03-04user-manual: insert earlier of mention content-addressable architectureLibravatar J. Bruce Fields1-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>
2007-03-04user-manual: ensure generated manual references stylesheetLibravatar J. Bruce Fields1-1/+4
The generated user manual is rather hard to read thanks to the lack of the css that's supposed to be included from docbook-xsl.css. I'm totally ignorant of the toolchain; grubbing through xmlto and related scripts, the easiest way I could find to ensure that the generated html links to the stylesheet is by calling xsltproc directly. Maybe there's some better way. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-04user-manual: reset to ORIG_HEAD not HEAD to undo mergeLibravatar J. Bruce Fields1-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>
2007-03-04Documentation: mention module option to git-cvsimportLibravatar J. Bruce Fields1-1/+1
The git-cvsimport argument that specifies a cvs module to import should probably be included in the default example. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-03Document the config variable format.suffixLibravatar Johannes Schindelin1-0/+5
Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-01Documentation: Correct minor typo in git-add documentation.Libravatar Christian Schlotter1-1/+1
Signed-off-by: Christian Schlotter <schlotter@users.sourceforge.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-01Documentation/git-send-email.txt: Fix labeled list formattingLibravatar Sergey Vlasov1-6/+6
Mark continuation paragraphs of list entries as such to avoid getting literal paragraphs instead. Signed-off-by: Sergey Vlasov <vsu@altlinux.ru> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-01Documentation/git-quiltimport.txt: Fix labeled list formattingLibravatar Sergey Vlasov1-4/+4
Mark the continuation paragraph of a list entry as such to avoid getting a literal paragraph instead. Signed-off-by: Sergey Vlasov <vsu@altlinux.ru> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-03-01Documentation/build-docdep.perl: Fix dependencies for included asciidoc filesLibravatar Sergey Vlasov1-5/+1
Adding dependencies on included files to the generated man pages is wrong - includes are processed by asciidoc, therefore the intermediate Docbook XML files really depend on included files. Because of these wrong dependencies the man pages were not rebuilt properly if the intermediate XML files were left in the tree. Signed-off-by: Sergey Vlasov <vsu@altlinux.ru> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-28Start preparing Release Notes for 1.5.0.3Libravatar Junio C Hamano1-0/+55
2007-02-28Documentation: git-remote add [-t <branch>] [-m <branch>] [-f] name urlLibravatar Junio C Hamano1-3/+14
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-28Include config.mak in doc/MakefileLibravatar Uwe Kleine-König1-0/+1
config.mak.autogen is already there. Without this change it is not possible to override mandir in config.mak. Signed-off-by: Uwe Kleine-König <ukleinek@informatik.uni-freiburg.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-27Fix minor typos/grammar in user-manual.txtLibravatar Michael Coleman1-17/+14
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-27Correct ordering in git-cvsimport's option documentationLibravatar Michael Poole1-5/+4
A pair of commits on January 8th added option documentation (for -a, -S and -L) in the middle of the documentation for the -A option. This makes -A's documentation contiguous again. Signed-off-by: Michael Poole <mdpoole@troilus.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-27Fix git-show man page formatting in the EXAMPLES sectionLibravatar Theodore Tso1-3/+3
Fix asciidoc markup so that the man page is properly formatted in the EXAMPLES section. Signed-off-by: "Theodore Ts'o" <tytso@mit.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-26GIT 1.5.0.2Libravatar Junio C Hamano1-11/+17
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-25Documentation: describe "-f/-t/-m" options to "git-remote add"Libravatar Junio C Hamano1-0/+13
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-25Add Release Notes to prepare for 1.5.0.2Libravatar Junio C Hamano1-0/+59
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-24core.legacyheaders: Use the description used in RelNotes-1.5.0Libravatar Santi Béjar1-4/+11
It explains what it does and why, and says how to use the new format. Signed-off-by: Santi Béjar <sbejar@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-21Document the new core.bare configuration option.Libravatar Shawn O. Pearce1-0/+12
Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-19git-clone: Sync documentation to usage note.Libravatar Christian Schlotter2-3/+3
Documentation advertises the new `--depth <n>' parameter with an equal sign, while the usage notes (shown after `git-clone --help') do not. If I understood git-clone's source code correctly, the version without the equal sign is correct, which is why this patch syncs documentation to the usage note. Signed-off-by: Christian Schlotter <schlotter@users.sourceforge.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-18GIT 1.5.0.1Libravatar Junio C Hamano1-6/+11
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-18Documentation/i18n.txt: it is i18n.commitencoding not core.commitencodingLibravatar Fredrik Kuivinen1-6/+6
Similarly for i18n.logoutputencoding. Signed-off-by: Fredrik Kuivinen <frekui@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-17Update draft release notes for 1.5.0.1Libravatar Junio C Hamano1-2/+19
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-17Convert update-index references in docs to add.Libravatar Shawn O. Pearce9-14/+15
Since `git add` is the approved porcelain for an end-user to invoke when they want to manipulate the index, porcelain documentation should steer the user to this command rather than the pure plumbing update-index. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-17Attempt to improve git-rebase lead-in description.Libravatar Shawn O. Pearce1-8/+14
It was mentioned on #git this morning that the lead-in description of git-rebase is very confusing. Too many branch this and branch that in a very short run of text. This new description attempts to walk the user through the command syntax, while also describing exactly what git-rebase is doing to their repository. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-14Add RelNotes 1.5.0.1Libravatar Junio C Hamano1-0/+20
In the same spirit as commit 6fc66686, let's keep notes as we fix things. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-14Still updating 1.5.0 release notes.Libravatar Junio C Hamano1-5/+2
In cruft removal section we had a cruft we needed to remove. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-14Clarify two backward incompatible repository options.Libravatar Junio C Hamano1-2/+8
It was unclear if the backward compatible features were disabled or the configuration variables that controls them were set to false by default from the description. Obviously we meant the former, but the problem was made worse by the fact that one configuration variable breaks compatibility when set to true and the other one breaks it when set to false. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-02-13cmd-list: add git-remoteLibravatar Junio C Hamano1-0/+1
Signed-off-by: Junio C Hamano <junkio@cox.net>