summaryrefslogtreecommitdiffstats
path: root/git-format-patch.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2024-05-01 10:58:22 -0700
committerJunio C Hamano <gitster@pobox.com>2024-05-01 10:58:22 -0700
commit7af7f87d1682bc0221ef8ef496126c204d35760d (patch)
tree78a7acd5d4f7a8b7db6b1f44bcb506f7bb5feefb /git-format-patch.txt
parenta181e55f63bee8d3a44fd0be402039db41158169 (diff)
downloadgit-htmldocs-7af7f87d1682bc0221ef8ef496126c204d35760d.tar.gz
Autogenerated HTML docs for v2.45.0-31-gd4cc1
Diffstat (limited to 'git-format-patch.txt')
-rw-r--r--git-format-patch.txt21
1 files changed, 16 insertions, 5 deletions
diff --git a/git-format-patch.txt b/git-format-patch.txt
index 728bb3821..369af2c4a 100644
--- a/git-format-patch.txt
+++ b/git-format-patch.txt
@@ -20,7 +20,7 @@ SYNOPSIS
[--in-reply-to=<message-id>] [--suffix=.<sfx>]
[--ignore-if-in-upstream] [--always]
[--cover-from-description=<mode>]
- [--rfc] [--subject-prefix=<subject-prefix>]
+ [--rfc[=<rfc>]] [--subject-prefix=<subject-prefix>]
[(--reroll-count|-v) <n>]
[--to=<email>] [--cc=<email>]
[--[no-]cover-letter] [--quiet]
@@ -238,10 +238,21 @@ the patches (with a value of e.g. "PATCH my-project").
value of the `format.filenameMaxLength` configuration
variable, or 64 if unconfigured.
---rfc::
- Prepends "RFC" to the subject prefix (producing "RFC PATCH" by
- default). RFC means "Request For Comments"; use this when sending
- an experimental patch for discussion rather than application.
+--rfc[=<rfc>]::
+ Prepends the string _<rfc>_ (defaults to "RFC") to
+ the subject prefix. As the subject prefix defaults to
+ "PATCH", you'll get "RFC PATCH" by default.
++
+RFC means "Request For Comments"; use this when sending
+an experimental patch for discussion rather than application.
+"--rfc=WIP" may also be a useful way to indicate that a patch
+is not complete yet ("WIP" stands for "Work In Progress").
++
+If the convention of the receiving community for a particular extra
+string is to have it _after_ the subject prefix, the string _<rfc>_
+can be prefixed with a dash ("`-`") to signal that the the rest of
+the _<rfc>_ string should be appended to the subject prefix instead,
+e.g., `--rfc='-(WIP)'` results in "PATCH (WIP)".
-v <n>::
--reroll-count=<n>::