summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)AuthorFilesLines
2013-01-11Merge branch 'kb/maint-bundle-doc' into maintLibravatar Junio C Hamano1-5/+4
* kb/maint-bundle-doc: Documentation: full-ness of a bundle is significant for cloning Documentation: correct example restore from bundle
2013-01-11Merge branch 'jn/warn-on-inaccessible-loosen' into maintLibravatar Junio C Hamano2-0/+12
When attempting to read the XDG-style $HOME/.config/git/config and finding that $HOME/.config/git is a file, we gave a wrong error message, instead of treating the case as "a custom config file does not exist there" and moving on. * jn/warn-on-inaccessible-loosen: config: exit on error accessing any config file doc: advertise GIT_CONFIG_NOSYSTEM config: treat user and xdg config permission problems as errors config, gitignore: failure to access with ENOTDIR is ok
2013-01-10Prepare for 1.8.1.1Libravatar Junio C Hamano1-0/+36
2013-01-10Merge branch 'ta/remove-stale-translated-tut' into maintLibravatar Junio C Hamano1-675/+0
* ta/remove-stale-translated-tut: Remove Documentation/pt_BR/gittutorial.txt
2013-01-01Documentation: full-ness of a bundle is significant for cloningLibravatar Junio C Hamano1-4/+3
Not necessarily every bundle file can be cloned from. Only the ones that do not need prerequisites can. When 1d52b02 (Documentation: minor grammatical fixes and rewording in git-bundle.txt, 2009-03-22) reworded this paragraph, it lost a critical hint to tell readers why this particular bundle can be cloned from. Resurrect it. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-01-01Documentation: correct example restore from bundleLibravatar Kirill Brilliantov1-1/+1
Because the bundle created in the example does not record HEAD, "git clone" will not check out the files to the working tree: $ git clone pr.bundle q/ Cloning into 'q'... Receiving objects: 100% (619/619), 13.52 MiB | 18.74 MiB/s, done. Resolving deltas: 100% (413/413), done. warning: remote HEAD refers to nonexistent ref, unable to checkout. Avoid alarming the readers by adding "-b master" to the example. A better fix may be to arrange the bundle created in the earlier step to record HEAD, so that it can be cloned without this workaround. Signed-off-by: Brilliantov Kirill Vladimirovich <brilliantov@inbox.ru> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-31Git 1.8.1Libravatar Junio C Hamano2-15/+20
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-27Sync with 1.8.0.3Libravatar Junio C Hamano2-1/+16
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-27Git 1.8.0.3Libravatar Junio C Hamano2-1/+16
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-27git(1): show link to contributor summary pageLibravatar Junio C Hamano1-1/+4
We earlier removed a link to list of contributors that pointed to a defunct page; let's use a working one from Ohloh.net to replace it instead. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-27Merge branch 'sl/maint-git-svn-docs' into maintLibravatar Junio C Hamano1-6/+85
* sl/maint-git-svn-docs: git-svn: Note about tags. git-svn: Expand documentation for --follow-parent git-svn: Recommend use of structure options. git-svn: Document branches with at-sign(@).
2012-12-27git-svn: Note about tags.Libravatar Sebastian Leske1-0/+6
Document that 'git svn' will import SVN tags as branches. Signed-off-by: Sebastian Leske <sebastian.leske@sleske.name> Acked-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-27git-svn: Expand documentation for --follow-parentLibravatar Sebastian Leske1-3/+12
Describe what the option --follow-parent does, and what happens if it is set or unset. Signed-off-by: Sebastian Leske <sebastian.leske@sleske.name> Acked-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-27git-svn: Recommend use of structure options.Libravatar Sebastian Leske1-3/+21
Document that when using git svn, one should usually either use the directory structure options to import branches as branches, or only import one subdirectory. The default behaviour of cloning all branches and tags as subdirectories in the working copy is usually not what the user wants. Signed-off-by: Sebastian Leske <sebastian.leske@sleske.name> Acked-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-27git-svn: Document branches with at-sign(@).Libravatar Sebastian Leske1-0/+46
git svn sometimes creates branches with an at-sign in the name (branchname@revision). These branches confuse many users and it is a FAQ why they are created. Document when git svn creates them. Signed-off-by: Sebastian Leske <sebastian.leske@sleske.name> Acked-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-27Merge branch 'gb/maint-doc-svn-log-window-size' into maintLibravatar Junio C Hamano1-0/+7
* branch 'gb/maint-doc-svn-log-window-size': Document git-svn fetch --log-window-size parameter
2012-12-27Merge branch 'km/maint-doc-git-reset' into maintLibravatar Junio C Hamano1-4/+4
* branch 'km/maint-doc-git-reset': doc: git-reset: make "<mode>" optional
2012-12-27git-remote-helpers.txt: document invocation before input formatLibravatar Max Horn1-31/+31
In the distant past, the order things were documented was 'Invocation', 'Commands', 'Capabilities', ... Then it was decided that before giving a list of Commands, there should be an overall description of the 'Input format', which was a wise decision. However, this description was put as the very first thing, with the rationale that any implementor would want to know that first. However, it seems an implementor would actually first need to know how the remote helper will be invoked, so moving 'Invocation' to the front again seems logical. Moreover, we now don't switch from discussing the input format to the invocation style and then back to input related stuff. Signed-off-by: Max Horn <max@quendi.de> Acked-by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-27Merge branch 'jk/avoid-mailto-invalid-in-doc' into maintLibravatar Junio C Hamano3-3/+3
* jk/avoid-mailto-invalid-in-doc: Documentation: don't link to example mail addresses
2012-12-27Merge branch 'tj/maint-doc-commit-sign' into maintLibravatar Junio C Hamano1-1/+5
* branch 'tj/maint-doc-commit-sign': Add -S, --gpg-sign option to manpage of "git commit"
2012-12-27Documentation: move diff.wordRegex from config.txt to diff-config.txtLibravatar Ramkumar Ramachandra2-6/+6
19299a8 (Documentation: Move diff.<driver>.* from config.txt to diff-config.txt, 2011-04-07) moved the diff configuration options to diff-config.txt, but forgot about diff.wordRegex, which was left behind in config.txt. Fix this. Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com> Acked-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-27Remove Documentation/pt_BR/gittutorial.txtLibravatar Thomas Ackermann1-675/+0
This file is rather outdated and IMHO shouldn't be there in the first place. (If there are translations of the Git documentation they are better be kept separate from the original documentation.) Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-22Merge branch 'maint'Libravatar Junio C Hamano1-1/+1
2012-12-22Merge branch 'jc/doc-diff-blobs' into maintLibravatar Junio C Hamano1-2/+7
* jc/doc-diff-blobs: Documentation: Describe "git diff <blob> <blob>" separately
2012-12-22Merge branch 'cr/doc-checkout-branch' into maintLibravatar Junio C Hamano1-10/+41
* cr/doc-checkout-branch: Documentation/git-checkout.txt: document 70c9ac2 behavior Documentation/git-checkout.txt: clarify usage
2012-12-22Merge branch 'ta/api-index-doc' into maintLibravatar Junio C Hamano1-2/+0
* ta/api-index-doc: Remove misleading date from api-index-skel.txt
2012-12-22Merge branch 'as/doc-for-devs' into maintLibravatar Junio C Hamano2-13/+16
* as/doc-for-devs: Documentation: move support for old compilers to CodingGuidelines SubmittingPatches: add convention of prefixing commit messages
2012-12-22Merge branch 'jc/fetch-tags-doc' into maintLibravatar Junio C Hamano1-8/+5
* jc/fetch-tags-doc: fetch --tags: clarify documentation
2012-12-22Merge branch 'nd/index-format-doc' into maintLibravatar Junio C Hamano1-2/+3
* nd/index-format-doc: index-format.txt: clarify what is "invalid"
2012-12-22Merge branch 'ta/doc-cleanup' into maintLibravatar Junio C Hamano20-68/+134
* ta/doc-cleanup: Documentation: build html for all files in technical and howto Documentation/howto: convert plain text files to asciidoc Documentation/technical: convert plain text files to asciidoc Change headline of technical/send-pack-pipeline.txt to not confuse its content with content from git-send-pack.txt Shorten two over-long lines in git-bisect-lk2009.txt by abbreviating some sha1 Split over-long synopsis in git-fetch-pack.txt into several lines
2012-12-22Sort howto documents in howto-index.txtLibravatar Thomas Ackermann1-1/+1
Howto documents in howto-index.txt were listed in a rather random order. So better sort them. Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-21Merge branch 'ta/new-command-howto'Libravatar Junio C Hamano2-2/+8
* ta/new-command-howto: Move ./technical/api-command.txt to ./howto/new-command.txt
2012-12-21Merge branch 'jc/doc-diff-blobs'Libravatar Junio C Hamano1-2/+7
"git diff <blob> <blob>" was not documented and was only hinted as an extension to "git diff <commit> <commit> -- <pathspec>", but comparison between two blobs are more special than that. It does not take any pathspec to begin with. * jc/doc-diff-blobs: Documentation: Describe "git diff <blob> <blob>" separately
2012-12-21Merge branch 'cr/doc-checkout-branch'Libravatar Junio C Hamano1-10/+41
Document the magic "git checkout <no-such-branch>" hack to create local branch out of a remote tracking branch that hasn't been documented so far. * cr/doc-checkout-branch: Documentation/git-checkout.txt: document 70c9ac2 behavior Documentation/git-checkout.txt: clarify usage
2012-12-21Merge branch 'ta/api-index-doc'Libravatar Junio C Hamano1-2/+0
* ta/api-index-doc: Remove misleading date from api-index-skel.txt
2012-12-21Merge branch 'jk/avoid-mailto-invalid-in-doc'Libravatar Junio C Hamano3-3/+3
Avoids invalid sample e-mail addresses from becoming mailto links in the formatted output. * jk/avoid-mailto-invalid-in-doc: Documentation: don't link to example mail addresses
2012-12-21Merge branch 'as/doc-for-devs'Libravatar Junio C Hamano2-13/+16
It might be a better idea to move the text the bottom one adds to the extended description from the quick checklist part. * as/doc-for-devs: Documentation: move support for old compilers to CodingGuidelines SubmittingPatches: add convention of prefixing commit messages
2012-12-21Merge branch 'jc/fetch-tags-doc'Libravatar Junio C Hamano1-8/+5
"git fetch --tags" was explained as if it were "git fetch --no-no-tags", which is not the case, causing confusion. * jc/fetch-tags-doc: fetch --tags: clarify documentation
2012-12-21Merge branch 'nd/index-format-doc'Libravatar Junio C Hamano1-2/+3
* nd/index-format-doc: index-format.txt: clarify what is "invalid"
2012-12-21Merge branch 'sl/git-svn-docs'Libravatar Junio C Hamano1-6/+85
* sl/git-svn-docs: git-svn: Note about tags. git-svn: Expand documentation for --follow-parent git-svn: Recommend use of structure options. git-svn: Document branches with at-sign(@).
2012-12-21Move ./technical/api-command.txt to ./howto/new-command.txtLibravatar Thomas Ackermann2-2/+8
The contents of this document does not describe any particular API, but is more about the way to add a new command, which belongs to the "How To" section of the documentation suite. Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-19Remove duplicate entry in ./Documentation/MakefileLibravatar Thomas Ackermann1-1/+0
Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-18Documentation: Describe "git diff <blob> <blob>" separatelyLibravatar Junio C Hamano1-2/+7
As it was not a common operation, it was described as if it is a side note for the more common two-commit variant, but this mode behaves very differently, e.g. it does not make any sense to ask recursive behaviour, or give the command a pathspec. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-18Documentation/git-checkout.txt: document 70c9ac2 behaviorLibravatar Chris Rorvick1-0/+8
Document the behavior implemented in 70c9ac2 (DWIM "git checkout frotz" to "git checkout -b frotz origin/frotz"). Signed-off-by: Chris Rorvick <chris@rorvick.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-18Documentation/git-checkout.txt: clarify usageLibravatar Chris Rorvick1-10/+33
The forms of checkout that do not take a path are lumped together in the DESCRIPTION section, but the description for this group is dominated by explanation of the -b|-B form. Split these apart for more clarity. Signed-off-by: Chris Rorvick <chris@rorvick.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-18Sync with 'maint'Libravatar Junio C Hamano1-1/+5
2012-12-18clarify -M without % symbol in diff-optionsLibravatar Sitaram Chamarty1-1/+5
Signed-off-by: Sitaram Chamarty <sitaramc@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-16Documentation: move support for old compilers to CodingGuidelinesLibravatar Adam Spiers2-13/+8
The "Try to be nice to older C compilers" text is clearly a guideline to be borne in mind whilst coding rather than when submitting patches. Signed-off-by: Adam Spiers <git@adamspiers.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-16SubmittingPatches: add convention of prefixing commit messagesLibravatar Adam Spiers1-0/+8
Conscientious newcomers to git development will read SubmittingPatches and CodingGuidelines, but could easily miss the convention of prefixing commit messages with a single word identifying the file or area the commit touches. Signed-off-by: Adam Spiers <git@adamspiers.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-16Documentation: don't link to example mail addressesLibravatar John Keeping3-3/+3
Email addresses in documentation are converted into mailto: hyperlinks in the HTML output and footnotes in man pages. This isn't desirable for cases where the address is used as an example and is not valid. Particularly annoying is the example "jane@laptop.(none)" which appears in git-shortlog(1) as "jane@laptop[1].(none)", with note 1 saying: 1. jane@laptop mailto:jane@laptop Fix this by escaping these email addresses with a leading backslash, to prevent Asciidoc expanding them as inline macros. In the case of mailmap.txt, render the address monospaced so that it matches the block examples surrounding that paragraph. Helped-by: Jeff King <peff@peff.net> Signed-off-by: John Keeping <john@keeping.me.uk> Signed-off-by: Junio C Hamano <gitster@pobox.com>