[PATCH v2] Documentation: specify base point when generating MyFirstContribution patchset

From: Bagas Sanjaya <bagasdotme@gmail.com>
Date: Oct 15, 2021, 12:25 UTC
Message-ID: <20211015122515.47535-1-bagasdotme@gmail.com>

Specifying base point (commit hash) can help reviewers and testers interested on the patchset. Mention how to record it with `--base` option to `format-patch`.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Changes since v1 [1]:
     - Rewording (suggested by Junio).
     - Show command to determine base commit hash and pass it to `--base`
       option.

 [1]:
https://lore.kernel.org/git/f25fae40-0313-287b-5482-1c64cbe8cb64@gmail.com/T/#t

 Documentation/MyFirstContribution.txt | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index b20bc8e914..5aaf31cb66 100644
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -937,6 +937,23 @@ but want reviewers to look at what they have so far. You can add this flag with
 Check and make sure that your patches and cover letter template exist in the
 directory you specified - you're nearly ready to send out your review!
 
+It would help those who review and test your patches to specify on what
+commit the patches should be applied to. To do so, use the `--base` option
+when running `format-patch`. The option expects hash of the commit the
+patchset is based on. Since we base `psuh` on top of `master`, the base
+commit hash can be determined by: 
+
+----
+$ git show -s --format="%H" master
+----
+
+The output of command above can be passed to `--base` option. Replace `<base>`
+with your own hash:
+
+----
+$ git format-patch --cover-letter --base=<base> -o psuh/ master..psuh
+----
+
 [[cover-letter]]
 === Preparing Email
 

base-commit: 2bd2f258f4195ac54293a3f45b86457c0bd5fc11

-- 
An old man doll... just what I always wanted! - Clara