Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 124 lines (94 sloc) 4.579 kb
69d6f1e Added README.SUBMITTING_PATCH file. Please fix/add/change.
Yasuo Ohgaki authored
1 Submitting Patch for PHP
2 ========================
3
4 This document describes how to submit a patch for PHP. Since you are
5 reading this document, you are willing to submit a patch for PHP.
0459ad7 some typo fixing, and following The Little Book, omitting needless words
Sascha Schumann authored
6 Please keep reading! Submitting a patch for PHP is easy. The hard
7 part is making it acceptable for inclusion into our repository. :-)
69d6f1e Added README.SUBMITTING_PATCH file. Please fix/add/change.
Yasuo Ohgaki authored
8
9 How to create patch?
10 --------------------
11 We are working with CVS. You need to get CVS source to create a patch
12 that we accept. Visit http://www.php.net/anoncvs.php to get CVS
13 source. You can check out older versions, but make sure you get
14 the default branch (i.e. Do not use -r option when you check out the
15 CVS source)
16
17 Read CODING_STANDARDS file before you start working.
18
19 Now you are ready to create a patch. Modify source to fix a bug in PHP or
20 add a new feature to PHP. After you finished editing, please test your
21 patch. Read README.TESTING for testing.
22
23 After you finish testing your patch, take diff file using
24 "cvs diff > your.patch" command.
25
26 Read README.TESTING for submitting a test script for your patch. This is
27 not strictly required, but it is preferred to submit a test script along
28 with your patch. Making new test script is very easy. It also helps us
29 to understand what you have been fixed or added to PHP.
30
31
32 Tips for creating patch
33 -----------------------
34 If you would like to fix multiple bugs. It is easier for us if you
35 could create 1 patch for 1 bug, but this is not strictly required.
0459ad7 some typo fixing, and following The Little Book, omitting needless words
Sascha Schumann authored
36 Note though that you might get little response, if your patch is
37 too hard to review.
69d6f1e Added README.SUBMITTING_PATCH file. Please fix/add/change.
Yasuo Ohgaki authored
38
39 If you would like change/add many lines, it is better to ask module
40 maintainer and/or php-dev@lists.php.net, or pear-dev@lists.php.net if
41 you are patching PEAR. Official module maintainers can be found in
42 EXTENSIONS file in PHP source.
43
44 If you are new to CVS (Concurrent Versions System), visit
45 http://cvshome.org/ for details.
46
47
48 Recommended CVS client settings for creating patch file
49 ------------------------------------------------------
50 Recommended ~/.cvsrc file setting is:
51 ------
52 cvs -z3
53 update -d -P
54 checkout -P
55 diff -u -b -w -B
56 ------
57 diff -u -b -w -B means:
58 -b Ignore changes in amount of white space.
59 -B Ignore changes that just insert or delete blank lines.
60 -u Use the unified output format.
61 -w Ignore white space when comparing lines.
62
63 With this CVS setting, you don't have to worry about adding/deleting
64 newlines and spaces.
65
66
67 Check list for submitting patch
68 -------------------------------
69 - Did you run "make test" to check if your patch didn't break
70 other features?
71 - Did you compile PHP with --enable-debug and check php/webserver
72 error logs when you test your patch?
73 - Did you build PHP for multi-threaded web servers. (Optional)
74 - Did you create test script for "make test"? (Recommended)
75 - Did you check your patch is unified format and it does not
76 contain white space changes? (If you are not using recommended
77 cvs setting)
78 - Did you update CVS source before you take final patch?
79 - Did you read the patch again?
80
81
82 Where to send your patch?
83 -------------------------
84 If you are patching C source, send the patch to php-dev@lists.php.net.
85 If you are patching a module, you should also send the patch to the
86 maintainer. Official module maintainers are listed in EXTENSION file
87 in source.
88
0459ad7 some typo fixing, and following The Little Book, omitting needless words
Sascha Schumann authored
89 If you are patching PEAR, send the patch to pear-dev@lists.php.net.
69d6f1e Added README.SUBMITTING_PATCH file. Please fix/add/change.
Yasuo Ohgaki authored
90
0459ad7 some typo fixing, and following The Little Book, omitting needless words
Sascha Schumann authored
91 Please add the prefix "[PATCH]" to your email subject and make sure
92 to include the patch as a MIME attachment even if it is short.
93 Test scripts should be included in the same email.
94 Explain what has been fixed/added/changed by your patch.
69d6f1e Added README.SUBMITTING_PATCH file. Please fix/add/change.
Yasuo Ohgaki authored
95
0459ad7 some typo fixing, and following The Little Book, omitting needless words
Sascha Schumann authored
96 Finally, add the bug Id(s) which can be closed by your patch, if any.
69d6f1e Added README.SUBMITTING_PATCH file. Please fix/add/change.
Yasuo Ohgaki authored
97
98
0459ad7 some typo fixing, and following The Little Book, omitting needless words
Sascha Schumann authored
99 What happens after you submit your patch
69d6f1e Added README.SUBMITTING_PATCH file. Please fix/add/change.
Yasuo Ohgaki authored
100 --------------------------------------
0459ad7 some typo fixing, and following The Little Book, omitting needless words
Sascha Schumann authored
101 If your patch is easy to review and has obviously no side-effects,
102 it might take up to a few hours until someone commits it.
103
104 Because this is a volunteer-driven effort, more complex patches will
105 require more patience on your side.
106
107 If you did not receive any feedback in a few days, please consider
108 resubmitting the description of your patch, along-side with
109 these questions:
110
111 - Is my patch too hard to review? Because of which factors?
112 - Should I split it up in multiple parts?
113 - Are there any unwanted whitespace changes?
69d6f1e Added README.SUBMITTING_PATCH file. Please fix/add/change.
Yasuo Ohgaki authored
114
115
116 What happens when your patch is applied?
117 ----------------------------------------
0459ad7 some typo fixing, and following The Little Book, omitting needless words
Sascha Schumann authored
118 Your name will be included together with your email address in the CVS
119 commit log. If your patch affects end-users, a brief description
120 and your name might be added to the NEWS file.
69d6f1e Added README.SUBMITTING_PATCH file. Please fix/add/change.
Yasuo Ohgaki authored
121
122
123 Thank you for submitting patch for PHP!
Something went wrong with that request. Please try again.