summaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* Force listingblocks to be monospaced in manpagesJulian Phillips2007-07-181-0/+6
| | | | | | | | | | | | | For the html output we can use a stylesheet to make sure that the listingblocks are presented in a monospaced font. For the manpages do it manually by inserting a ".ft C" before and ".ft" after the block in question. In order for these roff commands to get through to the manpage they have to be element encoded to prevent quoting. Signed-off-by: Julian Phillips <julian@quantumfyre.co.uk> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* GIT 1.5.2.4v1.5.2.4Junio C Hamano2007-07-121-0/+28
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Clarify documentation of fast-import's D subcommandShawn O. Pearce2007-07-091-3/+5
| | | | | | | | The 'D' subcommand within a commit can also delete a directory recursively. This wasn't clear in the prior version of the documentation, leading to a question on the mailing list. Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
* 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>
* tutorial: Fix typoJ. Bruce Fields2007-07-081-1/+1
| | | | | | "You" should be "Alice" here. 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>
* Document -<n> for git-format-patchMiklos Vajna2007-07-031-0/+3
| | | | | | | | The -<n> option was not mentioned in git-format-patch's manpage till now. Fix this. Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* glossary: add 'reflog'Johannes Schindelin2007-07-031-0/+6
| | | | | Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Correctly document the name of the global excludes file configurationMichael Hendricks2007-07-021-1/+1
| | | | | Signed-off-by: Michael Hendricks <michael@ndrix.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* GIT 1.5.2.3v1.5.2.3Junio C Hamano2007-07-021-0/+27
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* git-remote: document -nSam Vilain2007-06-301-0/+7
| | | | | | | | The 'show' and 'prune' commands accept an option '-n'; document what it does. Signed-off-by: Sam Vilain <sam.vilain@catalyst.net.nz> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* repack: improve documentation on -a optionSam Vilain2007-06-301-4/+7
| | | | | | | Some minor enhancements to the git-repack manual page. Signed-off-by: Sam Vilain <sam.vilain@catalyst.net.nz> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* config: Complete documentation of --get-regexpFrank Lichtenheld2007-06-261-0/+2
| | | | | | | | | | The asciidoc documentation of the --get-regexp option was incomplete. Add some missing pieces: - List the option in SYNOPSIS - Mention that key names are printed Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* GIT 1.5.2.2v1.5.2.2Junio C Hamano2007-06-161-0/+61
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: adjust to AsciiDoc 8Junio C Hamano2007-06-164-4/+8
| | | | | | | | | | | | | | 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>
* git-cherry: Document 'limit' command-line optionLuiz Fernando N. Capitulino2007-06-121-0/+3
| | | | | Signed-off-by: Luiz Fernando N. Capitulino <lcapitulino@mandriva.com.br> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* tutorial: use "project history" instead of "changelog" in headerJ. Bruce Fields2007-06-101-2/+2
| | | | | | | The word "changelog" seems a little too much like jargon to me, and beginners must understand section headers so they know where to look for help. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* 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>
* Make command description imperative statement, not third-person present.william pursell2007-06-093-3/+3
| | | | | | | | In several of the text messages, the tense of the verb is inconsistent. For example, "Add" vs "Creates". It is customary to use imperative for command description. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* fix documentation of unpack-objects -nSam Vilain2007-06-061-2/+2
| | | | | | | unpack-objects -n didn't print the object list as promised on the manual page, so alter the documentation to reflect the behaviour Signed-off-by: Junio C Hamano <gitster@pobox.com>
* GIT 1.5.2.1v1.5.2.1Junio C Hamano2007-06-021-0/+53
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Create a new manpage for the gitignore format, and reference it elsewhereJosh Triplett2007-06-028-101/+145
| | | | | | | | | | | | | | | | | | 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>
* Documentation: robustify asciidoc GIT_VERSION replacementJeff King2007-06-022-5/+3
| | | | | | | | | | | | Instead of using sed on the resulting file, we now have a git_version asciidoc attribute. This means that we don't pipe the output of asciidoc, which means we can detect build failures. Problem reported by Scott Lamb, solution suggested by Jonas Fonseca. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Merge branch 'maint-1.5.1' into maintJunio C Hamano2007-05-311-11/+65
|\ | | | | | | | | | | | | | | * maint-1.5.1: git-config: Improve documentation of git-config file handling git-config: Various small fixes to asciidoc documentation decode_85(): fix missing return. fix signed range problems with hex conversions
| * git-config: Improve documentation of git-config file handlingFrank Lichtenheld2007-05-301-7/+59
| | | | | | | | | | | | | | | | | | The description which files git-config uses and how the various command line options and environment variables affect its behaviour was incomplete, outdated and confusing. Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * git-config: Various small fixes to asciidoc documentationFrank Lichtenheld2007-05-301-4/+6
| | | | | | | | | | | | | | | | | | | | | | Add '' around the only mentioned commandline option that didn't have it. Make reference to section EXAMPLE a link and rename it to EXAMPLES because it actually contains a lot of examples. Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | cvsserver: Fix some typos in asciidoc documentationFrank Lichtenheld2007-05-291-2/+2
| | | | | | | | | | Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | cvsserver: Note that CVS_SERVER can also be specified as method variableFrank Lichtenheld2007-05-291-1/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Reasonably new versions of the cvs CLI client allow one to specifiy CVS_SERVER as a method variable directly in CVSROOT. This is way more convinient than using an environment variable since it gets saved in CVS/Root. Since I only discovered this by accident I guess there might be others out there that learnt CVS on the 1.11 series (or even earlier) and profit from such a note about cvs improvements in the last couple years. Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | cvsserver: Correct inetd.conf example in asciidoc documentationFrank Lichtenheld2007-05-291-3/+5
| | | | | | | | | | | | | | | | | | | | While the given example worked, it made us look rather incompetent. Give the correct reason why one needs the more complex syntax and change the example to reflect that. Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de> 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-1.5.1' into maintJunio C Hamano2007-05-262-30/+34
|\ \ | |/ | | | | | | | | | | | | | | | | | | | | * maint-1.5.1: Fix git-svn to handle svn not reporting the md5sum of a file, and test. More echo "$user_message" fixes. Add tests for the last two fixes. git-commit: use printf '%s\n' instead of echo on user-supplied strings git-am: use printf instead of echo on user-supplied strings Documentation: Add definition of "evil merge" to GIT Glossary Replace the last 'dircache's by 'index' Documentation: Clean up links in GIT Glossary
| * Documentation: Add definition of "evil merge" to GIT GlossaryJakub Narebski2007-05-251-0/+4
| | | | | | | | | | Signed-off-by: Jakub Narebski <jnareb@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * Replace the last 'dircache's by 'index'Jakub Narebski2007-05-251-1/+1
| | | | | | | | | | Signed-off-by: Jakub Narebski <jnareb@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * Documentation: Clean up links in GIT GlossaryJakub Narebski2007-05-251-29/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | Ensure that the same link is not repeated in single glossary entry, and that there is no self-link i.e. link to current entry. Add links to other definitions in git glossary. Remove inappropriate (nonsense) links, or change link to link to correct definition (to correct term). Signed-off-by: Jakub Narebski <jnareb@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Merge branch 'maint-1.5.1' into maintJunio C Hamano2007-05-231-1/+1
|\ \ | |/ | | | | | | * maint-1.5.1: Documentation: fix git-config.xml generation
| * Documentation: fix git-config.xml generationJames Bowes2007-05-231-1/+1
| | | | | | | | | | Signed-off-by: James Bowes <jbowes@dangerouslyinc.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Merge branch 'maint-1.5.1' into maintJunio C Hamano2007-05-231-0/+7
|\ \ | |/ | | | | | | * maint-1.5.1: Document branch.autosetupmerge.
| * Document branch.autosetupmerge.Paolo Bonzini2007-05-221-0/+7
| | | | | | | | | | | | | | | | This patch documents the branch.autosetupmerge config option, added by commit 0746d19a. Signed-off-by: Paolo Bonzini <bonzini@gnu.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Merge branch 'maint-1.5.1' into maintJunio C Hamano2007-05-213-0/+23
|\ \ | |/ | | | | | | | | | | * maint-1.5.1: git-status: respect core.excludesFile SubmittingPatches: mention older C compiler compatibility git-daemon: don't ignore pid-file write failure
| * git-status: respect core.excludesFileJohannes Schindelin2007-05-212-0/+10
| | | | | | | | | | | | | | | | | | | | git-add reads this variable, and honours the contents of that file if that exists. Match this behaviour in git-status, too. Noticed by Evan Carroll on IRC. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * SubmittingPatches: mention older C compiler compatibilityJohannes Schindelin2007-05-211-0/+13
| | | | | | | | | | | | | | | | We do not appreciate C99 initializers, declarations after statements, or "0" instead of "NULL". Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Merge branch 'maint-1.5.1' into maintJunio C Hamano2007-05-201-8/+9
|\ \ | |/ | | | | | | | | | | | | | | | | * maint-1.5.1: annotate: make it work from subdirectories. git-config: Correct asciidoc documentation for --int/--bool t1300: Add tests for git-config --bool --get unpack-trees.c: verify_uptodate: remove dead code Use PATH_MAX instead of TEMPFILE_PATH_LEN branch: fix segfault when resolving an invalid HEAD
| * git-config: Correct asciidoc documentation for --int/--boolFrank Lichtenheld2007-05-201-8/+9
| | | | | | | | | | | | | | | | | | The asciidoc documentation seemed to indicate that type specifiers are honoured on writing operations which they aren't. Make this more clear. Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | GIT 1.5.2v1.5.2Junio C Hamano2007-05-202-21/+25
| | | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Merge branch 'maint' to synchronize with 1.5.1.6Junio C Hamano2007-05-205-59/+205
|\ \ | |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
| * GIT 1.5.1.6v1.5.1.6Junio C Hamano2007-05-202-7/+46
| | | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>