summaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* SubmittingPatches: final submission is To: maintainer and CC: listsv/submitting-final-patchSlavomir Vlcek2014-11-131-1/+1
| | | | | | | | | | | | | | | In an earlier part there is: "re-send it with "To:" set to the maintainer [*1*] and "cc:" the list [*2*]" for the final submission, but later we see "Send it to the list and cc the maintainer." Fix the later one to match the previous. Signed-off-by: Slavomir Vlcek <svlc@inventati.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* git-tag.txt: Add a missing hyphen to `-s`Wieland Hoffmann2014-10-071-1/+1
| | | | | Signed-off-by: Wieland Hoffmann <themineo@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: fix missing text for rev-parse --verifybrian m. carlson2014-07-221-1/+1
| | | | | | | | | | | The caret (^) is used as a markup symbol in AsciiDoc. Due to the inability of AsciiDoc to parse a line containing an unmatched caret, it omitted the line from the output, resulting in the man page missing the end of a sentence. Escape this caret so that the man page ends up with the complete text. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Git 1.8.5.5v1.8.5.5Junio C Hamano2014-02-133-2/+40
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Git 1.8.5.4v1.8.5.4Junio C Hamano2014-02-052-1/+50
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Merge branch 'jc/maint-pull-docfix' into maintJunio C Hamano2014-02-052-5/+8
|\ | | | | | | | | | | | | | | | | The documentation to "git pull" hinted there is an "-m" option because it incorrectly shared the documentation with "git merge". * jc/maint-pull-docfix: Documentation: "git pull" does not have the "-m" option Documentation: exclude irrelevant options from "git pull"
| * Documentation: "git pull" does not have the "-m" optionjc/maint-pull-docfixJunio C Hamano2014-01-141-3/+6
| | | | | | | | | | | | | | | | | | | | | | Even though "--[no-]edit" can be used with "git pull", the explanation of the interaction between this option and the "-m" option does not make sense within the context of "git pull". Use the conditional inclusion mechanism to remove this part from "git pull" documentation, while keeping it for "git merge". Reported-by: Ivan Zakharyaschev Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * Merge branch 'jc/maint-pull-docfix-for-409b8d82' into jc/maint-pull-docfixJunio C Hamano2014-01-141-2/+2
| |\ | | | | | | | | | | | | * jc/maint-pull-docfix-for-409b8d82: Documentation: exclude irrelevant options from "git pull"
| | * Documentation: exclude irrelevant options from "git pull"jc/maint-pull-docfix-for-409b8d82Junio C Hamano2014-01-141-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 10eb64f5 (git pull manpage: don't include -n from fetch-options.txt, 2008-01-25) introduced a way to exclude some parts of included source when building git-pull documentation, and later 409b8d82 (Documentation/git-pull: put verbosity options before merge/fetch ones, 2010-02-24) attempted to use the mechanism to exclude some parts of merge-options.txt when used from git-pull.txt. However, the latter did not have an intended effect, because the macro "git-pull" used to decide if the source is included in git-pull documentation were defined a bit too late. Define the macro before it is used to fix this. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | Git 1.8.5.3v1.8.5.3Junio C Hamano2014-01-132-1/+29
| | |
* | | pack-heuristics.txt: mark up the file header properlyThomas Ackermann2014-01-131-2/+2
| | | | | | | | | | | | | | | | | | | | | AsciiDoc wants these header-lines left-aligned. Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | Documentation/gitmodules: Only 'update' and 'url' are requiredW. Trevor King2014-01-061-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Descriptions for all the settings fell under the initial "Each submodule section also contains the following required keys:". The example shows sections with just 'path' and 'url' entries, which are indeed required, but we should still make the required/optional distinction explicit to clarify that the rest of them are optional. Signed-off-by: W. Trevor King <wking@tremily.us> Reviewed-by: Heiko Voigt <hvoigt@hvoigt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | Git 1.8.5.2v1.8.5.2Junio C Hamano2013-12-172-1/+22
| | | | | | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | Merge branch 'rs/doc-submitting-patches' into maintJunio C Hamano2013-12-171-2/+9
|\ \ \ | | | | | | | | | | | | | | | | * rs/doc-submitting-patches: SubmittingPatches: document how to handle multiple patches
| * | | SubmittingPatches: document how to handle multiple patchesrs/doc-submitting-patchesRené Scharfe2013-11-271-2/+9
| | | | | | | | | | | | | | | | | | | | Signed-off-by: Rene Scharfe <l.s.r@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | Merge branch 'tr/doc-git-cherry' into maintJunio C Hamano2013-12-171-33/+110
|\ \ \ \ | | | | | | | | | | | | | | | | | | | | * tr/doc-git-cherry: Documentation: revamp git-cherry(1)
| * | | | Documentation: revamp git-cherry(1)tr/doc-git-cherryThomas Rast2013-11-271-33/+110
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | git-cherry(1)'s "description" section has never really managed to explain to me what the command does. It contains too much explanation of the algorithm instead of simply saying what goals it achieves, and too much terminology that we otherwise do not use (fork-point instead of merge-base). Try a much more concise approach: state what it finds out, why this is neat, and how the output is formatted, in a few short paragraphs. In return, provide much longer examples of how it fits into a "format-patch | am" based workflow, and how it compares to reading the same from git-log. Also carefully avoid using "merge" in a context where it does not mean something that comes from git-merge(1). Instead, say "apply" in an attempt to further link to patch workflow concepts. While there, also omit the language about _which_ upstream branch we treat as the default. I literally just learned that we support having several, so let's not confuse new users here, especially considering that git-config(1) does not document this. Prompted-by: a.huemer@commend.com on #git Signed-off-by: Thomas Rast <tr@thomasrast.ch> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | Merge branch 'nd/glossary-content-pathspec-markup' into maintJunio C Hamano2013-12-171-3/+3
|\ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | * nd/glossary-content-pathspec-markup: glossary-content.txt: fix documentation of "**" patterns
| * | | | | glossary-content.txt: fix documentation of "**" patternsnd/glossary-content-pathspec-markupNguyễn Thái Ngọc Duy2013-11-211-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | "**" means bold in ASCIIDOC, so we need to escape it. This is similar to 8447dc8 (gitignore.txt: fix documentation of "**" patterns - 2013-11-07) Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | Merge branch 'jj/doc-markup-gitcli' into maintJunio C Hamano2013-12-171-5/+5
|\ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | * jj/doc-markup-gitcli: Documentation/gitcli.txt: fix double quotes
| * | | | | | Documentation/gitcli.txt: fix double quotesjj/doc-markup-gitcliJason St. John2013-11-201-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Replace double quotes around literal examples with backticks Signed-off-by: Jason St. John <jstjohn@purdue.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | Merge branch 'jj/doc-markup-hints-in-coding-guidelines' into maintJunio C Hamano2013-12-171-3/+31
|\ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * jj/doc-markup-hints-in-coding-guidelines: State correct usage of literal examples in man pages in the coding standards
| * | | | | | | State correct usage of literal examples in man pages in the coding standardsjj/doc-markup-hints-in-coding-guidelinesJason St. John2013-11-181-3/+31
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The man pages contain inconsistent usage of backticks vs. single quotes around options, commands, etc. that are in paragraphs. This commit states that backticks should always be used around literal examples. This commit states that "--" and friends should not be escaped (e.g. use `--pretty=oneline` instead of `\--pretty=oneline`). This commit also states correct usage for typesetting command usage examples with inline substitutions. Thanks-to: Ramkumar Ramachandra <artagnon@gmail.com> Thanks-to: Stuart Rackham <srackham@gmail.com> Thanks-to: Junio C Hamano <gitster@pobox.com> Signed-off-by: Jason St. John <jstjohn@purdue.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | | Merge branch 'jj/log-doc' into maintJunio C Hamano2013-12-171-26/+25
|\ \ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * jj/log-doc: Documentation/git-log.txt: mark-up fix and minor rephasing Documentation/git-log: update "--log-size" description
| * | | | | | | | Documentation/git-log.txt: mark-up fix and minor rephasingjj/log-docJason St. John2013-11-131-23/+23
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - typeset options, commands, and paths in monospace; - typeset references to sections with emphasis; - replace some double quotes with proper AsciiDoc quotes (e.g. ``foo''); - use title case when referring to section headings. Signed-off-by: Jason St. John <jstjohn@purdue.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * | | | | | | | Documentation/git-log: update "--log-size" descriptionJason St. John2013-11-131-5/+5
| |/ / / / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | "--log-size" was added in commit 9fa3465, and the commit message contained a satisfactory explanation; however, the man page entry for it did not describe the actual output format, what the output meant and what the option was meant to be used for. Helped-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Jason St. John <jstjohn@purdue.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | | Merge branch 'jj/rev-list-options-doc' into maintJunio C Hamano2013-12-171-156/+87
|\ \ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * jj/rev-list-options-doc: Documentation/rev-list-options.txt: fix some grammatical issues and typos Documentation/rev-list-options.txt: fix mark-up
| * | | | | | | | Documentation/rev-list-options.txt: fix some grammatical issues and typosjj/rev-list-options-docJason St. John2013-11-181-13/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Various fixes: - fix typos (e.g. "show" -> "shown") - use "regular expression(s)" instead of "regexp" where appropriate - reword some sentences for easier reading - fix/improve some grammatical issues (e.g. comma usage) - add missing articles (e.g. "the") - change "E-mail" to "email" Signed-off-by: Jason St. John <jstjohn@purdue.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * | | | | | | | Documentation/rev-list-options.txt: fix mark-upJason St. John2013-11-181-148/+78
| |/ / / / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Some the labeled list entries have a blank line between the label and the body text, and some don't. Use the latter style for consistency; incidentally, syntax highlighting in Vim works better if there is no blank line there. Typeset literal options, commands, and path names in monospace. When using `literal string` mark-up to do so, there is no need to escape AsciiDoc special characters with backslashes, so make sure we don't do so. Replace some double quotes with proper AsciiDoc quotes (e.g. ``foo''). Signed-off-by: Jason St. John <jstjohn@purdue.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | | Merge branch 'tb/doc-fetch-pack-url' into maintJunio C Hamano2013-12-171-8/+7
|\ \ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * tb/doc-fetch-pack-url: git-fetch-pack uses URLs like git-fetch
| * | | | | | | | git-fetch-pack uses URLs like git-fetchtb/doc-fetch-pack-urlTorsten Bögershausen2013-11-111-8/+7
| |/ / / / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | "git fetch-pack" allows [<host>:]<directory> to point out the source repository. Use the term <repository>, which is already used in "git fetch" or "git pull" to describe URLs supported by Git. Signed-off-by: Torsten Bögershausen <tboegi@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | | Merge branch 'mi/typofixes' into maintJunio C Hamano2013-12-171-2/+2
|\ \ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * mi/typofixes: contrib: typofixes Documentation/technical/http-protocol.txt: typofixes typofixes: fix misspelt comments
| * | | | | | | | Documentation/technical/http-protocol.txt: typofixesMasanari Iida2013-11-121-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Signed-off-by: Masanari Iida <standby24x7@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | | | Git 1.8.5.1v1.8.5.1Junio C Hamano2013-12-032-1/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | | | ref-iteration doc: add_submodule_odb() returns 0 for successNick Townsend2013-12-031-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The usage sample of add_submodule_odb() function in the Submodules section expects non-zero return value for success, but the function actually reports success with zero. Helped-by: René Scharfe <l.s.r@web.de> Reviewed-by: Heiko Voigt <hvoigt@hvoigt.net> Signed-off-by: Nick Townsend <nick.townsend@mac.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | | | Sync with 1.8.4.5Junio C Hamano2013-12-022-1/+15
|\ \ \ \ \ \ \ \ \
| * | | | | | | | | Git 1.8.4.5v1.8.4.5maint-1.8.4Junio C Hamano2013-12-022-1/+15
| | |_|/ / / / / / | |/| | | | | | | | | | | | | | | | | | | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | | | Git 1.8.5v1.8.5Junio C Hamano2013-11-271-0/+5
| |_|_|/ / / / / |/| | | | | | | | | | | | | | | | | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | | Sync with 1.8.4.4Junio C Hamano2013-11-202-1/+12
|\ \ \ \ \ \ \ \ | |/ / / / / / /
| * | | | | | | Git 1.8.4.4v1.8.4.4Junio C Hamano2013-11-202-1/+12
| | |/ / / / / | |/| | | | | | | | | | | | | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | RelNotes: spelling & grammar fixesmb/relnotes-1.8.5-fixMarc Branchaud2013-11-181-82/+84
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Signed-off-by: Marc Branchaud <marcnarc@xiplink.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | Correct word usage of "timezone" in "Documentation" directoryJason St. John2013-11-127-22/+22
| |/ / / / / |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | "timezone" is two words, not one (i.e. "time zone" is correct). Correct this in these files: -- date-formats.txt -- git-blame.txt -- git-cvsimport.txt -- git-fast-import.txt -- git-svn.txt -- gitweb.conf.txt -- rev-list-options.txt Signed-off-by: Jason St. John <jstjohn@purdue.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | Sync with 1.8.4.3Junio C Hamano2013-11-082-1/+20
|\ \ \ \ \ \ | |/ / / / /
| * | | | | Git 1.8.4.3v1.8.4.3Junio C Hamano2013-11-082-1/+20
| | | | | | | | | | | | | | | | | | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | Sync with maintJunio C Hamano2013-11-072-3/+39
|\ \ \ \ \ \ | |/ / / / / | | | | | | | | | | | | | | | | | | | | | | | | * maint: Start preparing for 1.8.4.3 gitignore.txt: fix documentation of "**" patterns
| * | | | | Start preparing for 1.8.4.3Junio C Hamano2013-11-071-0/+36
| | | | | | | | | | | | | | | | | | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
| * | | | | Merge branch 'sc/doc-howto-dumb-http' into maintJunio C Hamano2013-11-071-0/+4
| |\ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | An ancient How-To on serving Git repositories on an HTTP server lacked a warning that it has been mostly superseded with more modern way. * sc/doc-howto-dumb-http: doc/howto: warn about (dumb)http server document being too old
| * \ \ \ \ \ Merge branch 'vd/doc-unpack-objects' into maintJunio C Hamano2013-11-071-1/+1
| |\ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The synopsis section of "git unpack-objects" documentation has been clarified a bit. * vd/doc-unpack-objects: Documentation: "pack-file" is not literal in unpack-objects Documentation: restore a space in unpack-objects usage
| * | | | | | | gitignore.txt: fix documentation of "**" patternsKarsten Blees2013-11-071-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | "**" means bold in ASCIIDOC, so we need to escape it. Signed-off-by: Karsten Blees <blees@dcon.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | | | | | | Merge branch 'fc/trivial'Junio C Hamano2013-11-061-1/+3
|\ \ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A random collection of style fixes and minor doc updates. * fc/trivial: setup: trivial style fixes run-command: trivial style fixes diff: trivial style fix revision: trivial style fixes pretty: trivial style fix describe: trivial style fixes transport-helper: trivial style fix sha1-name: trivial style cleanup branch: trivial style fix revision: add missing include doc/pull: clarify the illustrations t: replace pulls with merges merge: simplify ff-only option