summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)AuthorFilesLines
2007-08-22git-svn: update documentation with CAVEATS sectionLibravatar Eric Wong1-0/+32
Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-22Document -u option in git-svnimport man pageLibravatar Stefan Sperling1-0/+3
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-22Fix breakage in git-rev-list.txtLibravatar Quy Tonthat1-3/+3
Also fix some innocent missing of quotes. Signed-off-by: Quy Tonthat <qtonthat@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-22Documentation: update tar.umask defaultLibravatar René Scharfe3-27/+17
As noted by Mike Hommey, the documentation for the config setting tar.umask is not up-to-date. Commit f08b3b0e2e9ad87767d80ff03b013c686e08ba4b changed the default from 0 to 2; this patch finally documents it. Signed-off-by: Rene Scharfe <rene.scharfe@lsrfire.ath.cx> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-20GIT 1.5.3-rc6Libravatar Junio C Hamano1-2/+5
Hopefully last rc of 1.5.3 cycle, except a few documentation and message wording changes, and git-gui 0.8.2. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-19Fix misspelling of 'suppress' in docsLibravatar Dave Watson2-2/+2
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-19Document what the stage numbers in the :$n:path syntax mean.Libravatar Steven Grimm1-1/+4
The git-rev-parse manpage talks about the :$n:path notation (buried deep in a list of other syntax) but it just says $n is a "stage number" -- someone who is not familiar with the internals of git's merge implementation is never going to be able to figure out that "1", "2", and "3" means. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-19Don't allow combination of -g and --reverse as it doesn't workLibravatar Shawn O. Pearce2-0/+4
The --walk-reflogs logic and the --reverse logic are completely incompatible with one another. Attempting to use both at the same time leads to confusing results that sometimes violates the user's formatting options or ignores the user's request to see the reflog message and timestamp. Unfortunately the implementation of both of these features is glued onto the side of the revision walking machinary in such a way that they are probably not going to be easy to make them compatible with each other. Rather than offering the user confusing results we are better off bailing out with an error message until such a time as the implementations can be refactored to be compatible. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-19Add the word reflog to Documentation/config.txt:core.logAllRefUpdatesLibravatar Lukas Sandström1-1/+1
This makes it easier to find out how to enable the reflog for a bare repository by searching the documentation for "reflog". Signed-off-by: Lukas Sandström <lukass@etek.chalmers.se> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-19Add and document a global --no-pager option for git.Libravatar Matthieu Moy1-1/+5
To keep the change small, this is done by setting GIT_PAGER to "cat". Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Acked-by: Linus Torvalds <torvalds@linux-foundation.org> Acked-by: Brian Gernhardt <benji@silverinsanity.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-19Correct documentation of 'reflog show' to explain it shows HEADLibravatar Shawn O. Pearce1-1/+2
By default 'git reflog show' will show the reflog of 'HEAD' and not the reflog of the current branch. This is most likely due to the work done a while ago as part of the detached HEAD series to allow HEAD to have its own reflog independent of each branch's reflog. Since 'git reflog show' is really just an obscure alias for 'git log -g --abbrev-commit --pretty=oneline' it should behave the same way and its documentation should match. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-19Allow frontends to bidirectionally communicate with fast-importLibravatar Shawn O. Pearce1-0/+39
The existing checkpoint command is very useful to force fast-import to dump the branches out to disk so that standard Git tools can access them and the objects they refer to. However there was not a way to know when fast-import had finished executing the checkpoint and it was safe to read those refs. The progress command can be used to make fast-import output any message of the frontend's choosing to standard out. The frontend can scan for these messages using select() or poll() to monitor a pipe connected to the standard output of fast-import. Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-08-19Make trailing LF optional for all fast-import commandsLibravatar Shawn O. Pearce1-3/+8
For the same reasons as the prior change we want to allow frontends to omit the trailing LF that usually delimits commands. In some cases these just make the input stream more verbose looking than it needs to be, and its just simpler for the frontend developer to get started if our parser is slightly more lenient about where an LF is required and where it isn't. To make this optional LF feature work we now have to buffer up to one line of input in command_buf. This buffering can happen if we look at the current input command but don't recognize it at this point in the code. In such a case we need to "unget" the entire line, but we cannot depend upon the stdio library to let us do ungetc() for that many characters at once. Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-08-19Make trailing LF following fast-import `data` commands optionalLibravatar Shawn O. Pearce1-1/+9
A few fast-import frontend developers have found it odd that we require the LF following a `data` command, especially in the exact byte count format. Technically we don't need this LF to parse the stream properly, but having it here does make the stream more readable to humans. We can easily make the LF optional by peeking at the next byte available from the stream and pushing it back into the buffer if its not LF. Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-08-19Teach fast-import to ignore lines starting with '#'Libravatar Shawn O. Pearce1-0/+14
Several frontend developers have asked that some form of stream comments be permitted within a fast-import data stream. This way they can include information from their own frontend program about where specific data was taken from in the source system, or about a decision that their frontend may have made while creating the fast-import data stream. This change introduces comments in the Bourne-shell/Tcl/Perl style. Lines starting with '#' are ignored, up to and including the LF. Unlike the above mentioned three languages however we do not look for and ignore leading whitespace. This just simplifies the definition of the comment format and the code that parses them. To make comments work we had to stop using read_next_command() within cmd_data() and directly invoke read_line() during the inline variant of the function. This is necessary to retain any lines of the input data that might otherwise look like a comment to fast-import. Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-08-17Clarify commit-tree documentationLibravatar Mike Hommey1-9/+6
As per http://marc.info/?l=git&m=118737219702802&w=2 , clarify git-commit-tree documentation. Signed-off-by: Mike Hommey <mh@glandium.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-17Minor clarifications to git-filter-branch usage and docLibravatar Brian Gernhardt1-1/+1
- Remove "DESTBRANCH" from usage, as it rewrites the branches given. - Remove an = from an example usage, as the script doesn't understand it. Signed-off-by: Brian Gernhardt <benji@silverinsanity.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-17Fix small typo in git send-email man page.Libravatar Sean Estabrooks1-1/+1
Signed-off-by: Sean Estabrooks <seanlkml@sympatico.ca> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-16Clarify actual behavior of 'git add' and ignored filesLibravatar Brian Downing1-4/+6
Signed-off-by: Brian Downing <bdowning@lavos.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-16Documentation/git-rebase: fix an exampleLibravatar Junio C Hamano1-1/+1
The example miscounted the commit to rebase from. Noticed by Cliff Brake. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-15git-apply: apply submodule changesLibravatar Sven Verdoolaege1-0/+14
Apply "Subproject commit HEX" changes produced by git-diff. As usual in the current git, only the superproject itself is actually modified (possibly creating empty directories for new submodules). Any checked-out submodule is left untouched and is not required to be up-to-date. With clean-ups from Junio C Hamano. Signed-off-by: Sven Verdoolaege <skimo@kotnet.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-15Update documentation links for older releases.Libravatar Junio C Hamano1-1/+2
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-15Merge branch 'maint' to sync with 1.5.2.5Libravatar Junio C Hamano1-0/+30
* maint: GIT 1.5.2.5 git-add -u paths... now works from subdirectory Fix "git add -u" data corruption.
2007-08-15GIT 1.5.2.5Libravatar Junio C Hamano1-0/+30
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-15GIT 1.5.3-rc5Libravatar Junio C Hamano1-19/+62
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-14Add --log-size to git log to print message sizeLibravatar Marco Costalba1-0/+7
With this option git-log prints log message size just before the corresponding message. Porcelain tools could use this to speedup parsing of git-log output. Note that size refers to log message only. If also patch content is shown its size is not included. In case it is not possible to know the size upfront size value is set to zero. Signed-off-by: Marco Costalba <mcostalba@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-13git-add: Add support for --refresh option.Libravatar Alexandre Julliard1-1/+5
This allows to refresh only a subset of the project files, based on the specified pathspecs. Signed-off-by: Alexandre Julliard <julliard@winehq.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-10Documentation/Makefile: remove cmd-list.made before redirecting to it.Libravatar David Kastrup1-0/+1
If cmd-list.made has been created by a previous run as root, output redirection to it will fail. So remove it before regeneration. Signed-off-by: David Kastrup <dak@gnu.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-10Merge branch 'cr/tag'Libravatar Junio C Hamano3-6/+11
* cr/tag: Teach "git stripspace" the --strip-comments option Make verify-tag a builtin. builtin-tag.c: Fix two memory leaks and minor notation changes. launch_editor(): Heed GIT_EDITOR and core.editor settings Make git tag a builtin.
2007-08-10Add support for an info version of the user manualLibravatar David Kastrup2-1/+38
These patches use docbook2x in order to create an info version of the git user manual. No existing Makefile targets (including "all") are touched, so you need to explicitly say make info sudo make install-info to get git.info created and installed. If the info target directory does not already contain a "dir" file, no directory entry is created. This facilitates $(DESTDIR)-based installations. The same could be achieved with sudo make INSTALL_INFO=: install-info explicitly. perl is used for patching up sub-par file and directory information in the Texinfo file. It would be cleaner to place the respective info straight into user-manual.txt or the conversion configurations, but I find myself unable to find out how to do this with Asciidoc/Texinfo. Signed-off-by: David Kastrup <dak@gnu.org>
2007-08-10Merge branch 'jc/clone'Libravatar Junio C Hamano2-9/+25
* jc/clone: git-clone: aggressively optimize local clone behaviour. connect: accept file:// URL scheme
2007-08-10Revert "tweak manpage formatting"Libravatar Junio C Hamano1-13/+0
This reverts commit 524e5ffcf41a67ec113a9c3730ddc8fb8d3317f5. It is reported that this change breaks formatting with docbook 1.69.
2007-08-10tweak manpage formattingLibravatar Junio C Hamano1-0/+13
This attempts to force fixed-font in manpages for literal blocks. I have tested this with docbook 1.71 and it seems to work as expected. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-10Fix an illustration in git-rev-parse.txtLibravatar Junio C Hamano1-1/+1
This hides the backslash at the end of line from AsciiDoc toolchain by introducing a trailing whitespace on one line in an illustration in git-rev-parse.txt. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-10Fix formatting of git-blame documentation.Libravatar Junio C Hamano1-10/+10
blame-options.txt did not format multi-paragraph option description correctly. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-08Reorder the list of commands in the manual.Libravatar Junio C Hamano1-7/+9
The basic idea was proposed by Steve Hoelzer; in order to make the list easier to search, we keep the command list in the script that generates it with "sort -d". Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-07git-stash documentation: add missing backtickLibravatar Steve Hoelzer1-1/+1
Signed-off-by: Steve Hoelzer <shoelzer@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-07git-stash documentation: stash numbering starts at zero, not oneLibravatar Steve Hoelzer1-3/+3
Signed-off-by: Steve Hoelzer <shoelzer@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-06Add a note about the index being updated by git-status in some casesLibravatar Steven Grimm1-0/+7
Signed-off-by: Steven Grimm <koreth@midwinter.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-06Documentation/git-commit.txt: correct bad list formatting.Libravatar David Kastrup1-0/+1
Signed-off-by: David Kastrup <dak@gnu.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-06Fix "make GZ=1 quick-install-doc"Libravatar Junio C Hamano1-5/+3
The basic idea is from Mark Levedahl. I do not use GZ=1 nor quick-install-doc myself (there obviously is a chicken-and-egg issue with quick-install-doc for me). Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-06Documentation/git-svn: how to clone a git-svn-created repositoryLibravatar Adam Roben1-0/+20
These instructions tell you how to create a clone of a repository created with git-svn, that can in turn be used with git-svn. Signed-off-by: Adam Roben <aroben@apple.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-05documentation: use the word "index" in the git-commit man pageLibravatar J. Bruce Fields1-14/+14
As with git-add, I think previous updates to the git-commit man page did indeed help make it more user-friendly. But I think the banishment of the word "index" from the description goes too far; reinstate its use, to simplify some of the language slightly and smooth the transition to other documentation. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-05Merge branch 'master' of git://linux-nfs.org/~bfields/gitLibravatar Junio C Hamano2-35/+72
* 'master' of git://linux-nfs.org/~bfields/git: documentation: use the word "index" in the git-add manual page user-manual: mention git-gui user-manual: mention git stash user-manual: update for new default --track behavior
2007-08-05Merge branch 'maint'Libravatar J. Bruce Fields1-19/+22
2007-08-05documentation: use the word "index" in the git-add manual pageLibravatar J. Bruce Fields1-19/+22
It was a neat trick to show that you could introduce the git-add manual page without using the word "index", and it was certainly an improvement over the previous man page (which started out "A simple wrapper for git-update-index to add files to the index..."). But it's possible to use the standard terminology without sacrificing user-friendliness. So, rewrite to use the word "index" when appropriate. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-08-05user-manual: mention git-guiLibravatar J. Bruce Fields1-2/+9
The git gui project seems to be still in early stages, but at a point where it's worth mentioning as an alternative way of creating commits. One feature of interest is the ability to manipulate individual diff hunks. However, people have found that feature not to be easily discoverable from the user-interface. Pending some ui improvements, a parenthetical hint here may help. (Thanks to Steffen Prohask and Junio Hamano for suggesting the language.) Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-08-05user-manual: mention git stashLibravatar Junio C Hamano1-0/+32
Mention the git-stash command as a way to temporarily set aside work in progress. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-08-05user-manual: update for new default --track behaviorLibravatar J. Bruce Fields1-14/+9
Update documentation to reflect the --track default. That change seems to have happened in the 1.5.3 -rc's, so bump the "for version x.y.z or newer" warning as well. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-08-05Fix install-doc-quick targetLibravatar Junio C Hamano1-1/+3
The script starts in a subdirectory of the source directory to muck with a branch whose structure does not have anything to do with the actual work tree. Go up to the top to make it clear that we operate on the whole tree. It also exported GIT_DIR without any good reason. Remove it. Signed-off-by: Junio C Hamano <gitster@pobox.com>