| blob | 658aa76b592c13379584a2b9953eedf32438308d |
1 // This file is part of the Doxygen Developer Manual
2 /** @page patchguide Patch Guidelines
4 @b NB! If you're behind a corporate wall with http only access to the
5 world, you can still use these instructions!
7 @b NB2! You can't send patches to the mailing list anymore at all. Nowadays
8 you are expected to send patches to the OpenOCD Gerrit GIT server for a
9 review.
11 @section gerrit Submitting patches to the OpenOCD Gerrit server
13 OpenOCD is to some extent a "self service" open source project, so to
14 contribute, you must follow the standard procedures to have the best
15 possible chance to get your changes accepted.
17 The procedure to create a patch is essentially:
19 - make the changes
20 - create a commit
21 - send the changes to the Gerrit server for review
22 - correct the patch and re-send it according to review feedback
24 Your patch (or commit) should be a "good patch": focus it on a single
25 issue, and make it be easily reviewable. Don't make
26 it so large that it's hard to review; split large
27 patches into smaller ones. (That can also help
28 track down bugs later on.) All patches should
29 be "clean", which includes preserving the existing
30 coding style and updating documentation as needed.
32 Say in the commit message if it's a bugfix (describe the bug) or a new
33 feature. Don't expect patches to merge immediately
34 for the next release. Be ready to rework patches
35 in response to feedback.
37 Add yourself to the GPL copyright for non-trivial changes.
39 @section stepbystep Step by step procedure
41 -# Create a Gerrit account at: http://openocd.zylin.com
42 - On subsequent sign ins, use the full URL prefaced with 'http://'
43 For example: http://user_identifier.open_id_provider.com
44 -# Add a username to your profile.
45 After creating the Gerrit account and signing in, you will need to
46 add a username to your profile. To do this, go to 'Settings', and
47 add a username of your choice.
48 Your username will be required in step 3 and substituted wherever
49 the string 'USERNAME' is found.
50 -# Add an SSH public key following the directions on github:
51 https://help.github.com/articles/generating-ssh-keys
52 -# Clone the git repository, rather than just download the source:
53 @code
54 git clone git://git.code.sf.net/p/openocd/code openocd
55 @endcode
56 or if you have problems with the "git:" protocol, use
57 the slower http protocol:
58 @code
59 git clone http://git.code.sf.net/p/openocd/code openocd
60 @endcode
61 -# Set up Gerrit with your local repository. All this does it
62 to instruct git locally how to send off the changes.
63 -# Add a new remote to git using Gerrit username:
64 @code
65 git remote add review ssh://USERNAME@openocd.zylin.com:29418/openocd.git
66 git config remote.review.push HEAD:refs/publish/master
67 @endcode
68 Or with http only:
69 @code
70 git remote add review http://openocd.zylin.com/p/openocd.git
71 git config remote.review.push HEAD:refs/publish/master
72 @endcode
73 -# You will need to install this hook, we will look into a better solution:
74 @code
75 scp -p -P 29418 USERNAME@openocd.zylin.com:hooks/commit-msg .git/hooks/
76 @endcode
77 Or with http only:
78 @code
79 wget http://openocd.zylin.com/tools/hooks/commit-msg
80 mv commit-msg .git/hooks
81 chmod +x .git/hooks/commit-msg
82 @endcode
83 @b NOTE A script exists to simplify the two items above. execute:
84 @code
85 tools/initial.sh <username>
86 @endcode
87 With @<username@> being your Gerrit username.
88 -# Set up git with your name and email:
89 @code
90 git config --global user.name "John Smith"
91 git config --global user.email "john@smith.org"
92 @endcode
93 -# Work on your patches. Split the work into
94 multiple small patches that can be reviewed and
95 applied seperately and safely to the OpenOCD
96 repository.
97 @code
98 while(!done) {
99 work - edit files using your favorite editor.
100 run "git commit -s -a" to commit all changes.
101 run tools/checkpatch.sh to verify your patch style is ok.
102 }
103 @endcode
104 @b TIP! use "git add ." before commit to add new files.
105 @code
106 --- example comment, notice the short first line w/topic ---
107 topic: short comment
108 <blank line>
109 longer comments over several
110 lines...
111 <blank line>
112 Signed-off-by: ...
113 -----
114 @endcode
115 -# Next you need to make sure that your patches
116 are on top of the latest stuff on the server and
117 that there are no conflicts:
118 @code
119 git pull --rebase origin master
120 @endcode
121 -# Send the patches to the Gerrit server for review:
122 @code
123 git push review
124 @endcode
125 -# Forgot something, want to add more? Just make the changes and do:
126 @code
127 git commit --amend
128 git push review
129 @endcode
131 Further reading: http://www.coreboot.org/Git
133 @section timeline When can I expect my contribution to be committed?
135 The code review is intended to take as long as a week or two to allow
136 maintainers and contributors who work on OpenOCD only in their spare
137 time oportunity to perform a review and raise objections.
139 With Gerrit much of the urgency of getting things committed has been
140 removed as the work in progress is safely stored in Gerrit and
141 available if someone needs to build on your work before it is
142 submitted to the official repository.
144 Another factor that contributes to the desire for longer cool-off
145 times (the time a patch lies around without any further changes or
146 comments), it means that the chances of quality regression on the
147 master branch will be much reduced.
149 If a contributor pushes a patch, it is considered good form if another
150 contributor actually approves and submits that patch.
152 @section browsing Browsing Patches
153 All OpenOCD patches can be reviewed <a href="http://openocd.zylin.com/">here</a>.
154 */
155 /** @file
156 This file contains the @ref patchguide page.
157 */