From: Stephen Boyd <bebarino@gmail.com>
To: Michael J Gruber <git@drmicha.warpmail.net>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: [PATCHv2 5/8] git-format-patch.txt: general rewordings and cleanups
Date: Thu, 23 Apr 2009 09:16:52 -0700 [thread overview]
Message-ID: <1240503412-6790-1-git-send-email-bebarino@gmail.com> (raw)
In-Reply-To: <49F05B90.8050208@drmicha.warpmail.net>
Clarify --no-binary description using some words from the original
commit 37c22a4b (add --no-binary, 2008-05-9). Cleanup --suffix
description. Add --thread style option to synopsis and reorganize it a
bit. Clarify renaming patches example and the configuration paragraph.
Signed-off-by: Stephen Boyd <bebarino@gmail.com>
---
Fix some issues brought up by Michael J Gruber
Documentation/git-format-patch.txt | 38 ++++++++++++++++++------------------
1 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 4a43c64..6f1fc80 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -9,10 +9,10 @@ git-format-patch - Prepare patches for e-mail submission
SYNOPSIS
--------
[verse]
-'git format-patch' [-k] [-o <dir> | --stdout] [--thread]
- [--attach[=<boundary>] | --inline[=<boundary>] |
- [--no-attach]]
- [-s | --signoff] [<common diff options>]
+'git format-patch' [-k] [(-o|--output-directory) <dir> | --stdout]
+ [--thread[=<style>]]
+ [(--attach|--inline)[=<boundary>] | --no-attach]
+ [-s | --signoff]
[-n | --numbered | -N | --no-numbered]
[--start-number <n>] [--numbered-files]
[--in-reply-to=Message-Id] [--suffix=.<sfx>]
@@ -20,6 +20,7 @@ SYNOPSIS
[--subject-prefix=Subject-Prefix]
[--cc=<email>]
[--cover-letter]
+ [<common diff options>]
[ <since> | <revision range> ]
DESCRIPTION
@@ -170,18 +171,17 @@ if that is not set.
--suffix=.<sfx>::
Instead of using `.patch` as the suffix for generated
filenames, use specified suffix. A common alternative is
- `--suffix=.txt`.
+ `--suffix=.txt`. Leaving this empty will remove the `.patch`
+ suffix.
+
-Note that you would need to include the leading dot `.` if you
-want a filename like `0001-description-of-my-change.patch`, and
-the first letter does not have to be a dot. Leaving it empty would
-not add any suffix.
+Note that the leading character does not have to be a dot; for example,
+you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`.
--no-binary::
- Don't output contents of changes in binary files, just take note
- that they differ. Note that this disable the patch to be properly
- applied. By default the contents of changes in those files are
- encoded in the patch.
+ Do not output contents of changes in binary files, instead
+ display a notice that those files changed. Patches generated
+ using this option cannot be applied properly, but they are
+ still useful for code review.
--root::
Treat the revision argument as a <revision range>, even if it
@@ -192,10 +192,10 @@ not add any suffix.
CONFIGURATION
-------------
-You can specify extra mail header lines to be added to each message
-in the repository configuration, new defaults for the subject prefix
-and file suffix, control attachments, and number patches when outputting
-more than one.
+You can specify extra mail header lines to be added to each message,
+defaults for the subject prefix and file suffix, number patches when
+outputting more than one patch, add "Cc:" headers, configure attachments,
+and sign off patches with configuration variables.
------------
[format]
@@ -243,8 +243,8 @@ $ git format-patch -M -B origin
+
Additionally, it detects and handles renames and complete rewrites
intelligently to produce a renaming patch. A renaming patch reduces
-the amount of text output, and generally makes it easier to review it.
-Note that the "patch" program does not understand renaming patches, so
+the amount of text output, and generally makes it easier to review.
+Note that non-git "patch" programs won't understand renaming patches, so
use it only when you know the recipient uses git to apply your patch.
* Extract three topmost commits from the current branch and format them
--
1.6.2.3
next prev parent reply other threads:[~2009-04-23 16:18 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-04-23 9:37 [PATCH 0/8] Doc updates to config, format-patch, show-branch Stephen Boyd
2009-04-23 9:37 ` [PATCH 1/8] config.txt: remove pointer to SubmittingPatches Stephen Boyd
2009-04-23 9:37 ` [PATCH 2/8] config.txt: add missing format.{subjectprefix,cc,attach} variables Stephen Boyd
2009-04-23 9:37 ` [PATCH 3/8] Documentation: use lowercase for shallow and deep threading Stephen Boyd
2009-04-23 9:37 ` [PATCH 4/8] git-show-branch.txt: cleanup example description Stephen Boyd
2009-04-23 9:37 ` [PATCH 5/8] git-format-patch.txt: general rewordings and cleanups Stephen Boyd
2009-04-23 9:38 ` [PATCH 6/8] config.txt: add missing 'the's and make words plural Stephen Boyd
2009-04-23 9:38 ` [PATCH 7/8] config.txt: clarify sentences in the configuration and syntax sections Stephen Boyd
2009-04-23 9:38 ` [PATCH 8/8] config.txt: Make configuration paragraph more consistent Stephen Boyd
2009-04-23 12:14 ` [PATCH 5/8] git-format-patch.txt: general rewordings and cleanups Michael J Gruber
2009-04-23 16:16 ` Stephen Boyd [this message]
2009-04-24 16:18 ` [PATCHv2 " Junio C Hamano
2009-04-23 12:05 ` [PATCH 1/8] config.txt: remove pointer to SubmittingPatches Michael J Gruber
2009-04-23 16:03 ` Stephen Boyd
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1240503412-6790-1-git-send-email-bebarino@gmail.com \
--to=bebarino@gmail.com \
--cc=git@drmicha.warpmail.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).