summaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* Fix documentation syntax of optional arguments in short options.Carlos Rica2008-04-101-2/+2
| | | | | | | | | | | When an argument for an option is optional, like in -n from git-tag, puting a space between the option and the argument is interpreted as a missing argument for the option plus an isolated argument. Documentation now reflects the need to write the parameter following the option -n, as in "git tag -nARG", for instance. Signed-off-by: Carlos Rica <jasampler@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* GIT 1.5.4.5v1.5.4.5Junio C Hamano2008-03-271-6/+0
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Update draft release notes for 1.5.4.5Junio C Hamano2008-03-271-1/+10
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: clarify use of .git{ignore,attributes} versus .git/info/*Jeff King2008-03-272-0/+19
| | | | | | | | | | | | | gitignore patterns can be read from three different files, while gitattributes can come from two files. Let's provide some hints to the user about the differences and how they are typically used. Suggested by Toby Corkindale, but gratuitously reworded by Jeff King. Signed-off-by: Toby Corkindale <toby.corkindale@rea-group.com> Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Fix the wrong output of `git-show v1.3.0~155^2~4` in documentation.Guanqun Lu2008-03-261-1/+1
| | | | | | | | Texts between ~ and ~ will be subscripted during the asciidoc translation. Signed-off-by: Guanqun Lu <Guanqun.Lu@Gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> (cherry picked from commit 0c829391cfcdc57172765322575804a7ad5f3116)
* Start draft ReleaseNotes for 1.5.4.5Junio C Hamano2008-03-161-0/+53
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Make man page building quiet when DOCBOOK_XSL_172 is definedJonas Fonseca2008-03-151-1/+5
| | | | | | | | | | Tell xmlto to repress printing of the lines: Note: meta date : No date. Using generated date git-xyx Note: Writing git-xyz.1 Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Minor wording changes in the keyboard descriptions in git-add --interactive.Vineet Kumar2008-03-131-10/+8
| | | | | | | | The wording of the interactive help text from git-add--interactive.perl is clearer. Just duplicate that text here. Signed-off-by: Vineet Kumar <vineet@doorstop.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* git-pull documentation: warn about the option orderJunio C Hamano2008-03-101-0/+2
| | | | | | | We might eventually be loosening this rule, but there is a longstanding restriction that the users currently need to be aware of. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* GIT 1.5.4.4v1.5.4.4Junio C Hamano2008-03-081-6/+26
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* config.txt: refer to --upload-pack and --receive-pack instead of --execUwe Kleine-König2008-03-071-4/+4
| | | | | | | | | The options --upload-pack (of git-fetch-pack) and --receive-pack (of git-push) do the same as --exec (for both commands). But the former options have the more descriptive name. Signed-off-by: Uwe Kleine-König <Uwe.Kleine-Koenig@digi.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Fix incorrect wording in git-merge.txt.Matthieu Moy2008-03-031-1/+2
| | | | | | | | | | | | A merge is not necessarily with a remote branch, it can be with any commit. Thanks to Paolo Ciarrocchi for pointing out the problem, and to Nicolas Pitre for pointing out the fact that a merge is not necessarily with a branch head. Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Update draft release notes for 1.5.4.4Junio C Hamano2008-03-021-1/+21
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation cherry-pick: Fix cut-and-paste errorMike Ralphson2008-02-291-1/+1
| | | | | Signed-off-by: Mike Ralphson <mike@abacus.co.uk> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Correct name of diff_flush() in API documentationDaniel Barkalow2008-02-281-1/+1
| | | | | Signed-off-by: Daniel Barkalow <barkalow@iabervon.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Start preparing for 1.5.4.4Junio C Hamano2008-02-271-0/+26
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/git svn log: add a note about timezones.Miklos Vajna2008-02-271-0/+4
| | | | | | | | git svn log mimics the timezone converting behaviour of svn log, but this was undocumented. Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/git-am.txt: Pass -r in the example invocation of rm -f .dotestBryan Donlan2008-02-251-1/+1
| | | | | Signed-off-by: Bryan Donlan <bdonlan@fushizen.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* filter-branch documentation: non-zero exit status in command abort the filterCaio Marcelo de Oliveira Filho2008-02-251-2/+4
| | | | | | | | | | | Since commit 8c1ce0f46b85d40f215084eed7313896300082df filter-branch fails when a <command> has a non-zero exit status. This commit makes it clear in the documentation and also fixes the parent-filter example, that was incorrectly returning non-zero when the commit being tested wasn't the one to be rewritten. Signed-off-by: Caio Marcelo de Oliveira Filho <cmarcelo@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/git-filter-branch: add a new msg-filter exampleMiklos Vajna2008-02-251-0/+9
| | | | | | | | There were no example on how to edit commit messages, so add an msg-filter example. Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* GIT 1.5.4.3v1.5.4.3Junio C Hamano2008-02-231-0/+27
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Clarified the meaning of git-add -u in the documentationPekka Kaitaniemi2008-02-201-2/+2
| | | | | | | | | The git-add documentation did not state clearly that the -u switch updates only the tracked files that are in the current directory and its subdirectories. Signed-off-by: Pekka Kaitaniemi <kaitanie@cc.helsinki.fi> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/git-stash: document options for git stash listMiklos Vajna2008-02-201-1/+4
| | | | | Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* push: document the status outputJeff King2008-02-191-0/+49
| | | | | | | | | The output was meant to be a balance of self-explanatory and terse. In case we have erred too far on the terse side, it doesn't hurt to explain in more detail what each line means. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/push: clarify matching refspec behaviorJeff King2008-02-191-3/+3
| | | | | | | | | | | | | | | | | | | The previous text was correct, but it was easy to miss the fact that we are talking about "matching" refs. That is, the text can be parsed as "we push the union of the sets of remote and local heads" and not "we push the intersection of the sets of remote and local heads". (The former actually doesn't make sense if you think about it, since we don't even _have_ some of those heads). A careful reading would reveal the correct meaning, but it makes sense to be as explicit as possible in documentation. We also explicitly use and introduce the term "matching"; this is a term discussed on the list, and it seems useful to for users to be able to refer to this behavior by name. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* GIT 1.5.4.2v1.5.4.2Junio C Hamano2008-02-172-0/+60
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/git-reset: Add an example of resetting selected pathsPieter de Bie2008-02-161-0/+17
| | | | | Signed-off-by: Pieter de Bie <pdebie@ai.rug.nl> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/git-reset: don't mention --mixed for selected-paths resetPieter de Bie2008-02-161-2/+2
| | | | | | | | | The option is accepted, but that is the only form selected-paths variant of the reset command takes, so there is no point mentioning it. And while we're at it, use the dashless git call. Signed-off-by: Pieter de Bie <pdebie@ai.rug.nl> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/git-reset:Junio C Hamano2008-02-161-1/+1
| | | | | | | | Since 3368d11 (Remove unnecessary git-rm --cached reference from status output), the status output marks the "Added but not yet committed" section as "Changes to be committed". Signed-off-by: Junio C Hamano <gitster@pobox.com>
* git clone -s documentation: force a new paragraph for the NOTEMiklos Vajna2008-02-131-6/+7
| | | | | | | It should be loud and clear. Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* git-cvsimport.txt: fix '-M' description.Sergei Organov2008-02-131-2/+2
| | | | | | | | Fix '-M' description. Old one reads as if the user can somehow "see" the default regex when using -M along with -m. Signed-off-by: Sergei Organov <osv@javad.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* man pages are littered with .ft C and othersJonas Fonseca2008-02-112-1/+20
| | | | | | | | | | | | | | | | | | | | | Jakub Narebski <jnareb@gmail.com> wrote Sun, Feb 03, 2008: > Junio C Hamano wrote: > > Jakub Narebski <jnareb@gmail.com> writes: > > > > [From] http://thread.gmane.org/gmane.comp.version-control.git/53457/focus=53458 > Julian Phillips: > > Are you using docbook xsl 1.72? There are known problems building the > > manpages with that version. 1.71 works, and 1.73 should work when it get > > released. I was able to solve this problem with this patch, which adds a XSL file used specifically for DOCBOOK_XSL_172=YesPlease and where dots and backslashes are escaped properly so they won't be substituted to the wrong thing further down the "DocBook XSL pipeline". Doing the escaping in the existing callout.xsl breaks v1.70.1. Hopefully v1.73 will end this part of the manpage nightmare. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Document that the default of branch.autosetupmerge is trueJohannes Schindelin2008-02-113-11/+13
| | | | | | | | | | | In 34a3e69 (git-branch: default to --track) the default was changed to true, to help new git users. But yours truly forgot to update the documentation. This fixes it. Noticed by Kalle Olavi Niemitalo. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* git-pull documentation: fix markupJunio C Hamano2008-02-111-5/+5
| | | | | | | A note paragraph was mistakenly made into an indented monospace display. Noticed by Miklos Vajna. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Fix typo in 'blame' documentation.v1.5.4.1Tim Stoakes2008-02-091-1/+1
| | | | | Signed-off-by: Tim Stoakes <tim@stoakes.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* git-remote documentation: fix synopsis to match descriptionJörg Sommer2008-02-031-1/+1
| | | | | | | | In the text, the argument of -m is <master> which should be used in the command synopsis, too. Signed-off-by: Jörg Sommer <joerg@alea.gnuu.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/git-stash.txt: Adjust SYNOPSIS command syntax (2)Jari Aalto2008-02-031-3/+4
| | | | | | | | Adjust the command syntax to better reflect the call parameters: [save] [message...] => [save [<message>]]. Signed-off-by: Jari Aalto <jari.aalto AT cante.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Update stale documentation links from the main documentation.Junio C Hamano2008-02-011-0/+5
| | | | | | This could have been part of the 1.5.4 commit, but it isn't. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* GIT 1.5.4v1.5.4Junio C Hamano2008-02-011-11/+5
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* git rev-parse manpage: spelling fixMiklos Vajna2008-01-311-2/+2
| | | | | Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Revert "filter-branch docs: remove brackets so not to imply revision arg is ↵Junio C Hamano2008-01-311-1/+1
| | | | | | | | optional" This reverts commit c41b439244c51b30c60953192816afc91e552578, as we decided to default to HEAD when revision parameters are missing and they are no longer mandatory.
* Documentation/git-cvsserver: Fix typoJean-Luc Herren2008-01-301-1/+1
| | | | | Signed-off-by: Jean-Luc Herren <jlh@gmx.ch> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* filter-branch docs: remove brackets so not to imply revision arg is optionalBrandon Casey2008-01-301-1/+1
| | | | | Signed-off-by: Brandon Casey <casey@nrlssc.navy.mil> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* fix doc typosJim Meyering2008-01-295-8/+8
| | | | | Signed-off-by: Jim Meyering <meyering@redhat.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* instaweb: use 'browser.<tool>.path' config option if it's set.Christian Couder2008-01-291-1/+2
| | | | | | Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Acked-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: help: specify supported html browsers.Christian Couder2008-01-291-0/+10
| | | | | Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: config: add "browser.<tool>.path".Christian Couder2008-01-291-0/+4
| | | | | Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* GIT 1.5.4-rc5v1.5.4-rc5Junio C Hamano2008-01-261-12/+13
| | | | | | Hopefully the last rc before the final... Signed-off-by: Junio C Hamano <gitster@pobox.com>
* pull --rebase: be cleverer with rebased upstream branchesJohannes Schindelin2008-01-261-1/+5
| | | | | | | | | When the upstream branch is tracked, we can detect if that branch was rebased since it was last fetched. Teach git to use that information to rebase from the old remote head onto the new remote head. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: add a bit about sendemail.to configurationMike Hommey2008-01-261-0/+2
| | | | | | | | While there is information about this in the configuration section, it was missing in the options section. Signed-off-by: Mike Hommey <mh@glandium.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>