summaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* Documentation/shortlog: scripted users should not rely on implicit HEADJonathan Nieder2010-05-041-1/+6
| | | | | | | | | | | When passed no revision arguments, ‘git shortlog’ reads a log from stdin if and only if stdin is not a tty. So scripts that need to function identically when standard input is a terminal (as when run interactively) and not (as when run through a cron job) should either supply a log themselves or specify the desired revisions explicitly. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation improvements for the description of short format.Eric Raymond2010-04-231-9/+34
| | | | | | | | | | Incorporates the detailed explanation from Jeff King in <20100410040959.GA11977@coredump.intra.peff.net> and fixes the bug noted by Junio C Hamano in <7vmxxc1i8g.fsf@alter.siamese.dyndns.org>. Signed-off-by: Eric S. Raymond <esr@thyrsus.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Git 1.7.0.6v1.7.0.6Junio C Hamano2010-04-222-1/+15
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Merge branch 'wp/doc-filter-direction' into maintJunio C Hamano2010-04-221-4/+4
|\ | | | | | | | | * wp/doc-filter-direction: documentation: clarify direction of core.autocrlf
| * documentation: clarify direction of core.autocrlfWill Palmer2010-04-171-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The description for core.autocrlf refers to reads from / writes to "the filesystem", the only use of this rather ambiguous term, which technically could be referring to the git object database. (All other mentions are part of phrases such as "..filesystems (like NFS).."). Other sections, including the section on core.safecrlf, use the term "work tree" for the same purpose as the term "the filesystem" is used in the core.autocrlf section, so that seems like a good alternative, which makes it clearer what direction the addition/removal of CR characters occurs in. Signed-off-by: Will Palmer <wmpalmer@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation/Makefile: fix interrupted builds of user-manual.xmlJonathan Nieder2010-04-211-2/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Unlike gcc, asciidoc does not atomically write its output file or delete it when interrupted. If it is interrupted in the middle of writing an XML file, the result will be truncated input for xsltproc. XSLTPROC user-manual.html user-manual.xml:998: parser error : Premature end of data in t Take care of this case by writing to a temporary and renaming it when finished. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: Describe other situations where -z affects git diffCharles Bailey2010-04-181-2/+2
| | | | | | | | | | | | | | -z also alters the behaviour of --name-only and --name-status. Signed-off-by: Charles Bailey <charles@hashpling.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Document new "already-merged" rule for branch -dJonathan Nieder2010-04-151-1/+3
|/ | | | | | | | | | | | | | | | | | v1.7.0-rc0~18^2 (branch -d: base the "already-merged" safety on the branch it merges with, 2009-12-29) taught ‘git branch’ a new heuristic for when it is safe to delete a branch without forcing the issue. It is safe to delete a branch "topic" without second thought if: - the branch "topic" is set up to pull from a (remote-tracking, usually) branch and is fully merged in that "upstream" branch, or - there is no branch.topic.merge configuration and branch "topic" is fully merged in the current HEAD. Update the man page to acknowledge the new rules. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation/config.txt: default gc.aggressiveWindow is 250, not 10Jay Soffian2010-04-131-1/+1
| | | | | | | | The default for gc.aggressiveWindow has been 250 since 1c192f3 (gc --aggressive: make it really aggressive, 2007-12-06). Signed-off-by: Jay Soffian <jaysoffian@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Docs: Add -X option to git-merge's synopsis.Marc Branchaud2010-04-122-6/+7
| | | | | | | | Also move -X's description next to -s's in merge-options.txt. This makes it easier to learn how to specify merge strategy options. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Git 1.7.0.5v1.7.0.5Junio C Hamano2010-04-112-1/+28
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* blame documentation: -M/-C notice copied lines as well as moved onesJunio C Hamano2010-04-111-9/+10
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Merge branch 'rr/imap-send-unconfuse-from-line' into maintJunio C Hamano2010-04-091-7/+3
|\ | | | | | | | | * rr/imap-send-unconfuse-from-line: imap-send: Remove limitation on message body
| * imap-send: Remove limitation on message bodyRamkumar Ramachandra2010-03-241-7/+3
| | | | | | | | | | | | | | | | | | | | There is a documented limitation on the body of any email not being able to contain lines starting with "From ". This patch removes that limitation by improving the parser to search for "From", "Date", and "Subject" fields in the email before considering it to be an email. Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | fetch/push: fix usage stringsTay Ray Chuan2010-04-092-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - use "<options>" instead of just "options". - use "[<repository> [<refspec>...]]" to indicate that <repository> and <refspec> are optional, and that <refspec> cannot be specified without specifying <repository>. Note that when called without specifying <repository> (eg. "git fetch -f"), it is accurate to say that the "git fetch [<options>] [<repository> ...]" case takes precedence over "git fetch [<options>] <group>". Signed-off-by: Tay Ray Chuan <rctay89@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | docs: clarify "branch -l"Jeff King2010-04-081-0/+2
| | | | | | | | | | | | | | | | This option is mostly useless these days because we turn on reflogs by default in non-bare repos. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | pack-protocol.txt: fix pkt-line lengthsTay Ray Chuan2010-04-041-4/+4
| | | | | | | | | | | | | | | | Previously, the lengths were 4-bytes short. Fix it such that the lengths reflect the total length of the pkt-line, as per spec. Signed-off-by: Tay Ray Chuan <rctay89@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | pack-protocol.txt: fix spellingTay Ray Chuan2010-04-041-1/+1
| | | | | | | | | | | | | | s/paramater/parameter/. Signed-off-by: Tay Ray Chuan <rctay89@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Git 1.7.0.4v1.7.0.4Junio C Hamano2010-03-312-3/+12
| | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: show-ref <pattern>s are optionalHolger Weiß2010-03-311-1/+1
| | | | | | | | | | | | | | | | Specifying one or more <pattern> parameters is optional when calling show-ref, so mark them as such using brackets in the manual. Signed-off-by: Holger Weiß <holger@zedat.fu-berlin.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: Clarify support for smart HTTP backendGreg Bacon2010-03-301-1/+1
| | | | | | | | | | | | | | | | | | In the description of http.getanyfile, replace the vague "older Git clients" with the earliest release whose client is able to use the upload pack service. Signed-off-by: Greg Bacon <gbacon@dbresearch.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Prepare for 1.7.0.4Junio C Hamano2010-03-281-0/+19
| | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: explain the meaning of "-g" in git-describe outputMarkus Heidelberg2010-03-241-0/+3
|/ | | | | Signed-off-by: Markus Heidelberg <markus.heidelberg@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Git 1.7.0.3v1.7.0.3Junio C Hamano2010-03-212-9/+4
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Merge branch 'maint-1.6.6' into maintJunio C Hamano2010-03-214-14/+6
|\ | | | | | | | | | | | | | | * maint-1.6.6: Documentation/git-clone: Transform description list into item list Documentation/urls: Remove spurious example markers Documentation/gitdiffcore: Remove misleading date in heading Documentation/git-reflog: Fix formatting of command lists
| * Documentation/git-clone: Transform description list into item listMichael J Gruber2010-03-211-5/+5
| | | | | | | | | | | | | | | | | | | | | | so that the list of examples is formatted in the same way as for git-fetch, and, more importantly, the different identation for the code blocks in the examples (compared to the immediately preceding code blocks from url.txt) doesn't look like misformatted, but is clarified by the items' bullets. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * Documentation/urls: Remove spurious example markersMichael J Gruber2010-03-211-6/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In urls.txt (which is included from git-{clone,fetch,push}.txt) several item lists are surrounded by example block markers. This is problematic for two reasons: - None of these lists are example lists, so they should not be marked as such semantically. - The html output looks weird (bulleted list with left sidebar). Therefore, remove the example block markers. Output by the man backend is unaffected. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * Documentation/gitdiffcore: Remove misleading date in headingMichael J Gruber2010-03-211-1/+1
| | | | | | | | | | | | | | | | | | | | Ever since the automatic conversion into man form, the heading contained a misidentified subheading reading "June 2005". Remove this since the documentation is more recent, and the correct date is in the footer. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * Documentation/git-reflog: Fix formatting of command listsMichael J Gruber2010-03-211-2/+0
| | | | | | | | | | | | | | | | A misplaced list continuation mark appears literally in the rendered doc. Fix this by removing it. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * Merge branch 'sp/maint-push-sideband' into maint-1.6.6Junio C Hamano2010-03-071-11/+41
| |\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * sp/maint-push-sideband: receive-pack: Send internal errors over side-band #2 t5401: Use a bare repository for the remote peer receive-pack: Send hook output over side band #2 receive-pack: Wrap status reports inside side-band-64k receive-pack: Refactor how capabilities are shown to the client send-pack: demultiplex a sideband stream with status data run-command: support custom fd-set in async run-command: Allow stderr to be a caller supplied pipe
* | | Update draft release notes to 1.7.0.3Junio C Hamano2010-03-201-1/+7
| | | | | | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | Documentation: receive.denyCurrentBranch defaults to 'refuse'Thomas Rast2010-03-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | acd2a45 (Refuse updating the current branch in a non-bare repository via push, 2009-02-11) changed the default to refuse such a push, but it forgot to update the docs. Signed-off-by: Thomas Rast <trast@student.ethz.ch> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | Documentation/git-read-tree: clarify 2-tree mergeMichael J Gruber2010-03-151-13/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | Clarify the description of the 2-tree merge by defining the terms which are used in the table, and by applying some small linguistic changes. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | Documentation/git-read-tree: fix table layoutMichael J Gruber2010-03-151-10/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | Asciidoc takes the first non-space character in the first line of the paragraph as a reference point for preformatted layout, so adjust to that to make the table align. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | Merge accumulated fixes to prepare for 1.7.0.3Junio C Hamano2010-03-081-0/+34
| | | | | | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | Merge branch 'gb/maint-submodule-env' into maintJunio C Hamano2010-03-081-0/+6
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * gb/maint-submodule-env: is_submodule_modified(): clear environment properly submodules: ensure clean environment when operating in a submodule shell setup: clear_local_git_env() function rev-parse: --local-env-vars option Refactor list of of repo-local env vars
| * | | rev-parse: --local-env-vars optionGiuseppe Bilotta2010-02-241-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This prints the list of repo-local environment variables. Signed-off-by: Giuseppe Bilotta <giuseppe.bilotta@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | Merge branch 'ml/maint-grep-doc' into maintJunio C Hamano2010-03-081-13/+17
|\ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * ml/maint-grep-doc: grep docs: document --no-index option grep docs: --cached and <tree>... are incompatible grep docs: use AsciiDoc literals consistently grep docs: pluralize "Example" section
| * | | | grep docs: document --no-index optionMark Lodato2010-02-251-4/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Also clarify --cached and <tree>. Signed-off-by: Mark Lodato <lodatom@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * | | | grep docs: --cached and <tree>... are incompatibleMark Lodato2010-02-251-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In the synopsis for git-grep(1), show that --cached and <tree>... cannot be used together. Signed-off-by: Mark Lodato <lodatom@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * | | | grep docs: use AsciiDoc literals consistentlyMark Lodato2010-02-251-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The convention for this particular page is to use AsciiDoc literal strings only for options (`-x` or `--long`), but not for definition list terms and not for <meta-vars>. Signed-off-by: Mark Lodato <lodatom@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * | | | grep docs: pluralize "Example" sectionMark Lodato2010-02-251-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | Signed-off-by: Mark Lodato <lodatom@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | Merge branch 'ne/pack-local-doc' into maintJunio C Hamano2010-03-081-8/+7
|\ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * ne/pack-local-doc: pack-objects documentation: Fix --honor-pack-keep as well. pack-objects documentation: reword "objects that appear in the standard input" Documentation: pack-objects: Clarify --local's semantics.
| * | | | | pack-objects documentation: Fix --honor-pack-keep as well.Nelson Elhage2010-02-241-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Signed-off-by: Nelson Elhage <nelhage@mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * | | | | pack-objects documentation: reword "objects that appear in the standard input"Junio C Hamano2010-02-241-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | These were written back when we always read objects from the standard input. These days --revs and its friends can feed only the start and end points and have the command internally enumerate the objects. Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * | | | | Documentation: pack-objects: Clarify --local's semantics.Nelson Elhage2010-02-201-5/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The current documentation suggests that --local also ignores any objects in local packs, which is incorrect. Change the language to be clearer and more parallel to the other options that ignore objects. While we're at it, fix a trivial error in --incremental's documentation. Signed-off-by: Nelson Elhage <nelhage@mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | Merge branch 'jc/checkout-detached' into maintJunio C Hamano2010-03-081-0/+5
|\ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | * jc/checkout-detached: Reword "detached HEAD" notification
| * | | | | | Reword "detached HEAD" notificationJunio C Hamano2010-01-291-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The old "advice" message explained how to create a branch after going into a detached HEAD state but didn't make it clear why the user may want to do so. Also "moving to ... which isn't a local branch" was unclear if it is complaining, if it is describing the new state, or if it is explaining why the HEAD is detached (the true reason is the last one). Give the established phrase 'detached HEAD' first to make it easy for users to look up the concept in documentation, and briefly describe what can be done in the state (i.e. play around without having to clean up) before telling the user how to keep what was done during the temporary state. Allow the long description to be hidden by setting advice.detachedHead configuration to false. We might want to customize the advice depending on how the commit to check out was spelled (e.g. instead of "new-branch-name", we way want to say "topic" when "git checkout origin/topic" triggered this message) in later updates, but this encapsulates that into a separate function and it should be a good first step. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | Git 1.7.0.2v1.7.0.2Junio C Hamano2010-03-072-7/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | Update draft release notes to 1.7.0.2Junio C Hamano2010-03-041-1/+25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>