summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)Author
2008-01-16close_lock_file(): new function in the lockfile APIBrandon Casey
The lockfile API is a handy way to obtain a file that is cleaned up if you die(). But sometimes you would need this sequence to work: 1. hold_lock_file_for_update() to get a file descriptor for writing; 2. write the contents out, without being able to decide if the results should be committed or rolled back; 3. do something else that makes the decision --- and this "something else" needs the lockfile not to have an open file descriptor for writing (e.g. Windows do not want a open file to be renamed); 4. call commit_lock_file() or rollback_lock_file() as appropriately. This adds close_lock_file() you can call between step 2 and 3 in the above sequence. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-16Document lockfile APIJunio C Hamano
We have nice set of placeholders, but nobody stepped in to fill the gap in the API documentation, so I am doing it myself. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-16Documentation: fix and clarify grammar in git-merge docs.Dave Peticolas
Signed-off-by: Dave Peticolas <dave@krondo.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-15Add using merge subtree How-ToMiklos Vajna
Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-15Fix git-rerere documentationJunio C Hamano
rerere.enabled is _not_ on by default. The command is enabled if rr-cache exists even when rerere.enabled is missing, and enabled or disabled by explicitly setting the rerere.enabled variable.
2008-01-12GIT 1.5.4-rc3v1.5.4-rc3Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-12git-relink.txt: describe more clearly how hard linking occursBrandon Casey
Signed-off-by: Brandon Casey <casey@nrlssc.navy.mil> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-12Document some default values in config.txtMichele Ballabio
This documents the default values of gc.auto, gc.autopacklimit fetch.unpacklimit, receive.unpacklimit and transfer.unpacklimit. Signed-off-by: Michele Ballabio <barra_cuda@katamail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-09Change git-gc documentation to reflect gc.packrefs implementation.Florian La Roche
56752391a8c0c591853b276e4fa0b45c34ced181 (Make "git gc" pack all refs by default) changed the default of gc.packrefs to true, to pack all refs by default in any repository. IOW, the users need to disable it explicitly if they want to by setting the config variable, since 1.5.3. However, we forgot to update the documentation. This fixes it. Signed-off-by: Florian La Roche <laroche@redhat.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-08Merge in GIT 1.5.3.8Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-08GIT 1.5.3.8v1.5.3.8Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-08Documentation: config: add 'help.*' and 'instaweb.*' variables.Christian Couder
Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-07Documentation: typofixRalf Wildenhues
Signed-off-by: Ralf Wildenhues <Ralf.Wildenhues@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-07Update draft release notes for 1.5.4Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-07Document the color.interactive semanticsJeff King
There are two possible confusions with the color.interactive description: 1. the short name "interactive" implies that it covers all interactive commands; let's explicitly make it so, even though there are no other interactive commands which currently use it 2. Not all parts of "git add --interactive" are controlled by color.interactive (specifically, the diffs require tweaking color.diff). So let's clarify that it applies only to displays and prompts. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-07Documentation: rename gitlink macro to linkgitDan McGee
Between AsciiDoc 8.2.2 and 8.2.3, the following change was made to the stock Asciidoc configuration: @@ -149,7 +153,10 @@ # Inline macros. # Backslash prefix required for escape processing. # (?s) re flag for line spanning. -(?su)[\\]?(?P<name>\w(\w|-)*?):(?P<target>\S*?)(\[(?P<attrlist>.*?)\])= + +# Explicit so they can be nested. +(?su)[\\]?(?P<name>(http|https|ftp|file|mailto|callto|image|link)):(?P<target>\S*?)(\[(?P<attrlist>.*?)\])= + # Anchor: [[[id]]]. Bibliographic anchor. (?su)[\\]?\[\[\[(?P<attrlist>[\w][\w-]*?)\]\]\]=anchor3 # Anchor: [[id,xreflabel]] This default regex now matches explicit values, and unfortunately in this case gitlink was being matched by just 'link', causing the wrong inline macro template to be applied. By renaming the macro, we can avoid being matched by the wrong regex. Signed-off-by: Dan McGee <dpmcgee@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-07Documentation: fix "gitlink::foobar[s]"Junio C Hamano
They should be spelled with a single colon. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-07Documentation: remove gitman.info with "make clean"Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-07Documentation/Makefile - honor $DESTDIR for quick-install targetMark Levedahl
Signed-off-by: Mark Levedahl <mdl123@verizon.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-07git-rev-parse --symbolic-full-nameJunio C Hamano
The plumbing level can understand that the user meant "refs/heads/master" when the user says "master" or "heads/master", but there is no easy way for the scripts to figure it out without duplicating the dwim_ref() logic. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-05Update draft release notes for 1.5.4Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-05Document git-reset defaults to HEAD if no commit is givenMarco Costalba
Signed-off by: Marco Costalba <mcostalba@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-03Fix grammar nits in documentation and in code comments.Jim Meyering
Signed-off-by: Jim Meyering <meyering@redhat.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-31Merge branch 'maint' of git://linux-nfs.org/~bfields/gitJunio C Hamano
* 'maint' of git://linux-nfs.org/~bfields/git: Documentation/user-manual.txt: fix typo Documentation: fix remote.<name>.skipDefaultUpdate description
2007-12-31Documentation/user-manual.txt: fix typoGustaf Hendeby
Signed-off-by: Gustaf Hendeby <hendeby@isy.liu.se> Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-12-31Documentation: fix remote.<name>.skipDefaultUpdate descriptionJ. Bruce Fields
Fix the subcommand name. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-12-29git-sh-setup: document git_editor() and get_author_ident_from_commit()Miklos Vajna
These 2 functions were missing from the manpage. Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-28Documentation/git-submodule.txt: typofixJunio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-27GIT 1.5.4-rc2v1.5.4-rc2Junio C Hamano
Although everybody was quiet during the Christmas holiday, it's been a week since -rc1, so here is -rc2. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-27Merge branch 'ar/commit-cleanup'Junio C Hamano
* ar/commit-cleanup: Allow selection of different cleanup modes for commit messages builtin-commit: avoid double-negation in the code. builtin-commit: fix amending of the initial commit t7005: do not exit inside test.
2007-12-27Fix documentation of --first-parent in git-log and copy it to git-rev-listJunio C Hamano
Credit goes to Avi Kivity for noticing the lack of description in rev-list manual page. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-23shortlog manpage documentation: work around asciidoc markup issuesGustaf Hendeby
We wanted to have a list in which one (and the sole, as it happen to be) item in it is ".mailmap", but do not seem to be able to convince AsciiDoc to format it correctly for manpages. Reformat it into a paragraph that describes the said file to work around the issue. Signed-off-by: Gustaf Hendeby <hendeby@isy.liu.se> Acked-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-23Documentation: describe 'union' low-level merge driverJunio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-23Allow selection of different cleanup modes for commit messagesAlex Riesen
Although we traditionally stripped away excess blank lines, trailing whitespaces and lines that begin with "#" from the commit log message, sometimes the message just has to be the way user wants it. For instance, a commit message template can contain lines that begin with "#", the message must be kept as close to its original source as possible if you are converting from a foreign SCM, or maybe the message has a shell script including its comments for future reference. The cleanup modes are default, verbatim, whitespace and strip. The default mode depends on if the message is being edited and will either strip whitespace and comments (if editor active) or just strip the whitespace (for where the message is given explicitely). Signed-off-by: Alex Riesen <raa.lkml@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-22parse-options: Add a gitcli(5) man page.Pierre Habouzit
This page should hold every information about the git ways to parse command lines, and best practices to be used for scripting. Signed-off-by: Pierre Habouzit <madcoder@debian.org>
2007-12-21Documentation: ls-files -v is about "assume unchanged".Junio C Hamano
And refer the reader to update-index documentation. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-21everyday: replace 'prune' and 'repack' with 'gc'Miklos Vajna
In everyday tasks, "repack -a -d -f" won't be used, so there is not much point mentioning "repack". By showing the --prune option to "gc", we can do without mentioning "git prune", too. Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-21clean up 1.5.4 release notesJeff King
Mostly typo and small grammatical fixes with one or two rewordings for clarity. But note the important fix for status.relativepaths. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-21Mention git-shell's "cvs" substitution in the RelNotesJohannes Schindelin
git shell became much more powerful for existing CVS setups. We should not hide from those people who only read release notes. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-20Teach diff machinery to display other prefixes than "a/" and "b/"Johannes Schindelin
With the new options "--src-prefix=<prefix>", "--dst-prefix=<prefix>" and "--no-prefix", you can now control the path prefixes of the diff machinery. These used to by hardwired to "a/" for the source prefix and "b/" for the destination prefix. Initial patch by Pascal Obry. Sane option names suggested by Linus. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Acked-by: Linus Torvalds <torvalds@linux-foundation.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-20GIT 1.5.4-rc1v1.5.4-rc1Junio C Hamano
It's been a week since -rc0, and we have quite a lot of fixes, so here it is. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-18Fix some documentation typos.Ralf Wildenhues
Signed-off-by: Ralf Wildenhues <Ralf.Wildenhues@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-18Document diff.external and mergetool.<tool>.pathJohannes Schindelin
There was no documentation for the config variables diff.external and mergetool.<tool>.path. Noticed by Sebastian Schuberth. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-18Clean up documentation that references deprecated 'git peek-remote'.Johannes Sixt
Now that 'git peek-remote' is deprecated and only an alias for 'git ls-remote', it should not be referenced from other manual pages. This also removes the description of the --exec option, which is no longer present. Signed-off-by: Johannes Sixt <johannes.sixt@telecom.at> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-17Documentation/git-submodule: refer to gitmodules(5)Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-16whitespace: fix config.txt description of indent-with-non-tabJ. Bruce Fields
Fix garbled description. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-16rename git-browse--help to git-help--browseJeff King
The convention for helper scripts has been git-$TOOL--$HELPER. Since this is a "browse" helper for the "help" tool, git-help--browse is a more sensible name. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-15Update draft release notes for 1.5.4Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-15Start preparing the API documents.Junio C Hamano
Most of them are still stubs, but the procedure to build the HTML documentation, maintaining the index and installing the end product are there. I placed names of people who are likely to know the most about the topic in the stub files, so that volunteers will know whom to ask questions as needed. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-15Retire git-runstatus for real.Junio C Hamano
The command was removed from the builtin command list and there was no way to invoke it, but the code was still there. Signed-off-by: Junio C Hamano <gitster@pobox.com>