aboutsummaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAge
* doc/git-daemon: s/uploadarchive/uploadarch/Jeff King2008-05-19
| | | | | | | | | | | | The git-daemon upload-archive feature has always used the config directive 'daemon.uploadarch'; the documentation which came later seems to have just mistakenly used the wrong name. Noticed by lionel@over-blog.com. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/git-describe.txt: make description more readableIan Hilt2008-05-14
| | | | | | Signed-off-by: Ian Hilt <ian.hilt@gmail.com> Credit-to: Kevin Ballard <kevin@sb.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/config.txt: Mention branch.<name>.rebase applies to "git pull"Dustin Sallings2008-05-08
| | | | | Signed-off-by: Dustin Sallings <dustin@spy.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* doc: clarify definition of "update" for git-add -uJeff King2008-05-08
| | | | | | | | | | | | The "-u" option is described only in terms of "updating" files, which in turn is described only as "similar to what git commit -a does". Let's be a little more specific about what updating entails. Suggested by Geoffrey Irving. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* filter-branch: Documentation fix.Florian Ragwitz2008-05-03
| | | | | | | It's --msg-filter, not --message-filter. Signed-off-by: Florian Ragwitz <rafl@debian.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Linked glossary from cvs-migration pageMatt Graham2008-04-23
| | | | | | | | | | | | Coming from CVS, I found the git glossary vital to learning git and learning how terms in git correlate to the cvs terminology with which I am familiar. This patch links the glossary from the cvs-migration page so cvs users will be able to fine the glossary as soon as they start looking at git documents. Signed-off-by: Matt Graham <mdg149@gmail.com> Acked-by: J. Bruce Fields <bfields@fieldses.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* diff options documentation: refer to --diff-filter in --name-statusMiklos Vajna2008-04-22
| | | | | | | | git diff --name-status outputs letters, but the meaning of those letters is documented elsewhere. Add a note to make the manpage more intuitive. Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Clarify and fix English in "git-rm" documentationJon Loeliger2008-04-16
| | | | | | | | | Do some verb-noun agreement changes. Clarify some file globbing cases. Fixed a wrong statement in an example. Signed-off-by: Jon Loeliger <jdl@jdl.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Clarify documentation of git-cvsserver, particularly in relation to git-shellScott Collins2008-04-15
| | | | | | | | | | | | | | | | | | | For SSH clients restricted to git-shell, CVS_SERVER does not have to be specified, because git-shell understands the default value of 'cvs' to mean git-cvsserver'. This makes it totally transparent to CVS users, but the instruction to set up CVS access for people with real shell access does not apply. Previous wording mentioning GIT_AUTHOR, GIT_COMMITTER variables was unclear that we really meant GIT_AUTHOR_(NAME|EMAIL), etc. Note that the .ssh/environment file is a good place to set these, and that the .bashrc is shell-specific. Add a bit of text to differentiate cvs -d (setting CVSROOT) from cvs co -d (setting the name of the newly checked out directory). Removed an extra 'Example:' string. Signed-off-by: Scott Collins <scc@ScottCollins.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Docs gitk: Explicitly mention the files that gitk uses (~/.gitk)Clifford Caoile2008-04-12
| | | | | | | gitk creates and uses ~/.gitk Signed-off-by: Clifford Caoile <piyo@users.sourceforge.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Document -w option to shortlogJunio C Hamano2008-04-12
| | | | | | Noticed by Fredrik Noring. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Fix section about backdating tags in the git-tag docsBjörn Steinbrink2008-04-11
| | | | | | | | | The tagger is equal to the committer, not the author, so GIT_COMMITTER_DATE is the right environment variable to use, not GIT_AUTHOR_DATE. Signed-off-by: Björn Steinbrink <B.Steinbrink@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Document option --only of git commitJohannes Sixt2008-04-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>
* Documentation/git-request-pull: Fixed a typo ("send" -> "end")Dirk Suesserott2008-04-11
| | | | | Signed-off-by: Dirk Suesserott <newsletter@dirk.my1.cc> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* core-tutorial.txt: Fix showing the current behaviour.Carlos Rica2008-04-10
| | | | | | | | | | | | 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>
* Fix documentation syntax of optional arguments in short options.Carlos Rica2008-04-10
| | | | | | | | | | | 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-27
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Update draft release notes for 1.5.4.5Junio C Hamano2008-03-27
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: clarify use of .git{ignore,attributes} versus .git/info/*Jeff King2008-03-27
| | | | | | | | | | | | | 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-26
| | | | | | | | 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-16
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Make man page building quiet when DOCBOOK_XSL_172 is definedJonas Fonseca2008-03-15
| | | | | | | | | | 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-13
| | | | | | | | 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-10
| | | | | | | 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-08
| | | | 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-07
| | | | | | | | | 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-03
| | | | | | | | | | | | 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-02
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation cherry-pick: Fix cut-and-paste errorMike Ralphson2008-02-29
| | | | | 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-28
| | | | | 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-27
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/git svn log: add a note about timezones.Miklos Vajna2008-02-27
| | | | | | | | 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-25
| | | | | 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-25
| | | | | | | | | | | 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-25
| | | | | | | | 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-23
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Clarified the meaning of git-add -u in the documentationPekka Kaitaniemi2008-02-20
| | | | | | | | | 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-20
| | | | | Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* push: document the status outputJeff King2008-02-19
| | | | | | | | | 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-19
| | | | | | | | | | | | | | | | | | | 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-17
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/git-reset: Add an example of resetting selected pathsPieter de Bie2008-02-16
| | | | | 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-16
| | | | | | | | | 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-16
| | | | | | | | 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-13
| | | | | | | 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-13
| | | | | | | | 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-11
| | | | | | | | | | | | | | | | | | | | | 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-11
| | | | | | | | | | | 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-11
| | | | | | | 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-09
| | | | | Signed-off-by: Tim Stoakes <tim@stoakes.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>