Merge branch 'bc/submitting-patches-in-asciidoc'
authorJunio C Hamano <gitster@pobox.com>
Tue, 9 Jan 2018 22:32:54 +0000 (14:32 -0800)
committerJunio C Hamano <gitster@pobox.com>
Tue, 9 Jan 2018 22:32:54 +0000 (14:32 -0800)
Doc readability update.

* bc/submitting-patches-in-asciidoc:
doc/SubmittingPatches: improve text formatting

1  2 
Documentation/SubmittingPatches
index 3ef30922ecdce94c84c5e9df33f6696622ab4844,b5d4bdde91ad7843982f1ff1763e0e6eee1db95b..a1d0feca36fea36b84b587c1387eab53e3b870c6
@@@ -203,15 -203,14 +203,15 @@@ lose tabs that way if you are not caref
  
  It is a common convention to prefix your subject line with
  [PATCH].  This lets people easily distinguish patches from other
 -e-mail discussions.  Use of additional markers after PATCH and
 -the closing bracket to mark the nature of the patch is also
 -encouraged.  E.g. [PATCH/RFC] is often used when the patch is
 -not ready to be applied but it is for discussion, [PATCH v2],
 -[PATCH v3] etc. are often seen when you are sending an update to
 -what you have previously sent.
 -
 -`git format-patch` command follows the best current practice to
 +e-mail discussions.  Use of markers in addition to PATCH within
 +the brackets to describe the nature of the patch is also
 +encouraged.  E.g. [RFC PATCH] (where RFC stands for "request for
 +comments") is often used to indicate a patch needs further
 +discussion before being accepted, [PATCH v2], [PATCH v3] etc.
 +are often seen when you are sending an update to what you have
 +previously sent.
 +
 +The `git format-patch` command follows the best current practice to
  format the body of an e-mail message.  At the beginning of the
  patch should come your commit message, ending with the
  Signed-off-by: lines, and a line that consists of three dashes,
@@@ -219,10 -218,6 +219,10 @@@ followed by the diffstat information an
  you are forwarding a patch from somebody else, optionally, at
  the beginning of the e-mail message just before the commit
  message starts, you can put a "From: " line to name that person.
 +To change the default "[PATCH]" in the subject to "[<text>]", use
 +`git format-patch --subject-prefix=<text>`.  As a shortcut, you
 +can use `--rfc` instead of `--subject-prefix="RFC PATCH"`, or
 +`-v <n>` instead of `--subject-prefix="PATCH v<n>"`.
  
  You often want to add additional explanation about the patch,
  other than the commit message itself.  Place such "cover letter"
@@@ -261,7 -256,7 +261,7 @@@ not a text/plain, it's something else
  
  Send your patch with "To:" set to the mailing list, with "cc:" listing
  people who are involved in the area you are touching (the output from
+git blame _$path_+ and +git shortlog {litdd}no-merges _$path_+ would help to
`git blame $path` and `git shortlog --no-merges $path` would help to
  identify them), to solicit comments and reviews.
  
  :1: footnote:[The current maintainer: gitster@pobox.com]