patman: Explain how to make doc/git-mailrc work
authorSimon Glass <sjg@chromium.org>
Sat, 4 Oct 2014 02:40:36 +0000 (20:40 -0600)
committerSimon Glass <sjg@chromium.org>
Fri, 30 Jan 2015 22:55:30 +0000 (15:55 -0700)
Add an explanation for how to set up git so that patman can find the alias
file. Fix up the get_maintainers message too.

Reported-by: Scott Wood <scottwood@freescale.com>
Signed-off-by: Simon Glass <sjg@chromium.org>
tools/patman/README

index e466886ed2428416824e40f8d0faa529248ff4e4..7d039e82bc2781bc6624bb423f5d8f4ef302232d 100644 (file)
@@ -52,12 +52,15 @@ will get a consistent result each time.
 How to configure it
 ===================
 
-For most cases of using patman for U-Boot development, patman will
-locate and use the file 'doc/git-mailrc' in your U-Boot directory.
-This contains most of the aliases you will need.
+For most cases of using patman for U-Boot development, patman can use the
+file 'doc/git-mailrc' in your U-Boot directory to supply the email aliases
+you need. To make this work, tell git where to find the file by typing
+this once:
 
-For Linux the 'scripts/get_maintainer.pl' handles figuring out where
-to send patches pretty well.
+    git config sendemail.aliasesfile doc/git-mailrc
+
+For both Linux and U-Boot the 'scripts/get_maintainer.pl' handles figuring
+out where to send patches pretty well.
 
 During the first run patman creates a config file for you by taking the default
 user name and email address from the global .gitconfig file.