summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)AuthorFilesLines
2012-08-29Merge branch 'mh/maint-config-doc-proxy-command'Libravatar Junio C Hamano1-2/+2
* mh/maint-config-doc-proxy-command: git-config doc: unconfuse an example git-config.txt: fix example
2012-08-27First half of the second batch for 1.8.0Libravatar Junio C Hamano1-0/+37
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-27Merge branch 'jk/docs-docbook-monospace-display'Libravatar Junio C Hamano2-3/+3
The documentation in the TeXinfo format was using indented output for materials meant to be examples that are better typeset in monospace. * jk/docs-docbook-monospace-display: docs: monospace listings in docbook output
2012-08-27Merge branch 'da/difftool-updates'Libravatar Junio C Hamano2-0/+11
"git difftool --dir-diff" learned to use symbolic links to prepare temporary copy of the working tree when available. * da/difftool-updates: difftool: silence warning Add Code Compare v2.80.4 as a merge / diff tool for Windows mergetool,difftool: Document --tool-help consistently difftool: Disable --symlinks on cygwin difftool: Handle compare() returning -1 difftool: Wrap long lines for readability difftool: Check all return codes from compare() difftool: Handle finding mergetools/ in a path with spaces difftool: Use symlinks when diffing against the worktree difftool: Call the temp directory "git-difftool" difftool: Move option values into a hash difftool: Eliminate global variables difftool: Simplify print_tool_help()
2012-08-27Merge branch 'js/grep-patterntype-config'Libravatar Junio C Hamano2-2/+18
"grep" learned to use a non-standard pattern type by default if a configuration variable tells it to. * js/grep-patterntype-config: grep: add a grep.patternType configuration setting
2012-08-24Merge branch 'maint'Libravatar Junio C Hamano1-0/+34
* maint: Prepare for 1.7.11.6 Make the ciabot scripts completely self-configuring in the normal case. Improved documentation for the ciabot scripts.
2012-08-24Merge branch 'maint-1.7.11' into maintLibravatar Junio C Hamano12-23/+102
* maint-1.7.11: Prepare for 1.7.11.6 Make the ciabot scripts completely self-configuring in the normal case. Improved documentation for the ciabot scripts. man: git pull -r is a short for --rebase gitcli: describe abbreviation of long options rev-list docs: clarify --topo-order description Documentation/CodingGuidelines: spell out more shell guidelines Documentation: do not mention .git/refs/* directories tests: Introduce test_seq
2012-08-24Prepare for 1.7.11.6Libravatar Junio C Hamano1-0/+34
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-24Merge branch 'mv/pull-r-for-rebase' into maint-1.7.11Libravatar Junio C Hamano1-0/+1
A minor documentation update. * mv/pull-r-for-rebase: man: git pull -r is a short for --rebase
2012-08-24Merge branch 'jc/maint-abbrev-option-cli' into maint-1.7.11Libravatar Junio C Hamano1-0/+8
We did not document that many commands take unique prefix abbreviations of long options (e.g. "--option" may be the only flag that the command accepts that begin with "--opt", in which case you can give "--opt") anywhere easy to find for new people. * jc/maint-abbrev-option-cli: gitcli: describe abbreviation of long options
2012-08-24Merge branch 'jc/maint-rev-list-topo-doc' into maint-1.7.11Libravatar Junio C Hamano1-7/+24
It was unclear what "--topo-order" was really about in the documentation. It is not just about "children before parent", but also about "don't mix lineages". * jc/maint-rev-list-topo-doc: rev-list docs: clarify --topo-order description
2012-08-24Merge branch 'hv/coding-guidelines' into maint-1.7.11Libravatar Junio C Hamano1-0/+8
In earlier days, "imitate the style in the neibouring code" was sufficient to keep the coherent style, but over time some parts of the codebase have drifted enough to make it ineffective. * hv/coding-guidelines: Documentation/CodingGuidelines: spell out more shell guidelines
2012-08-24Merge branch 'jc/tag-doc' into maint-1.7.11Libravatar Junio C Hamano7-16/+27
Our documentation used to assume having files in .git/refs/* directories was the only to have branches and tags, but that is not true for quite some time. * jc/tag-doc: Documentation: do not mention .git/refs/* directories
2012-08-22Kick off cycle towards 1.8.0Libravatar Junio C Hamano1-0/+44
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-22Merge branch 'jc/doc-git-updates'Libravatar Junio C Hamano1-28/+32
A minor documentation update. * jc/doc-git-updates: Documentation: update the introductory section
2012-08-22Merge branch 'mv/pull-r-for-rebase'Libravatar Junio C Hamano1-0/+1
A minor documentation update. * mv/pull-r-for-rebase: man: git pull -r is a short for --rebase
2012-08-22Merge branch 'jc/maint-abbrev-option-cli'Libravatar Junio C Hamano1-0/+8
We did not document that many commands take unique prefix abbreviations of long options (e.g. "--option" may be the only flag that the command accepts that begin with "--opt", in which case you can give "--opt") anywhere easy to find for new people. * jc/maint-abbrev-option-cli: gitcli: describe abbreviation of long options
2012-08-22Merge branch 'jc/maint-rev-list-topo-doc'Libravatar Junio C Hamano1-7/+24
It was unclear what "--topo-order" was really about in the documentation. It is not just about "children before parent", but also about "don't mix lineages". * jc/maint-rev-list-topo-doc: rev-list docs: clarify --topo-order description
2012-08-22Merge branch 'hv/coding-guidelines'Libravatar Junio C Hamano1-0/+8
In earlier days, "imitate the style in the neibouring code" was sufficient to keep the coherent style, but over time some parts of the codebase have drifted enough to make it ineffective. * hv/coding-guidelines: Documentation/CodingGuidelines: spell out more shell guidelines
2012-08-22Merge branch 'jk/check-docs-update'Libravatar Junio C Hamano4-3/+6
Simplify "make check-docs" implementation and update its coverage. * jk/check-docs-update: check-docs: get documented command list from Makefile check-docs: drop git-help special-case check-docs: list git-gui as a command check-docs: factor out command-list command-list: mention git-credential-* helpers command-list: add git-sh-i18n check-docs: update non-command documentation list check-docs: mention gitweb specially
2012-08-22Merge branch 'jc/tag-doc'Libravatar Junio C Hamano7-16/+27
Our documentation used to assume having files in .git/refs/* directories was the only to have branches and tags, but that is not true for quite some time. * jc/tag-doc: Documentation: do not mention .git/refs/* directories
2012-08-19Git 1.7.12Libravatar Junio C Hamano1-0/+5
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-18git-config doc: unconfuse an exampleLibravatar Junio C Hamano1-1/+1
One fictitious command "proxy-command" is enclosed inside a double quote pair, while another fictitious command "default-proxy" is not in the example, but the quoting does not change anything in the pair of examples. Remove the quotes to avoid unnecessary confusion. Noticed by Michael Haggerty. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-18git-config.txt: fix exampleLibravatar Michael Haggerty1-1/+1
The "--add" option is required to add a new value to a multivalued configuration entry. Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-17Merge branch 'jc/doc-git-updates' (early part)Libravatar Junio C Hamano1-1/+1
* 'jc/doc-git-updates' (early part): Documentation: update URL for formatted pages
2012-08-17Documentation: update the introductory sectionLibravatar Junio C Hamano1-28/+32
The second paragraph in the git(1) description section were meant to guide people who are not ready to dive into this page away from here. Referring migrating CVS users to another page before they get acquainted with Git was somewhat out of place. Move the reference to the "FURTHER DOCUMENTATION" section and push that section down. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-17Documentation: update URL for formatted pagesLibravatar Junio C Hamano1-1/+1
The one at kernel.org has not been updated for quite a while and can no longer be called "the latest". Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-17man: git pull -r is a short for --rebaseLibravatar Miklos Vajna1-0/+1
Letting the "--rebase" option squat on the short-and-sweet single letter option "-r" was an unintended accident and was not even documented, but the short option seems to be already used in the wild. Let's document it so that other options that begin with "r" would not be tempted to steal it. Signed-off-by: Miklos Vajna <vmiklos@suse.cz> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-16gitcli: describe abbreviation of long optionsLibravatar Junio C Hamano1-0/+8
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-15Git 1.7.12-rc3Libravatar Junio C Hamano1-10/+1
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-15Sync with 1.7.11.5Libravatar Junio C Hamano2-1/+10
2012-08-15Git 1.7.11.5Libravatar Junio C Hamano2-1/+10
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-15rev-list docs: clarify --topo-order descriptionLibravatar Junio C Hamano1-7/+24
It was unclear what "--topo-order" was really about in the documentation. It is not just about "children before parent", but also about "don't mix lineages". Reword the description for both "--date-order" and "--topo-order", and add an illustration to it. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-15Documentation/CodingGuidelines: spell out more shell guidelinesLibravatar Heiko Voigt1-0/+8
In earlier days, "imitate the style in the neibouring code" was sufficient to keep the coherent style, but over time some parts of the codebase have drifted enough to make it ineffective. Spell some of the guidelines out. Signed-off-by: Heiko Voigt <hvoigt@hvoigt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-10mergetool,difftool: Document --tool-help consistentlyLibravatar David Aguilar2-3/+6
Add an entry for --tool-help to the mergetool documentation. Move --tool-help in the difftool documentation so that it is listed immediately after --tool so that it is easier to find. Signed-off-by: David Aguilar <davvid@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-08check-docs: get documented command list from MakefileLibravatar Jeff King1-0/+3
The current code tries to get a list of documented commands by doing "ls Documentation/git*txt" and culling a bunch of special cases from the result. Looking for "git-*.txt" would be more accurate, but would miss a few commands like "gitweb" and "gitk". Fortunately, Documentation/Makefile already knows what this list is, so we can just ask it. Annoyingly, we still have to post-process its output a little, since make will print extra cruft like "GIT-VERSION-FILE is up to date" to stdout. Now that our list is accurate, we can remove all of the ugly special-cases. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-08command-list: mention git-credential-* helpersLibravatar Jeff King3-3/+3
These commands were never added to the command-list. Adding them makes "make check-docs" run without complaint. While we're at it, let's capitalize the first letter of their one-line summaries to match the rest of the git manpages. The credential-cache--daemon command is somewhat special. It is already ignored by check-docs because it contains a "--", marking it as a non-interesting implementation detail. It is, in fact, documented, but since the documentation basically just redirects you to a more appropriate command anyway, let's explicitly omit it so it is not mentioned in git(1). Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-08Documentation: list git-credential in plumbing commandsLibravatar Matthieu Moy1-1/+1
Commit e30b2feb1b (Jun 24 2012, add 'git credential' plumbing command) forgot to add git-credential to command-list.txt, hence the command was not appearing in the documentation, making it hard for users to discover it. While we're there, capitalize the description line for git-crendential for consistency with other commands. Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-07docs: monospace listings in docbook outputLibravatar Jeff King2-3/+3
When asciidoc converts a listing block like: ---------------------- $ git log --merge ---------------------- it marks it to be displayed in a monospace font. This works fine when generating HTML output. However, when generating docbook output, we override the expansion of a listingblock to work around bugs in some versions of the docbook toolchain. Our override did not mark the listingblock with the "monospaced" class. The main output that uses docbook as an intermediate format is the manpages. We didn't notice any issue there because the monospaced class seems to be ignored when generating roff from the docbook manpages. However, when generating texinfo to make info pages, docbook does respect this class. The resulting texinfo output properly uses "@example" blocks to display the listing in this case. Besides possibly looking prettier in some texinfo backends, one important effect is that the monospace font suppresses texinfo's expansion of "--" and "---" into en-dashes and em-dashes. With the current code, the example above ends up looking like "git log -merge", which is confusing and wrong. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-07Git 1.7.12-rc2Libravatar Junio C Hamano1-4/+0
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-06Drop 1.7.11.x items from 1.7.12 release notesLibravatar Junio C Hamano1-13/+0
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-06Sync with maintLibravatar Junio C Hamano1-0/+28
2012-08-06Prepare for 1.7.11.5Libravatar Junio C Hamano1-0/+28
Hopefully that will be the final 1.7.11.x maintenance release. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-06Merge branch 'ms/daemon-doc-typo' into maintLibravatar Junio C Hamano1-1/+1
* ms/daemon-doc-typo: Documentation/git-daemon: add missing word
2012-08-06Merge branch 'rr/doc-commit' into maintLibravatar Junio C Hamano1-0/+8
* rr/doc-commit: commit: document a couple of options
2012-08-06doc: A few minor copy edits.Libravatar Štěpán Němec5-10/+10
- (glossary) the quotes around the Wikipedia URL prevented its linkification in frontends that support it; remove them - (manual) newer version (SHA-1) == following, older == preceding, not the other way around - trivial typo and wording fixes Signed-off-by: Štěpán Němec <stepnem@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-06Merge branch 'mh/maint-revisions-doc' into maintLibravatar Junio C Hamano1-6/+37
* mh/maint-revisions-doc: Enumerate revision range specifiers in the documentation Make <refname> documentation more consistent.
2012-08-06Merge branch 'jc/mergetool-tool-help' into maintLibravatar Junio C Hamano1-3/+3
* jc/mergetool-tool-help: mergetool: support --tool-help option like difftool does
2012-08-06Documentation: do not mention .git/refs/* directoriesLibravatar Junio C Hamano7-16/+27
It is an implementation detail that a new tag is created by adding a file in the .git/refs/tags directory. The only thing the user needs to know is that a "git tag" creates a ref in the refs/tags namespace, and without "-f", it does not overwrite an existing tag. Inspired by a report from 乙酸鋰 <ch3cooli@gmail.com>; I think I caught all the existing mention in Documentation/ directory in the tip of 1.7.9.X maintenance track, but we may have added new ones since then. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-08-03grep: add a grep.patternType configuration settingLibravatar J Smith2-2/+18
The grep.extendedRegexp configuration setting enables the -E flag on grep by default but there are no equivalents for the -G, -F and -P flags. Rather than adding an additional setting for grep.fooRegexp for current and future pattern matching options, add a grep.patternType setting that can accept appropriate values for modifying the default grep pattern matching behavior. The current values are "basic", "extended", "fixed", "perl" and "default" for setting -G, -E, -F, -P and the default behavior respectively. When grep.patternType is set to a value other than "default", the grep.extendedRegexp setting is ignored. The value of "default" restores the current default behavior, including the grep.extendedRegexp behavior. Signed-off-by: J Smith <dark.panda@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>