summaryrefslogtreecommitdiff
path: root/CONTRIBUTING
diff options
context:
space:
mode:
authorMatt Caswell <matt@openssl.org>2015-11-01 14:41:29 +0000
committerMatt Caswell <matt@openssl.org>2015-11-02 14:32:16 +0000
commitf89ee71bc81017e04ac50f570d8aed87f495bcf2 (patch)
treed8864cf1269461ce6ee97624c9ae740126ba850e /CONTRIBUTING
parent1c2e5d560d5143d8fc1cf7e6b598199201e60a45 (diff)
downloadopenssl-new-f89ee71bc81017e04ac50f570d8aed87f495bcf2.tar.gz
Clarify the preferred way of creating patch files
Clarify that git format-patch output is preferred for creating patch files. Reviewed-by: Richard Levitte <levitte@openssl.org>
Diffstat (limited to 'CONTRIBUTING')
-rw-r--r--CONTRIBUTING10
1 files changed, 8 insertions, 2 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING
index 1d46f7bbaa..9d63d8abb6 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -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]