aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git-format-patch.txt
Commit message (Collapse)AuthorAge
* Support a --cc=<email> option in format-patchDaniel Barkalow2008-02-19
| | | | | | | | | | When you have particular reviewers you want to sent particular series to, it's nice to be able to generate the whole series with them as additional recipients, without configuring them into your general headers or adding them by hand afterwards. Signed-off-by: Daniel Barkalow <barkalow@iabervon.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Add a --cover-letter option to format-patchDaniel Barkalow2008-02-19
| | | | | | | | | | If --cover-letter is provided, generate a cover letter message before the patches, numbered 0. Original patch thanks to Johannes Schindelin Signed-off-by: Daniel Barkalow <barkalow@iabervon.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: rename gitlink macro to linkgitDan McGee2008-01-06
| | | | | | | | | | | | | | | | | | | | | | | | | | Between AsciiDoc 8.2.2 and 8.2.3, the following change was made to the stock Asciidoc configuration: @@ -149,7 +153,10 @@ # Inline macros. # Backslash prefix required for escape processing. # (?s) re flag for line spanning. -(?su)[\\]?(?P<name>\w(\w|-)*?):(?P<target>\S*?)(\[(?P<attrlist>.*?)\])= + +# Explicit so they can be nested. +(?su)[\\]?(?P<name>(http|https|ftp|file|mailto|callto|image|link)):(?P<target>\S*?)(\[(?P<attrlist>.*?)\])= + # Anchor: [[[id]]]. Bibliographic anchor. (?su)[\\]?\[\[\[(?P<attrlist>[\w][\w-]*?)\]\]\]=anchor3 # Anchor: [[id,xreflabel]] This default regex now matches explicit values, and unfortunately in this case gitlink was being matched by just 'link', causing the wrong inline macro template to be applied. By renaming the macro, we can avoid being matched by the wrong regex. Signed-off-by: Dan McGee <dpmcgee@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: customize diff-options depending on particular commandSergei Organov2007-11-15
| | | | | | | | | | | | | | | | | | | | | Customize diff-options depending on particular command as follows, mostly to make git-diff and git-format-patch manuals less confusing: * git-format-patch: - Mark --patch-with-stat as being the default. - Change -p description so that it matches what it actually does and so that it doesn't refer to absent "section on generating patches". * git-diff: mark -p as being the default. * git-diff-index/git-diff-files/git-diff-tree: mark --raw as being the default. Signed-off-by: Sergei Organov <osv@javad.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Rearrange git-format-patch synopsis to improve clarity.David Symonds2007-11-05
| | | | | Signed-off-by: David Symonds <dsymonds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* format-patch: Add configuration and off switch for --numberedBrian Gernhardt2007-11-04
| | | | | | | | | | | format.numbered is a tri-state variable. Boolean values enable or disable numbering by default and "auto" enables number when outputting more than one patch. --no-numbered (short: -N) will disable numbering. Signed-off-by: Brian Gernhardt <benji@silverinsanity.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* git-format-patch.txt: fix explanation of an example.Sergei Organov2007-11-01
| | | | | Signed-off-by: Sergei Organov <osv@javad.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* format-patch documentation: reword to hint "--root <one-commit>" more clearlyJunio C Hamano2007-08-28
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* "format-patch --root rev" is the way to show everything.Junio C Hamano2007-08-28
| | | | | | | | | | | | | | | | | | | We used to trigger the special case "things not in origin" semantics only when one and only one positive ref is given, and no number (e.g. "git format-patch -4 origin") was specified, and used the general revision range semantics for everything else. This narrows the special case a bit more, by making: git format-patch --root this_version to show everything that leads to the named commit. More importantly, document the two different semantics better. The generic revision range semantics came later and bolted on without being clearly documented. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: Correct various misspellings and typos.Brian Hetro2007-08-24
| | | | | | | Fix minor typos throughout the documentation. Signed-off-by: Brian Hetro <whee@smaertness.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Merge branch 'maint'Junio C Hamano2007-07-03
|\ | | | | | | | | | | | | | | * maint: Document -<n> for git-format-patch glossary: add 'reflog' diff --no-index: fix --name-status with added files Don't smash stack when $GIT_ALTERNATE_OBJECT_DIRECTORIES is too long
| * Document -<n> for git-format-patchMiklos Vajna2007-07-03
| | | | | | | | | | | | | | | | The -<n> option was not mentioned in git-format-patch's manpage till now. Fix this. Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | format-patch: Add format.subjectprefix config optionAdam Roben2007-07-02
| | | | | | | | | | | | | | | | This change lets you use the format.subjectprefix config option to override the default subject prefix. Signed-off-by: Adam Roben <aroben@apple.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | War on whitespaceJunio C Hamano2007-06-07
| | | | | | | | | | | | | | | | | | This uses "git-apply --whitespace=strip" to fix whitespace errors that have crept in to our source files over time. There are a few files that need to have trailing whitespaces (most notably, test vectors). The results still passes the test, and build result in Documentation/ area is unchanged. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Add the --numbered-files option to git-format-patch.Jon Loeliger2007-06-06
|/ | | | | | | | | | | | With this option, git-format-patch will generate simple numbered files as output instead of the default using with the first commit line appended. This simplifies the ability to generate an MH-style drafts folder with each message to be sent. Signed-off-by: Jon Loeliger <jdl@freescale.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Add custom subject prefix support to format-patch (take 3)Robin H. Johnson2007-04-11
| | | | | | | | | | | Add a new option to git-format-patch, entitled --subject-prefix that allows control of the subject prefix '[PATCH]'. Using this option, the text 'PATCH' is replaced with whatever input is provided to the option. This allows easily generating patches like '[PATCH 2.6.21-rc3]' or properly numbered series like '[-mm3 PATCH N/M]'. This patch provides the implementation and documentation. Signed-off-by: Robin H. Johnson <robbat2@gentoo.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Merge branch 'js/attach'Junio C Hamano2007-03-10
|\ | | | | | | | | | | * js/attach: format-patch --attach: not folding some long headers. format-patch: add --inline option and make --attach a true attachment
| * format-patch: add --inline option and make --attach a true attachmentJohannes Schindelin2007-03-04
| | | | | | | | | | | | | | | | | | | | | | | | The existing --attach option did not create a true "attachment" but multipart/mixed with Content-Disposition: inline. It should have been with Content-Disposition: attachment. Introduce --inline to add multipart/mixed that is inlined, and make --attach to create an attachement. Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Fix diff-options references in git-diff and git-format-patchBrian Gernhardt2007-03-05
|/ | | | | | | | | | | | Most of the git-diff-* documentation used [<common diff options>] instead of [--diff-options], so make that change in git-diff and git-format-patch. In addition, git-format-patch didn't include the meanings of the diff options. Signed-off-by: Brian Gernhardt <benji@silverinsanity.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Document --ignore-if-in-upstream in git-format-patchDavid Kågedal2007-01-18
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* git-format-patch: the default suffix is now .patch, not .txtJunio C Hamano2007-01-17
| | | | | | | Editors often give easier handling of patch files if the filename ends with .patch, so use it instead of .txt. Signed-off-by: Junio C Hamano <junkio@cox.net>
* git-format-patch -3Junio C Hamano2007-01-17
| | | | | | | | | | This teaches "git-format-patch" to honor the --max-count parameter revision traversal machinery takes, so that you can say "git-format-patch -3" to process the three topmost commits from the current HEAD (or "git-format-patch -2 topic" to name a specific branch). Signed-off-by: Junio C Hamano <junkio@cox.net>
* Refer users to git-rev-parse for revision specification syntax.Shawn O. Pearce2007-01-17
| | | | | | | | | | The revision specification syntax (sometimes referred to as SHA1-expressions) is accepted almost everywhere in Git by almost every tool. Unfortunately it is only documented in git-rev-parse.txt, and most users don't know to look there. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Introduce 'git-format-patch --suffix=.patch'Junio C Hamano2007-01-17
| | | | | | | The default can also be changed with "format.suffix" configuration. Leaving it empty would not add any suffix. Signed-off-by: Junio C Hamano <junkio@cox.net>
* Add option to set initial In-Reply-To/ReferencesJosh Triplett2006-07-14
| | | | | | | | | Add the --in-reply-to option to provide a Message-Id for an initial In-Reply-To/References header, useful for including a new patch series as part of an existing thread. Signed-off-by: Josh Triplett <josh@freedesktop.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Add option to enable threading headersJosh Triplett2006-07-14
| | | | | | | | | Add a --thread option to enable generation of In-Reply-To and References headers, used to make the second and subsequent mails appear as replies to the first. Signed-off-by: Josh Triplett <josh@freedesktop.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* git-format-patch: add --output-directory long option againJunio C Hamano2006-06-06
| | | | | | | | | | | | | | Additionally notices and complains to an -o option without directory or a duplicated -o option, -o and --stdout given together. Also delays the creation of directory until all arguments are parsed, so that the command does not leave an empty directory behind when it exits after seeing an unrelated invalid option. [jc: originally from Dennis Stosberg but with minor fixes, and documentation updates from Dennis.] Signed-off-by: Junio C Hamano <junkio@cox.net>
* Update documentation for git-format-patchDennis Stosberg2006-06-02
| | | | | | | [jc: adjusted for recently resurrected features] Signed-off-by: Dennis Stosberg <dennis@stosberg.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Describe how to add extra mail header lines in mail generated by ↵Mike McCormack2006-03-09
| | | | git-format-patch.
* Document the --attach flag.Mike McCormack2006-03-09
|
* Remove trailing dot after short descriptionFredrik Kuivinen2006-03-09
| | | | | Signed-off-by: Fredrik Kuivinen <freku045@student.liu.se> Signed-off-by: Junio C Hamano <junkio@cox.net>
* format-patch: Remove last vestiges of --mbox optionAndreas Ericsson2006-02-07
| | | | | | | | | | | | Don't mention it in docs or --help output. Remove mbox, date and author variables from git-format-patch.sh. Use DESCRIPTION text from man-page to update LONG_USAGE output. It's a bit silly to have two texts saying the same thing in different words, and I'm too lazy to update both. Signed-off-by: Andreas Ericsson <ae@op5.se> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Wrap synopsis lines and use [verse] to keep formattingJonas Fonseca2006-01-05
| | | | | | | In addition, also fixes a few synopses to be more consistent and a gitlink. Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation: diff examples.Junio C Hamano2005-12-13
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation/git-format-patch.txt: Add --signoff, --check, and long ↵Nikolai Weibull2005-12-08
| | | | | | | | | | | | option-names. The documentation was lacking descriptions for the --signoff and --check options to git-format-patch. It was also missing the following long option-names: --output-directory (-o), --numbered (-n), --keep-subject (-k), --author (-a), --date (-d), and --mbox (-m). Signed-off-by: Nikolai Weibull <nikolai@bitwi.se> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation: format-patchJunio C Hamano2005-11-05
| | | | | | | Add examples section and talk about using this to cherry-pick commits. Signed-off-by: Junio C Hamano <junkio@cox.net>
* Describe new options to git-format-patch and git-mailsplit.Junio C Hamano2005-10-06
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* [PATCH] Documentation: Update all files to use the new gitlink: macroSergey Vlasov2005-09-20
| | | | | | | | | | | | The replacement was performed automatically by these commands: perl -pi -e 's/link:(git.+)\.html\[\1\]/gitlink:$1\[1\]/g' \ README Documentation/*.txt perl -pi -e 's/link:git\.html\[git\]/gitlink:git\[7\]/g' \ README Documentation/*.txt Signed-off-by: Sergey Vlasov <vsu@altlinux.ru> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation updates.Junio C Hamano2005-09-07
| | | | | | Fill in more missing documentation. Signed-off-by: Junio C Hamano <junkio@cox.net>
* Big tool rename.Junio C Hamano2005-09-07
As promised, this is the "big tool rename" patch. The primary differences since 0.99.6 are: (1) git-*-script are no more. The commands installed do not have any such suffix so users do not have to remember if something is implemented as a shell script or not. (2) Many command names with 'cache' in them are renamed with 'index' if that is what they mean. There are backward compatibility symblic links so that you and Porcelains can keep using the old names, but the backward compatibility support is expected to be removed in the near future. Signed-off-by: Junio C Hamano <junkio@cox.net>