aboutsummaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAge
* Merge branch 'master' of git://linux-nfs.org/~bfields/gitJunio C Hamano2007-08-26
|\ | | | | | | | | | | | | | | | | | | | | * 'master' of git://linux-nfs.org/~bfields/git: Documentation/user-manual.txt: fix a few omissions of gitlink commands. user-manual: fix incorrect header level user-manual: use pithier example commit user-manual: introduce the word "commit" earlier user-manual: minor editing for conciseness user-manual: edit "ignoring files" for conciseness Documentation/user-manual.txt: fix a few omissions of gitlink commands.
| * Merge branch 'maint'J. Bruce Fields2007-08-26
| |\ | | | | | | | | | | | | | | | Conflicts: Documentation/user-manual.txt
| | * Documentation/user-manual.txt: fix a few omissions of gitlink commands.David Kastrup2007-08-26
| | | | | | | | | | | | Signed-off-by: David Kastrup <dak@gnu.org>
| | * user-manual: fix incorrect header levelJ. Bruce Fields2007-08-26
| | | | | | | | | | | | | | | | | | This section is a subsection of the "Examples" section. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| | * user-manual: use pithier example commitJ. Bruce Fields2007-08-26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Actually, we should have a competition for the favorite example commit. Criteria: - length: one-line changes with one-line comments preferred, and no long lines - significance/memorability - comic value Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| | * user-manual: introduce the word "commit" earlierJ. Bruce Fields2007-08-26
| | | | | | | | | | | | | | | | | | Use the word "commit" as a synonym for "version" from the start. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| | * user-manual: minor editing for concisenessJ. Bruce Fields2007-08-26
| | | | | | | | | | | | | | | | | | Just cutting out a few unnecessary words. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| | * user-manual: edit "ignoring files" for concisenessJ. Bruce Fields2007-08-26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The immediate motivation for writing this section was to explain the various places ignore patterns could be used. However, I still think .gitignore is the case most people will want to learn about first. It also makes it a bit more concrete to introduce ignore patterns in the context of .gitignore first. And the existance of gitignore(5) relieves the pressure to explain it all here. So, stick to the .gitignore example, with only a brief mention of the others, explain the syntax only by example, and leave the rest to gitignore(5). Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Cc: Johan Herland <johan@herland.net>
| * | Documentation/user-manual.txt: fix a few omissions of gitlink commands.David Kastrup2007-08-26
| | | | | | | | | | | | Signed-off-by: David Kastrup <dak@gnu.org>
* | | Make usage documentation for git-add consistent.Brian Hetro2007-08-25
|/ / | | | | | | | | | | | | | | | | | | The usage string for the executable was missing --refresh. In addition, the documentation referred to "file", but the usage string referred to "filepattern". Updated the documentation to "filepattern", as git-add does handle patterns. Signed-off-by: Brian Hetro <whee@smaertness.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: Correct various misspellings and typos.Brian Hetro2007-08-24
| | | | | | | | | | | | | | Fix minor typos throughout the documentation. Signed-off-by: Brian Hetro <whee@smaertness.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: For consistency, use CVS instead of cvs.Brian Hetro2007-08-24
| | | | | | | | | | | | | | When not referring to the cvs command, CVS makes more sense. Signed-off-by: Brian Hetro <whee@smaertness.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | git-svn init/clone --stdlayout option to default-init trunk/tags/branchesmartin f. krafft2007-08-23
| | | | | | | | | | | | | | | | | | | | | | | | The --stdlayout option to git-svn init/clone initialises the default Subversion values of trunk,tags,branches: -T trunk -b branches -t tags. If any of the -T/-t/-b options are given in addition, they are given preference. [ew: fixed whitespace and added "-s" shortcut] Signed-off-by: martin f. krafft <madduck@madduck.net> Signed-off-by: Eric Wong <normalperson@yhbt.net>
* | git-svn: update documentation with CAVEATS sectionEric Wong2007-08-22
| | | | | | | | | | Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Document -u option in git-svnimport man pageStefan Sperling2007-08-22
| | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Fix breakage in git-rev-list.txtQuy Tonthat2007-08-22
| | | | | | | | | | | | | | Also fix some innocent missing of quotes. Signed-off-by: Quy Tonthat <qtonthat@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: update tar.umask defaultRené Scharfe2007-08-22
| | | | | | | | | | | | | | | | | | 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>
* | GIT 1.5.3-rc6v1.5.3-rc6Junio C Hamano2007-08-20
| | | | | | | | | | | | | | 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>
* | Fix misspelling of 'suppress' in docsDave Watson2007-08-19
| | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Document what the stage numbers in the :$n:path syntax mean.Steven Grimm2007-08-19
| | | | | | | | | | | | | | | | | | 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>
* | Don't allow combination of -g and --reverse as it doesn't workShawn O. Pearce2007-08-19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Add the word reflog to Documentation/config.txt:core.logAllRefUpdatesLukas Sandström2007-08-19
| | | | | | | | | | | | | | | | | | 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>
* | Add and document a global --no-pager option for git.Matthieu Moy2007-08-19
| | | | | | | | | | | | | | | | | | 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>
* | Correct documentation of 'reflog show' to explain it shows HEADShawn O. Pearce2007-08-19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Allow frontends to bidirectionally communicate with fast-importShawn O. Pearce2007-08-19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Make trailing LF optional for all fast-import commandsShawn O. Pearce2007-08-19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Make trailing LF following fast-import `data` commands optionalShawn O. Pearce2007-08-19
| | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Teach fast-import to ignore lines starting with '#'Shawn O. Pearce2007-08-19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Clarify commit-tree documentationMike Hommey2007-08-17
| | | | | | | | | | | | | | | | 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>
* | Minor clarifications to git-filter-branch usage and docBrian Gernhardt2007-08-17
| | | | | | | | | | | | | | | | | | - 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>
* | Fix small typo in git send-email man page.Sean Estabrooks2007-08-17
| | | | | | | | | | Signed-off-by: Sean Estabrooks <seanlkml@sympatico.ca> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Clarify actual behavior of 'git add' and ignored filesBrian Downing2007-08-16
| | | | | | | | | | Signed-off-by: Brian Downing <bdowning@lavos.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation/git-rebase: fix an exampleJunio C Hamano2007-08-16
| | | | | | | | | | | | | | The example miscounted the commit to rebase from. Noticed by Cliff Brake. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | git-apply: apply submodule changesSven Verdoolaege2007-08-15
| | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Update documentation links for older releases.Junio C Hamano2007-08-15
| | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Merge branch 'maint' to sync with 1.5.2.5Junio C Hamano2007-08-15
|\ \ | |/ | | | | | | | | | | * maint: GIT 1.5.2.5 git-add -u paths... now works from subdirectory Fix "git add -u" data corruption.
| * GIT 1.5.2.5v1.5.2.5Junio C Hamano2007-08-15
| | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | GIT 1.5.3-rc5v1.5.3-rc5Junio C Hamano2007-08-15
| | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Add --log-size to git log to print message sizeMarco Costalba2007-08-14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | git-add: Add support for --refresh option.Alexandre Julliard2007-08-13
| | | | | | | | | | | | | | | | 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>
* | Documentation/Makefile: remove cmd-list.made before redirecting to it.David Kastrup2007-08-10
| | | | | | | | | | | | | | | | 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>
* | Merge branch 'cr/tag'Junio C Hamano2007-08-10
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | * 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.
| * | Teach "git stripspace" the --strip-comments optionJohannes Schindelin2007-07-26
| | | | | | | | | | | | | | | | | | | | | | | | With --strip-comments (or short -s), git stripspace now removes lines beginning with a '#', too. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * | Make verify-tag a builtin.Carlos Rica2007-07-26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This replaces "git-verify-tag.sh" with "builtin-verify-tag.c". Testing relies on the "git tag -v" tests calling this command. A temporary file is needed when calling to gpg, because git is already creating detached signatures (gpg option -b) to sign tags (instead of leaving gpg to add the signature to the file by itself), and those signatures need to be supplied in a separate file to be verified by gpg. The program uses git_mkstemp to create that temporary file needed by gpg, instead of the previously used "$GIT_DIR/.tmp-vtag", in order to allow the command to be used in read-only repositories, and also prevent other instances of git to read or remove the same file. Signal SIGPIPE is ignored because the program sometimes was terminated because that signal when writing the input for gpg. The command now can receive many tag names to be verified. Documentation is also updated here to reflect this new behaviour. Signed-off-by: Carlos Rica <jasampler@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * | Make git tag a builtin.Carlos Rica2007-07-20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This replaces the script "git-tag.sh" with "builtin-tag.c". The existing test suite for "git tag" guarantees the compatibility with the features provided by the script version. There are some minor changes in the behaviour of "git tag" here: "git tag -v" now can get more than one tag to verify, like "git tag -d" does, "git tag" with no arguments prints all tags, more like "git branch" does, and "git tag -n" also prints all tags with annotations (without needing -l). Tests and documentation were also updated to reflect these changes. The program is currently calling the script "git verify-tag" for verify. This can be changed porting it to C and calling its functions directly from builtin-tag.c. Signed-off-by: Carlos Rica <jasampler@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | Add support for an info version of the user manualDavid Kastrup2007-08-10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Merge branch 'jc/clone'Junio C Hamano2007-08-10
|\ \ \ | | | | | | | | | | | | | | | | | | | | * jc/clone: git-clone: aggressively optimize local clone behaviour. connect: accept file:// URL scheme
| * | | git-clone: aggressively optimize local clone behaviour.Junio C Hamano2007-08-01
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This changes the behaviour of cloning from a repository on the local machine, by defaulting to "-l" (use hardlinks to share files under .git/objects) and making "-l" a no-op. A new option, --no-hardlinks, is also added to cause file-level copy of files under .git/objects while still avoiding the normal "pack to pipe, then receive and index pack" network transfer overhead. The old behaviour of local cloning without -l nor -s is availble by specifying the source repository with the newly introduced file:///path/to/repo.git/ syntax (i.e. "same as network" cloning). * With --no-hardlinks (i.e. have all .git/objects/ copied via cpio) would not catch the source repository corruption, and also risks corrupted recipient repository if an alpha-particle hits memory cell while indexing and resolving deltas. As long as the recipient is created uncorrupted, you have a good back-up. * same-as-network is expensive, but it would catch the breakage of the source repository. It still risks corrupted recipient repository due to hardware failure. As long as the recipient is created uncorrupted, you have a good back-up. * The new default on the same filesystem, as long as the source repository is healthy, it is very likely that the recipient would be, too. Also it is very cheap. You do not get any back-up benefit, though. None of the method is resilient against the source repository corruption, so let's discount that from the comparison. Then the difference with and without --no-hardlinks matters primarily if you value the back-up benefit or not. If you want to use the cloned repository as a back-up, then it is cheaper to do a clone with --no-hardlinks and two git-fsck (source before clone, recipient after clone) than same-as-network clone, especially as you are likely to do a git-fsck on the recipient if you are so paranoid anyway. Which leads me to believe that being able to use file:/// is probably a good idea, if only for testability, but probably of little practical value. We default to hardlinked clone for everyday use, and paranoids can use --no-hardlinks as a way to make a back-up. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | Revert "tweak manpage formatting"Junio C Hamano2007-08-10
| | | | | | | | | | | | | | | | | | | | | | | | This reverts commit 524e5ffcf41a67ec113a9c3730ddc8fb8d3317f5. It is reported that this change breaks formatting with docbook 1.69.
* | | | tweak manpage formattingJunio C Hamano2007-08-10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>