summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)AuthorFilesLines
2007-11-25user-manual: recovering from corruptionLibravatar J. Bruce Fields1-1/+130
Some instructions on dealing with corruption of the object database. Most of this text is from an example by Linus, identified by Nicolas Pitre <nico@cam.org> with a little further editing by me. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-11-25user-manual: clarify language about "modifying" old commitsLibravatar J. Bruce Fields1-9/+11
It's important to remember that git doesn't really allowing "editing" or "modifying" commits, only replacing them by new commits. Redo some of the language to make this clearer. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-11-25user-manual: failed push to public repositoryLibravatar J. Bruce Fields1-9/+49
More details on the case of a failed push to a public (non-shared) repository. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-11-25user-manual: define "branch" and "working tree" at startLibravatar J. Bruce Fields1-6/+12
Some explanation here might help. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-11-20Doc fix for git-reflog: mention @{...} syntax, and <ref> in synopsys.Libravatar Matthieu Moy1-4/+11
The HEAD@{...} syntax was documented in git-rev-parse manpage, which is hard to find by someone looking for the documentation of porcelain. git-reflog is probably the place where one expects to find this. While I'm there, "git revlog show whatever" was also undocumented. Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-20config: clarify compression defaultsLibravatar Brian Downing1-1/+5
* Clarify that core.compression provides a system-wide default to other compression parameters. * Explain that the default for pack.compression, -1, is "a default compromise between speed and compression (currently equivalent to level 6)" according to zlib.h. Signed-off-by: Brian Downing <bdowning@lavos.net> Acked-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-20config: correct core.loosecompression documentationLibravatar Brian Downing1-1/+1
* core.loosecompression stated that the default was "0 (best speed)", when in fact 0 is "no compression", and the default is Z_BEST_SPEED, which is 1. Signed-off-by: Brian Downing <bdowning@lavos.net> Acked-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-18Merge branch 'maint' of git://linux-nfs.org/~bfields/git into maintLibravatar Junio C Hamano4-13/+81
* 'maint' of git://linux-nfs.org/~bfields/git: Documentation: Fix references to deprecated commands user-manual: mention "..." in "Generating diffs", etc. user-manual: Add section "Why bisecting merge commits can be harder ..." git-remote.txt: fix example url
2007-11-18Documentation: Fix references to deprecated commandsLibravatar J. Bruce Fields2-8/+3
... by changing git-tar-tree reference to git-archive and removing seemingly unrelevant footnote about git-ssh-{fetch,upload}. Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-11-18user-manual: mention "..." in "Generating diffs", etc.Libravatar J. Bruce Fields1-4/+11
We should mention the use of the "..." syntax for git-diff here. The note about the difference between diff and the combined output of git-format-patch then no longer fits so well, so remove it. Add a reference to the git-format-patch[1] manpage. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-11-18user-manual: Add section "Why bisecting merge commits can be harder ..."Libravatar Steffen Prohaska1-0/+66
This commit adds a discussion of the challenge of bisecting merge commits to the user manual. The original author is Junio C Hamano <gitster@pobox.com>, who posted the text to the mailing list <http://marc.info/?l=git&m=119403257315527&w=2>. His email was adapted for the manual. The discussion is added to "Rewriting history and maintainig patch series". The text added requires good understanding of merging and rebasing. Therefore it should not be placed too early in the manual. Right after the section on "Problems with rewriting history", the discussion of bisect gives another reason for linearizing as much of the history as possible. The text includes suggestions and fixes by Ralf Wildenhues <Ralf.Wildenhues@gmx.de> and Benoit Sigoure <tsuna@lrde.epita.fr>. Signed-off-by: Steffen Prohaska <prohaska@zib.de> Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-11-18GIT 1.5.3.6Libravatar Junio C Hamano1-9/+5
2007-11-17git-remote.txt: fix example urlLibravatar J. Bruce Fields1-1/+1
If I'm going to use a real example as a URL, I suppose I should get it right.... Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-11-16Update draft release notes for 1.5.3.6Libravatar Junio C Hamano1-1/+32
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-14Documentation: Fix man page breakage with DocBook XSL v1.72Libravatar Jonas Fonseca2-3/+10
From version 1.72 it will replace all dots in roff requests with U+2302 ("house" character), and add escaping in output for all instances of dot that are not in roff requests. This caused the ".ft" hack forcing monospace font in listingblocks to end up as "\&.ft" and being visible in the resulting man page. The fix adds a DOCBOOK_XSL_172 build variable that will disable the hack. To allow this variable to be defined in config.mak it also moves build variable handling below the inclusion of config.mak. Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-14git-remote.txt: fix typoLibravatar Sergei Organov1-1/+1
Signed-off-by: Sergei Organov <osv@javad.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-14core-tutorial.txt: Fix argument mistake in an example.Libravatar Sergei Organov1-2/+2
One of examples has wrong output given the arguments provided. Fix arguments to match the output. Fix a minor syntax mistake in another place. Signed-off-by: Sergei Organov <osv@javad.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-14replace reference to git-rm with git-reset in git-commit docLibravatar Jing Xue2-4/+8
The message in git-commit suggesting to use 'git rm --cached' to unstage is just plain wrong. It really should mention 'git reset'. Suggested by Jan Hudec. Signed-off-by: Jing Xue <jingxue@digizenstudio.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-14Grammar fixes for gitattributes documentationLibravatar Wincent Colaiuta1-8/+9
Tweak the "filter" section of the gitattributes documentation to add some missing articles and improve some word choices without changing the semantics of the section. Signed-off-by: Wincent Colaiuta <win@wincent.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-11git-branch: remove mention of non-existent '-b' optionLibravatar Jeff King1-1/+1
This looks like a cut and paste error from the git-checkout explanation of --no-track. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-09Start preparing for 1.5.3.6Libravatar Junio C Hamano1-0/+21
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-08SubmittingPatches: improve the 'Patch:' section of the checklistLibravatar Sergei Organov1-5/+4
There were 2 items "send patch to..." but having different set of addresses to send patch to. Merge them together and move the resulting item to the end of checklist. Signed-off-by: Sergei Organov <osv@javad.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-07Add Documentation/CodingGuidelinesLibravatar Johannes Schindelin1-0/+112
Even if our code is quite a good documentation for our coding style, some people seem to prefer a document describing it. The part about the shell scripts is clearly just copied from one of Junio's helpful mails, and some parts were added from comments by Junio, Andreas Ericsson and Robin Rosenberg. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-07RelNotes-1.5.3.5: fix another typoLibravatar David D Kilzer1-1/+1
Signed-off-by: David D Kilzer <ddkilzer@kilzer.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-05Merge branch 'gp/maint-diffdoc' into maintLibravatar Junio C Hamano2-9/+13
* gp/maint-diffdoc: git-diff.txt: add section "output format" describing the diff formats
2007-11-03RelNotes-1.5.3.5: fix typoLibravatar David D Kilzer1-2/+2
Signed-off-by: David D Kilzer <ddkilzer@kilzer.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-02Documentation: quote commit messages consistently.Libravatar Sergei Organov3-7/+7
Documentation quotes commit messages 14 times with double-quotes, and 7 times with single-quotes. The patch turns everything to double-quotes. A nice side effect is that documentation becomes more Windoze-friendly as AFAIK single quotes won't work there. Signed-off-by: Sergei Organov <osv@javad.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-02Remove escaping of '|' in manpage option sectionsLibravatar Jonas Fonseca2-2/+2
The escaped were ending up verbatim in the generated documentation. Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-01git-diff.txt: add section "output format" describing the diff formatsLibravatar Gerrit Pape2-9/+13
git-diff.txt includes diff-options.txt which for the -p option refers to a section "generating patches.." which is missing from the git-diff documentation. This patch adapts diff-format.txt to additionally mention the git-diff program, and includes diff-format.txt into git-diff.txt. Tino Keitel noticed this problem. Signed-off-by: Gerrit Pape <pape@smarden.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-01git-format-patch.txt: fix explanation of an example.Libravatar Sergei Organov1-1/+1
Signed-off-by: Sergei Organov <osv@javad.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-01git-filter-branch.txt: fix a typo.Libravatar Sergei Organov1-1/+1
Signed-off-by: Sergei Organov <osv@javad.com> Acked-by: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-01git-clone.txt: Improve --depth description.Libravatar Ralf Wildenhues1-3/+3
Avoid abbreviation 'revs', improve the language a bit. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-10-31GIT 1.5.3.5Libravatar Junio C Hamano1-6/+0
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-10-30Update GIT 1.5.3.5 Release NotesLibravatar Junio C Hamano1-1/+7
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-10-30core-tutorial: Use new syntax for git-merge.Libravatar Sergei Organov1-4/+4
"git-merge <msg> HEAD <other branches>" is still supported but we shouldn't encourage its use. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-10-30git-merge: document but discourage the historical syntaxLibravatar Junio C Hamano1-5/+6
Historically "git merge" took its command line arguments in a rather strange order. Document the historical syntax, and also document clearly that it is not encouraged in new scripts. There is no reason to deprecate the historical syntax, as the current code can sanely tell which syntax the caller is using, and existing scripts by people do use the historical syntax. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-10-30Documentation/git-cvsexportcommit.txt: s/mgs/msg/ in exampleLibravatar Michael W. Olson1-1/+1
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-10-29RelNotes-1.5.3.5: describe recent fixesLibravatar Junio C Hamano1-0/+21
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-10-21Describe more 1.5.3.5 fixes in release notesLibravatar Shawn O. Pearce1-0/+15
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-10-19gitk.txt: Fix markup.Libravatar Ralf Wildenhues1-1/+1
For the manpage, avoid generating an em dash in code. Signed-off-by: Ralf Wildenhues <Ralf.Wildenhues@gmx.de> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-10-19Further 1.5.3.5 fixes described in release notesLibravatar Shawn O. Pearce1-3/+13
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-10-18Yet more 1.5.3.5 fixes mentioned in release notesLibravatar Shawn O. Pearce1-0/+8
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-10-16Document additional 1.5.3.5 fixes in release notesLibravatar Shawn O. Pearce1-0/+15
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-10-16fix filter-branch documentationLibravatar Johannes Schindelin1-2/+1
The man page for filter-branch still talked about writing the result to the branch "newbranch". This is hopefully the last place where the old behaviour was described. Noticed by Bill Lear. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-10-16Correct typos in release notes for 1.5.3.5Libravatar Shawn O. Pearce1-2/+2
Noticed by Michele Ballabio. Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-10-15Whip post 1.5.3.4 maintenance series into shape.Libravatar Shawn O. Pearce1-0/+25
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-10-15git-archive: document --execLibravatar Michele Ballabio1-1/+6
Signed-off-by: Michele Ballabio <barra_cuda@katamail.com> Signed-off-by: Lars Hjemli <hjemli@gmail.com> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-10-15git-reflog: document --verboseLibravatar Michele Ballabio1-1/+4
Signed-off-by: Michele Ballabio <barra_cuda@katamail.com> Signed-off-by: Lars Hjemli <hjemli@gmail.com> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-10-03GIT 1.5.3.4Libravatar Junio C Hamano1-10/+17
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-10-02Note that git-branch will not automatically checkout the new branchLibravatar Federico Mena Quintero1-0/+4
Signed-off-by: Federico Mena Quintero <federico@gnu.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>