summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)AuthorFilesLines
2008-04-11Document option --only of git commitLibravatar Johannes Sixt1-0/+11
Its documentation was removed by 6c96753 (Documentation/git-commit: rewrite to make it more end-user friendly, 2006-12-08), even though it is referenced from a few places, including builtin-commit.c (as part of the commentary in the commit message template). Signed-off-by: Johannes Sixt <johannes.sixt@telecom.at> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-04-11Documentation/git-request-pull: Fixed a typo ("send" -> "end")Libravatar Dirk Suesserott1-1/+1
Signed-off-by: Dirk Suesserott <newsletter@dirk.my1.cc> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-04-10core-tutorial.txt: Fix showing the current behaviour.Libravatar Carlos Rica1-6/+6
The --root option from "git diff-tree" won't do nothing when is given to commands like git-whatchanged or git-log, because those always print the initial commit by default. This fixes the tutorial explaining the function of the log.showroot configuration variable. Signed-off-by: Carlos Rica <jasampler@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-04-10Fix documentation syntax of optional arguments in short options.Libravatar Carlos Rica1-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>
2008-03-27GIT 1.5.4.5Libravatar Junio C Hamano1-6/+0
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-03-27Update draft release notes for 1.5.4.5Libravatar Junio C Hamano1-1/+10
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-03-27Documentation: clarify use of .git{ignore,attributes} versus .git/info/*Libravatar Jeff King2-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>
2008-03-26Fix the wrong output of `git-show v1.3.0~155^2~4` in documentation.Libravatar Guanqun Lu1-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)
2008-03-16Start draft ReleaseNotes for 1.5.4.5Libravatar Junio C Hamano1-0/+53
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-03-15Make man page building quiet when DOCBOOK_XSL_172 is definedLibravatar Jonas Fonseca1-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>
2008-03-13Minor wording changes in the keyboard descriptions in git-add --interactive.Libravatar Vineet Kumar1-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>
2008-03-10git-pull documentation: warn about the option orderLibravatar Junio C Hamano1-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>
2008-03-08GIT 1.5.4.4Libravatar Junio C Hamano1-6/+26
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-03-07config.txt: refer to --upload-pack and --receive-pack instead of --execLibravatar Uwe Kleine-König1-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>
2008-03-03Fix incorrect wording in git-merge.txt.Libravatar Matthieu Moy1-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>
2008-03-02Update draft release notes for 1.5.4.4Libravatar Junio C Hamano1-1/+21
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-29Documentation cherry-pick: Fix cut-and-paste errorLibravatar Mike Ralphson1-1/+1
Signed-off-by: Mike Ralphson <mike@abacus.co.uk> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-28Correct name of diff_flush() in API documentationLibravatar Daniel Barkalow1-1/+1
Signed-off-by: Daniel Barkalow <barkalow@iabervon.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-27Start preparing for 1.5.4.4Libravatar Junio C Hamano1-0/+26
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-27Documentation/git svn log: add a note about timezones.Libravatar Miklos Vajna1-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>
2008-02-25Documentation/git-am.txt: Pass -r in the example invocation of rm -f .dotestLibravatar Bryan Donlan1-1/+1
Signed-off-by: Bryan Donlan <bdonlan@fushizen.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-25filter-branch documentation: non-zero exit status in command abort the filterLibravatar Caio Marcelo de Oliveira Filho1-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>
2008-02-25Documentation/git-filter-branch: add a new msg-filter exampleLibravatar Miklos Vajna1-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>
2008-02-23GIT 1.5.4.3Libravatar Junio C Hamano1-0/+27
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-20Clarified the meaning of git-add -u in the documentationLibravatar Pekka Kaitaniemi1-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>
2008-02-20Documentation/git-stash: document options for git stash listLibravatar Miklos Vajna1-1/+4
Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-19push: document the status outputLibravatar Jeff King1-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>
2008-02-19Documentation/push: clarify matching refspec behaviorLibravatar Jeff King1-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>
2008-02-17GIT 1.5.4.2Libravatar Junio C Hamano2-0/+60
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-16Documentation/git-reset: Add an example of resetting selected pathsLibravatar Pieter de Bie1-0/+17
Signed-off-by: Pieter de Bie <pdebie@ai.rug.nl> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-16Documentation/git-reset: don't mention --mixed for selected-paths resetLibravatar Pieter de Bie1-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>
2008-02-16Documentation/git-reset:Libravatar Junio C Hamano1-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>
2008-02-13git clone -s documentation: force a new paragraph for the NOTELibravatar Miklos Vajna1-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>
2008-02-13git-cvsimport.txt: fix '-M' description.Libravatar Sergei Organov1-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>
2008-02-11man pages are littered with .ft C and othersLibravatar Jonas Fonseca2-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>
2008-02-11Document that the default of branch.autosetupmerge is trueLibravatar Johannes Schindelin3-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>
2008-02-11git-pull documentation: fix markupLibravatar Junio C Hamano1-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>
2008-02-09Fix typo in 'blame' documentation.Libravatar Tim Stoakes1-1/+1
Signed-off-by: Tim Stoakes <tim@stoakes.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-03git-remote documentation: fix synopsis to match descriptionLibravatar Jörg Sommer1-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>
2008-02-03Documentation/git-stash.txt: Adjust SYNOPSIS command syntax (2)Libravatar Jari Aalto1-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>
2008-02-01Update stale documentation links from the main documentation.Libravatar Junio C Hamano1-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>
2008-02-01GIT 1.5.4Libravatar Junio C Hamano1-11/+5
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-31git rev-parse manpage: spelling fixLibravatar Miklos Vajna1-2/+2
Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-31Revert "filter-branch docs: remove brackets so not to imply revision arg is ↵Libravatar Junio C Hamano1-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.
2008-01-30Documentation/git-cvsserver: Fix typoLibravatar Jean-Luc Herren1-1/+1
Signed-off-by: Jean-Luc Herren <jlh@gmx.ch> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-30filter-branch docs: remove brackets so not to imply revision arg is optionalLibravatar Brandon Casey1-1/+1
Signed-off-by: Brandon Casey <casey@nrlssc.navy.mil> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-29fix doc typosLibravatar Jim Meyering5-8/+8
Signed-off-by: Jim Meyering <meyering@redhat.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-29instaweb: use 'browser.<tool>.path' config option if it's set.Libravatar Christian Couder1-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>
2008-01-29Documentation: help: specify supported html browsers.Libravatar Christian Couder1-0/+10
Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-29Documentation: config: add "browser.<tool>.path".Libravatar Christian Couder1-0/+4
Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>