Clarify the preferred way of creating patch files
authorMatt Caswell <matt@openssl.org>
Sun, 1 Nov 2015 14:41:29 +0000 (14:41 +0000)
committerMatt Caswell <matt@openssl.org>
Mon, 2 Nov 2015 14:33:51 +0000 (14:33 +0000)
Clarify that git format-patch output is preferred for creating patch files.

Reviewed-by: Richard Levitte <levitte@openssl.org>
(cherry picked from commit f89ee71bc81017e04ac50f570d8aed87f495bcf2)

CONTRIBUTING

index 1d46f7b..9d63d8a 100644 (file)
@@ -22,8 +22,14 @@ current Git or the last snapshot. They should follow our coding style
 warnings using the --strict-warnings flag.  OpenSSL compiles on many varied
 platforms: try to ensure you only use portable features.
 
-Our preferred format for changes is "diff -u" output. One method is to use
-"git diff"  Another is to generate it something like this:
+Our preferred format for patch files is "git format-patch" output. For example
+to provide a patch file containing the last commit in your local git repository
+use the following command:
+
+# git format-patch --stdout HEAD^ >mydiffs.patch
+
+Another method of creating an acceptable patch file without using git is as
+follows:
 
 # cd openssl-work
 # [your changes]