aboutsummaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAge
* Documentation: revise top of git man pageJ. Bruce Fields2006-04-02
| | | | | | | | | | | | | | | | | | | | I'm afraid I'll be accused of trying to suck all the jokes and the personality out of the git documentation. I'm not! Really! That said, "man git" is one of the first things a new user is likely try, and it seems a little cruel to start off with a somewhat obscure joke about the architecture of git. So instead I'm trying for a relatively straightforward description of what git does, and what features distinguish it from other systems, together with immediate links to introductory documentation. I also did some minor reorganization in an attempt to clarify the classification of commands. And revised a bit for conciseness (as is obvious from the diffstat--hopefully I didn't cut anything important). Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Merge branch 'master' into nextJunio C Hamano2006-03-26
|\ | | | | | | | | | | | | * master: Optionally do not list empty directories in git-ls-files --others Document git-rebase behavior on conflicts. Fix error handling for nonexistent names
| * Optionally do not list empty directories in git-ls-files --othersPetr Baudis2006-03-26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Without the --directory flag, git-ls-files wouldn't ever list directories, producing no output for empty directories, which is good since they cannot be added and they bear no content, even untracked one (if Git ever starts tracking directories on their own, this should obviously change since the content notion will change). With the --directory flag however, git-ls-files would list even empty directories. This may be good in some situations but sometimes you want to prevent that. This patch adds a --no-empty-directory option which makes git-ls-files omit empty directories. Signed-off-by: Petr Baudis <pasky@suse.cz>
| * Document git-rebase behavior on conflicts.J. Bruce Fields2006-03-26
| |
* | Merge branch 'rs/tar-tree' into nextJunio C Hamano2006-03-25
|\ \ | |/ | | | | | | | | | | | | | | | | | | | | | | | | | | * rs/tar-tree: tar-tree: Use the prefix field of a tar header tar-tree: Remove obsolete code tar-tree: Use write_entry() to write the archive contents tar-tree: Introduce write_entry() tar-tree: Use SHA1 of root tree for the basedir git-apply: safety fixes Removed bogus "<snap>" identifier. Clarify and expand some hook documentation. commit-tree: check return value from write_sha1_file() send-email: Identify author at the top when sending e-mail Format tweaks for asciidoc.
| * Removed bogus "<snap>" identifier.Jon Loeliger2006-03-24
| | | | | | | | | | Signed-off-by: Jon Loeliger <jdl@jdl.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * Clarify and expand some hook documentation.Jon Loeliger2006-03-24
| | | | | | | | | | | | | | | | Clarify update and post-update hooks. Made a few references to the hooks documentation. Signed-off-by: Jon Loeliger <jdl@jdl.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * Format tweaks for asciidoc.Francis Daly2006-03-22
| | | | | | | | | | | | | | | | Some documentation "options" were followed by independent preformatted paragraphs. Now they are associated plain text paragraphs. The difference is clear in the generated html. Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Merge branch 'jc/name' into nextJunio C Hamano2006-03-21
|\ \ | |/ | | | | | | | | | | | | | | | | | | * jc/name: core.warnambiguousrefs: warns when "name" is used and both "name" branch and tag exists. contrib/git-svn: allow rebuild to work on non-linear remote heads http-push: don't assume char is signed http-push: add support for deleting remote branches Be verbose when !initial commit Fix multi-paragraph list items in OPTIONS section http-fetch: nicer warning for a server with unreliable 404 status
| * Fix multi-paragraph list items in OPTIONS sectionFrancis Daly2006-03-20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch makes the html docs right, makes the asciidoc docs a bit odd but consistent with what is there already, and makes the manpages look OK using docbook-xsl 1.68, but miss a paragraph separator when using 1.69. For the manpages, current is like -A <author_file> Read a file with lines on the form username = User's Full Name <email@addr.es> and use "User's Full Name <email@addr.es>" as the GIT With this patch, docbook-xsl v1.68 looks like -A <author_file> Read a file with lines on the form username = User's Full Name <email@addr.es> and use "User's Full Name <email@addr.es>" as the GIT author and while docbook-xsl v1.69 becomes -A <author_file> Read a file with lines on the form username = User's Full Name <email@addr.es> and use "User's Full Name <email@addr.es>" as the GIT author and The extra indentation is to keep the v1.69 manpage looking sane.
* | Merge branch 'master' into nextJunio C Hamano2006-03-17
|\ \ | |/ | | | | | | | | | | | | | | | | | | | | * master: 3% tighter packs for free Rewrite synopsis to clarify the two primary uses of git-checkout. Fix minor typo. Reference git-commit-tree for env vars. Clarify git-rebase example commands. Document the default source of template files. Call out the two different uses of git-branch and fix a typo. Add git-show reference
| * Rewrite synopsis to clarify the two primary uses of git-checkout.Jon Loeliger2006-03-17
| | | | | | | | | | | | | | Fix a few typo/grammar problems. Signed-off-by: Jon Loeliger <jdl@jdl.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * Fix minor typo.Jon Loeliger2006-03-17
| | | | | | | | | | Signed-off-by: Jon Loeliger <jdl@jdl.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * Reference git-commit-tree for env vars.Jon Loeliger2006-03-17
| | | | | | | | | | Signed-off-by: Jon Loeliger <jdl@jdl.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * Clarify git-rebase example commands.Jon Loeliger2006-03-17
| | | | | | | | | | Signed-off-by: Jon Loeliger <jdl@jdl.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * Document the default source of template files.Jon Loeliger2006-03-17
| | | | | | | | | | | | | | Also explain a bit more about how the template option works. Signed-off-by: Jon Loeliger <jdl@jdl.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * Call out the two different uses of git-branch and fix a typo.Jon Loeliger2006-03-17
| | | | | | | | | | Signed-off-by: Jon Loeliger <jdl@jdl.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * Add git-show referenceJon Loeliger2006-03-17
| | | | | | | | | | Signed-off-by: Jon Loeliger <jdl@jdl.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | ls-files: add --abbrev[=<n>] optionEric Wong2006-03-17
| | | | | | | | | | Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | ls-tree: add --abbrev[=<n>] optionEric Wong2006-03-17
|/ | | | | Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Merge branch 'jc/fsck'Junio C Hamano2006-03-13
|\ | | | | | | | | * jc/fsck: fsck-objects: Remove --standalone
| * fsck-objects: Remove --standaloneJunio C Hamano2006-03-09
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The fsck-objects command (back then it was called fsck-cache) used to complain if objects referred to by files in .git/refs/ or objects stored in files under .git/objects/??/ were not found as stand-alone SHA1 files (i.e. found in alternate object pools or packed archives stored under .git/objects/pack). Back then, packs and alternates were new curiosity and having everything as loose objects were the norm. When we adjusted the behaviour of fsck-cache to consider objects found in packs are OK, we introduced the --standalone flag as a backward compatibility measure. It still correctly checks if your repository is complete and consists only of loose objects, so in that sense it is doing the "right" thing, but checking that is pointless these days. This commit removes --standalone flag. See also: 23676d407c63a6f67f8ce3ff192199bda03e6a03 8a498a05c3c6b2f53db669b24f36257ab213eb4c Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Describe how to add extra mail header lines in mail generated by ↵Mike McCormack2006-03-09
| | | | | | | | git-format-patch.
* | Document the --attach flag.Mike McCormack2006-03-09
|/
* Nicer output from 'git'Fredrik Kuivinen2006-03-09
| | | | | | | [jc: with suggestions by Jan-Benedict Glaw] Signed-off-by: Fredrik Kuivinen <freku045@student.liu.se> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Remove trailing dot after short descriptionFredrik Kuivinen2006-03-09
| | | | | Signed-off-by: Fredrik Kuivinen <freku045@student.liu.se> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Fix some inconsistencies in the docsFredrik Kuivinen2006-03-09
| | | | | Signed-off-by: Fredrik Kuivinen <freku045@student.liu.se> Signed-off-by: Junio C Hamano <junkio@cox.net>
* cvsimport: Remove master-updating codeMatthias Urlichs2006-03-07
| | | | | | | | The code which tried to update the master branch was somewhat broken. => People should do that manually, with "git merge". Signed-off-by: Matthias Urlichs <smurf@smurf.noris.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Merge branch 'sp/checkout'Junio C Hamano2006-03-06
|\ | | | | | | | | * sp/checkout: Add --temp and --stage=all options to checkout-index.
| * Add --temp and --stage=all options to checkout-index.Shawn Pearce2006-03-05
| | | | | | | | | | | | | | | | | | | | | | | | Sometimes it is convient for a Porcelain to be able to checkout all unmerged files in all stages so that an external merge tool can be executed by the Porcelain or the end-user. Using git-unpack-file on each stage individually incurs a rather high penalty due to the need to fork for each file version obtained. git-checkout-index -a --stage=all will now do the same thing, but faster. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Tweak asciidoc output to work with broken docbook-xslFrancis Daly2006-03-05
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | docbook-xsl v1.68 incorrectly converts "<screen>" from docbook to manpage by not rendering it verbatim. v1.69 handles it correctly, but not many current popular distributions ship with it. asciidoc by default converts "listingblock" to "<screen>". This change causes asciidoc in git to convert "listingblock" to "<literallayout>", which both old and new docbook-xsl handle correctly. The difference can be seen in any manpage which includes a multi-line example, such as git-branch. [jc: the original patch was an disaster for html backends, so I made it apply only to docbook backends. ] Signed-off-by: Junio C Hamano <junkio@cox.net>
* | git/Documentation: fix SYNOPSIS style bugsDmitry V. Levin2006-03-05
| | | | | | | | | | | | | | This trivial patch fixes SYNOPSIS style bugs. Signed-off-by: Dmitry V. Levin <ldv@altlinux.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | documentation: add 'see also' sections to git-rm and git-addJeff Muizelaar2006-03-05
| | | | | | | | | | | | | | Pair up git-add and git-rm by adding a 'see also' section that references the opposite command to each of their documentation files. Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Documentation/Makefile: Some `git-*.txt' files aren't manpages.Mark Wooding2006-03-05
| | | | | | | | | | | | | | | | | | In particular, git-tools.txt isn't a manpage, and my Asciidoc gets upset by it. The simplest fix is to Remove articles from the list of manpages the Makefile. Signed-off-by: Mark Wooding <mdw@distorted.org.uk> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | cvsserver: updated documentationMartin Langhoff2006-03-05
|/ | | | | | | ... and stripped trailing whitespace to appease the Gods... Signed-off-by: Martin Langhoff <martin@catalyst.net.nz> Signed-off-by: Junio C Hamano <junkio@cox.net>
* cosmetics: change from 'See-Also' to 'See Also'Jeff Muizelaar2006-03-05
| | | | | | | Changes the documentation that uses 'See-Also' to the more common 'See Also' form. Signed-off-by: Junio C Hamano <junkio@cox.net>
* Merge part of 'sp/checkout'Junio C Hamano2006-03-04
|\
| * Teach git-checkout-index to read filenames from stdin.Shawn Pearce2006-03-01
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since git-checkout-index is often used from scripts which may have a stream of filenames they wish to checkout it is more convenient to use --stdin than xargs. On platforms where fork performance is currently sub-optimal and the length of a command line is limited (*cough* Cygwin *cough*) running a single git-checkout-index process for a large number of files beats spawning it multiple times from xargs. File names are still accepted on the command line if --stdin is not supplied. Nothing is performed if no files are supplied on the command line or by stdin. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | AsciiDoc fix for tutorialFrancis Daly2006-03-04
| | | | | | | | | | | | RE \^.+\^ becomes <sup>. Not wanted here Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Merge branch 'lt/rev-list'Junio C Hamano2006-03-04
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * lt/rev-list: setup_revisions(): handle -n<n> and -<n> internally. git-log (internal): more options. git-log (internal): add approxidate. Rip out merge-order and make "git log <paths>..." work again. Tie it all together: "git log" Introduce trivial new pager.c helper infrastructure git-rev-list libification: rev-list walking Splitting rev-list into revisions lib, end of beginning. rev-list split: minimum fixup. First cut at libifying revlist generation
| * | Rip out merge-order and make "git log <paths>..." work again.Linus Torvalds2006-03-01
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Well, assuming breaking --merge-order is fine, here's a patch (on top of the other ones) that makes git log <filename> actually work, as far as I can tell. I didn't add the logic for --before/--after flags, but that should be pretty trivial, and is independent of this anyway. Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Add a Documentation/git-tools.txtMarco Costalba2006-03-03
| | | | | | | | | | | | | | | | | | | | | | | | A brief survey of useful git tools, including third-party and external projects. Signed-off-by: Marco Costalba <mcostalba@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | manpages: insert two missing [verse] markers for multi-line SYNOPSISJonas Fonseca2006-03-02
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Found with: for i in *.txt; do grep -A 2 "SYNOPSIS" "$i" | grep -q "^\[verse\]$" && continue multiline=$(grep -A 3 "SYNOPSIS" "$i" | tail -n 1) test -n "$multiline" && echo "$i: $multiline" done Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Documentation: rev-list --objects-edgeJunio C Hamano2006-03-02
| | | | | | | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Documentation: read-tree --aggressiveJunio C Hamano2006-03-02
| | | | | | | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | war on whitespaces: documentation.Junio C Hamano2006-03-02
| | | | | | | | | | | | | | | | | | | | | We were missing the --whitespace option in the usage string for git-apply and git-am, so this commit adds them. Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Merge branch 'kh/svnimport'Junio C Hamano2006-03-01
|\ \ \ | |_|/ |/| | | | | | | | * kh/svnimport: Save username -> Full Name <email@addr.es> map file
| * | Save username -> Full Name <email@addr.es> map fileKarl Hasselström2006-02-27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When the user specifies a username -> Full Name <email@addr.es> map file with the -A option, save a copy of that file as $git_dir/svn-authors. When running git-svnimport with an existing GIT directory, use $git_dir/svn-authors (if it exists) unless a file was explicitly specified with -A. Signed-off-by: Karl Hasselström <kha@treskal.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | cvsserver: add notes on how to get a checkout under EclipseMartin Langhoff2006-03-01
|/ /
* | Let git-svnimport's author file use same syntax as git-cvsimport'sKarl Hasselström2006-02-27
| | | | | | | | | | | | | | | | | | | | | | | | | | git-cvsimport uses a username => Full Name <email@addr.es> mapping file with this syntax: kha=Karl Hasselström <kha@treskal.com> Since there is no reason to use another format for git-svnimport, use the same format. Signed-off-by: Karl Hasselström <kha@treskal.com> Signed-off-by: Junio C Hamano <junkio@cox.net>