summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)AuthorFilesLines
2010-06-25Add the option "--ignore-submodules" to "git status"Libravatar Jens Lehmann1-0/+11
In some use cases it is not desirable that "git status" considers submodules that only contain untracked content as dirty. This may happen e.g. when the submodule is not under the developers control and not all build generated files have been added to .gitignore by the upstream developers. Using the "untracked" parameter for the "--ignore-submodules" option disables checking for untracked content and lets git diff report them as changed only when they have new commits or modified content. Sometimes it is not wanted to have submodules show up as changed when they just contain changes to their work tree (this was the behavior before 1.7.0). An example for that are scripts which just want to check for submodule commits while ignoring any changes to the work tree. Also users having large submodules known not to change might want to use this option, as the - sometimes substantial - time it takes to scan the submodule work tree(s) is saved when using the "dirty" parameter. And if you want to ignore any changes to submodules, you can now do that by using this option without parameters or with "all" (when the config option status.submodulesummary is set, using "all" will also suppress the output of the submodule summary). A new function handle_ignore_submodules_arg() is introduced to parse this option new to "git status" in a single location, as "git diff" already knew it. Signed-off-by: Jens Lehmann <Jens.Lehmann@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-06-11Add optional parameters to the diff option "--ignore-submodules"Libravatar Jens Lehmann1-2/+8
In some use cases it is not desirable that the diff family considers submodules that only contain untracked content as dirty. This may happen e.g. when the submodule is not under the developers control and not all build generated files have been added to .gitignore by the upstream developers. Using the "untracked" parameter for the "--ignore-submodules" option disables checking for untracked content and lets git diff report them as changed only when they have new commits or modified content. Sometimes it is not wanted to have submodules show up as changed when they just contain changes to their work tree. An example for that are scripts which just want to check for submodule commits while ignoring any changes to the work tree. Also users having large submodules known not to change might want to use this option, as the - sometimes substantial - time it takes to scan the submodule work tree(s) is saved. Signed-off-by: Jens Lehmann <Jens.Lehmann@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-06-06commit.txt: clarify how --author argument is usedLibravatar Jay Soffian1-4/+5
commit --author was added by 146ea06 (git commit --author=$name: look $name up in existing commits), but its documentation was sorely lacking compared to its excellent commit message. This commit tries to improve the documentation. Signed-off-by: Jay Soffian <jaysoffian@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-06-02Documentation: A...B shortcut for checkout and rebaseLibravatar Michael J Gruber2-0/+8
Describe the A...B shortcuts for checkout and rebase [-i] which were introduced in these commits: 619a64e ("checkout A...B" switches to the merge base between A and B, 2009-10-18) 61dfa1b ("rebase --onto A...B" replays history on the merge base between A and B, 2009-11-20) 230a456 (rebase -i: teach --onto A...B syntax, 2010-01-07) Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-06-02Documentation/pretty-{formats,options}: better reference for "format:<string>"Libravatar Nazri Ramliy2-4/+5
In "git help log" (and friends) it's not easy to find the possible placeholder for <string> for the "--pretty=format:<string>" option to git log. This patch makes the placeholder easier to find by adding a reference to the "PRETTY FORMATS" section and repeating the "format:<string>" phrase. Signed-off-by: Nazri Ramliy <ayiehere@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-05-31Merge branch 'maint-1.7.0' into maintLibravatar Junio C Hamano1-0/+7
* maint-1.7.0: Documentation/config: describe status.submodulesummary
2010-05-31Documentation/SubmittingPatches: Fix typo in GMail sectionLibravatar Tim Henigan1-1/+1
Commit e498257d introduced a typo while improving the GMail section of SubmittingPatches. Signed-off-by: Tim Henigan <tim.henigan@gmail.com> Acked-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-05-28Documentation/config: describe status.submodulesummaryLibravatar Michael J Gruber1-0/+7
ac8d5af (builtin-status: submodule summary support, 2008-04-12) intoduced this variable and described it in git-status[1]. Include this description in git-config[1], as well. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-05-25Documentation/SubmittingPatches: clarify GMail section and SMTPLibravatar Michael J Gruber1-19/+21
We keep getting mangled submissions from GMail's web interface. Try to be more proactive in SubmittingPatches by - pointing to MUA specific instructions early on, - structuring the GMail section more clearly, - putting send-email/SMTP before imap-send/IMAP. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-05-18Documentation/gitdiffcore: fix order in pickaxe descriptionLibravatar Michael J Gruber1-2/+2
Reverse the order of "origin" and "result" so that the sentence really describes an addition rather than a removal. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-05-18Documentation: fix minor inconsistencyLibravatar Michael J Gruber1-1/+1
While we don't always write out commands in full (`git command`) we should do it consistently in adjacent paragraphs. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-05-18Documentation: rebase -i ignores options passed to "git am"Libravatar Markus Heidelberg1-0/+1
Signed-off-by: Markus Heidelberg <markus.heidelberg@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-05-07Documentation/config.txt: GIT_NOTES_REWRITE_REF overrides notes.rewriteRefLibravatar Leif Arne Storset1-4/+4
The documentation erroneously mentions the GIT_NOTES_REWRITE_REF override in the description of notes.rewrite.<command>. Move it under notes.rewriteRef where it belongs. Signed-off-by: Leif Arne Storset <lstorset@opera.com> Acked-by: Thomas Rast <trast@student.ethz.ch> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-05-04Documentation/git-send-email: Add "Use gmail as the smtp server"Libravatar Ping Yin1-0/+15
Signed-off-by: Ping Yin <pkufranky@gmail.com> Acked by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-04-23Git 1.7.1Libravatar Junio C Hamano2-8/+7
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-04-23Merge branch 'maint'Libravatar Junio C Hamano1-9/+34
* maint: Documentation improvements for the description of short format.
2010-04-23Documentation improvements for the description of short format.Libravatar Eric Raymond1-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>
2010-04-22Sync with 1.7.0.6Libravatar Junio C Hamano2-1/+15
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-04-22Git 1.7.0.6Libravatar Junio C Hamano2-1/+15
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-04-22Merge branch 'wp/doc-filter-direction' into maintLibravatar Junio C Hamano1-4/+4
* wp/doc-filter-direction: documentation: clarify direction of core.autocrlf
2010-04-21Merge branch 'maint'Libravatar Junio C Hamano1-2/+6
* maint: Documentation/Makefile: fix interrupted builds of user-manual.xml
2010-04-21Documentation/Makefile: fix interrupted builds of user-manual.xmlLibravatar Jonathan Nieder1-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>
2010-04-18Git 1.7.1-rc2Libravatar Junio C Hamano1-1/+8
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-04-18Merge branch 'rr/remote-helper-doc'Libravatar Junio C Hamano2-58/+119
* rr/remote-helper-doc: Documentation/remote-helpers: Fix typos and improve language Fixup: Second argument may be any arbitrary string Documentation/remote-helpers: Add invocation section Documentation/urls: Rewrite to accomodate <transport>::<address> Documentation/remote-helpers: Rewrite description
2010-04-18Merge branch 'wp/doc-filter-direction'Libravatar Junio C Hamano1-4/+4
* wp/doc-filter-direction: documentation: clarify direction of core.autocrlf
2010-04-18Merge branch 'maint'Libravatar Junio C Hamano1-2/+2
* maint: Documentation: Describe other situations where -z affects git diff
2010-04-18Documentation/remote-helpers: Fix typos and improve languageLibravatar Ramkumar Ramachandra1-28/+23
Fix some typos and errors in grammar and tense. Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com> Acked-by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-04-18Fixup: Second argument may be any arbitrary stringLibravatar Ramkumar Ramachandra1-3/+2
This is intended to be a fixup for commit ad466d1 in pu. As Jonathan Neider pointed out, the second argument may be any arbitrary string, and need not conform to any URL-like shape. Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com> Acked-by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-04-18Documentation/remote-helpers: Add invocation sectionLibravatar Ramkumar Ramachandra1-1/+34
Add an 'Invocation' section to specify what the command line arguments mean. Also include a link to git-remote in the 'See Also' section. Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com> Acked-by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-04-18Documentation/urls: Rewrite to accomodate <transport>::<address>Libravatar Ramkumar Ramachandra1-23/+36
Rewrite the first part of the document to explicitly show differences between the URLs that can be used with different transport protocols. Mention <transport>::<address> format to explicitly invoke a remote helper. Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com> Reviewed-by: Jonathan Nieder <jrnieder@gmail.com> Acked-by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-04-18Documentation/remote-helpers: Rewrite descriptionLibravatar Ramkumar Ramachandra1-6/+27
Rewrite the description section to describe what exactly remote helpers are and the need for them. Also mention the curl family of remote helpers as an example. [jc: with readability fixes from Jonathan squashed in] Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com> Reviewed-by: Jonathan Nieder <jrnieder@gmail.com> Acked-by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-04-18Documentation: Describe other situations where -z affects git diffLibravatar Charles Bailey1-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>
2010-04-17Merge branch 'maint'Libravatar Junio C Hamano1-1/+3
* maint: t1010-mktree: Adjust expected result to code and documentation combined diff: correctly handle truncated file Document new "already-merged" rule for branch -d
2010-04-17documentation: clarify direction of core.autocrlfLibravatar Will Palmer1-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>
2010-04-15Document new "already-merged" rule for branch -dLibravatar Jonathan Nieder1-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>
2010-04-13Merge branch 'maint'Libravatar Junio C Hamano3-7/+8
* maint: Documentation/config.txt: default gc.aggressiveWindow is 250, not 10 Docs: Add -X option to git-merge's synopsis. Conflicts: Documentation/merge-options.txt
2010-04-13Documentation/config.txt: default gc.aggressiveWindow is 250, not 10Libravatar Jay Soffian1-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>
2010-04-12Docs: Add -X option to git-merge's synopsis.Libravatar Marc Branchaud2-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>
2010-04-11Sync with 1.7.0.5Libravatar Junio C Hamano3-10/+38
2010-04-11Merge branch 'jc/doc-submit-gmail'Libravatar Junio C Hamano1-11/+24
* jc/doc-submit-gmail: SubmittingPatches: update GMail section
2010-04-11Git 1.7.0.5Libravatar Junio C Hamano2-1/+28
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-04-11blame documentation: -M/-C notice copied lines as well as moved onesLibravatar Junio C Hamano1-9/+10
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-04-10Git 1.7.1-rc1Libravatar Junio C Hamano1-1/+4
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-04-09Merge branch 'maint'Libravatar Junio C Hamano2-5/+5
* maint: Let check_preimage() use memset() to initialize "struct checkout" fetch/push: fix usage strings
2010-04-09Merge branch 'rr/imap-send-unconfuse-from-line' into maintLibravatar Junio C Hamano1-7/+3
* rr/imap-send-unconfuse-from-line: imap-send: Remove limitation on message body
2010-04-09fetch/push: fix usage stringsLibravatar Tay Ray Chuan2-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>
2010-04-08Merge branch 'maint'Libravatar Junio C Hamano1-0/+2
* maint: docs: clarify "branch -l"
2010-04-08docs: clarify "branch -l"Libravatar Jeff King1-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>
2010-04-07SubmittingPatches: update GMail sectionLibravatar Junio C Hamano1-11/+24
Even if you use imap-send to throw your drafts in the outbox, using their web interface will mangle your patches. Clarify that the imap-send is meant to be used together with a real MUA that can use IMAP drafts, and remove instructions related to the web interface, which is irrelevant. Add description of send-email as an alternative. Use --cover-letter, and do not use -C nor --no-color, on the example command line for format-patch. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-04-07fix typos and grammar in 1.7.1 draft release notesLibravatar Jeff King1-10/+10
Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-12 15:02:24 +0000