doxygen: remove warnings
[openocd.git] / HACKING
1 // This file is part of the Doxygen Developer Manual
2 /** @page patchguide Patch Guidelines
3
4 @b NB! If you're behind a corporate wall with http only access to the
5 world, you can still use these instructions!
6
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.
10
11 @section gerrit Submitting patches to the OpenOCD Gerrit server
12
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.
16
17 The procedure to create a patch is essentially:
18
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
23
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.
31
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.
36
37 Add yourself to the GPL copyright for non-trivial changes.
38
39 @section stepbystep Step by step procedure
40
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 for your specific platform:
51      - for Windows: http://help.github.com/win-set-up-git/#_set_up_ssh_keys
52      - for OSX: http://help.github.com/mac-set-up-git/#_set_up_ssh_keys
53      - for Linux: http://help.github.com/linux-set-up-git/#_set_up_ssh_keys<br>
54      .
55      While these pages describe the setting up of git as well,
56      you should scroll down the page till you get to the section:
57      <i>Next: Set Up SSH Keys</i>, and follow the steps described.
58 -# Clone the git repository, rather than just download the source:
59  @code
60  git clone git://openocd.git.sourceforge.net/gitroot/openocd/openocd
61  @endcode
62    or if you have problems with the "git:" protocol, use
63    the slower http protocol:
64  @code
65  git clone http://repo.or.cz/r/openocd.git
66  @endcode
67 -# Set up Gerrit with your local repository. All this does it
68 to instruct git locally how to send off the changes.
69   -# Add a new remote to git using Gerrit username:
70 @code
71 git remote add review ssh://USERNAME@openocd.zylin.com:29418/openocd.git
72 git config remote.review.push HEAD:refs/for/master
73 @endcode
74   Or with http only:
75 @code
76 git remote add review http://openocd.zylin.com/p/openocd.git
77 git config remote.review.push HEAD:refs/for/master
78 @endcode
79   -# You will need to install this hook, we will look into a better solution:
80 @code
81 scp -p -P 29418 USERNAME@openocd.zylin.com:hooks/commit-msg .git/hooks/
82 @endcode
83   Or with http only:
84 @code
85 wget http://openocd.zylin.com/tools/hooks/commit-msg
86 mv commit-msg .git/hooks
87 chmod +x .git/hooks/commit-msg
88 @endcode
89 @b NOTE A script exists to simplify the two items above. execute:
90 @code
91 tools/initial.sh <username>
92 @endcode
93 With @<username@> being your Gerrit username.
94 -# Set up git with your name and email:
95 @code
96 git config --global user.name "John Smith"
97 git config --global user.email "john@smith.org"
98 @endcode
99 -# Work on your patches. Split the work into
100    multiple small patches that can be reviewed and
101    applied seperately and safely to the OpenOCD
102    repository.
103 @code
104 while(!done) {
105   work - edit files using your favorite editor.
106   run "git commit -s -a" to commit all changes.
107   run tools/checkpatch.sh to verify your patch style is ok.
108 }
109 @endcode
110    @b TIP! use "git add ." before commit to add new files.
111 @code
112 --- example comment, notice the short first line w/topic ---
113 topic: short comment
114 <blank line>
115 longer comments over several
116 lines...
117 <blank line>
118 Signed-off-by: ...
119 -----
120 @endcode
121 -# Next you need to make sure that your patches
122    are on top of the latest stuff on the server and
123    that there are no conflicts:
124 @code
125 git pull --rebase origin/master
126 @endcode
127 -# Send the patches to the Gerrit server for review:
128 @code
129 git push review
130 @endcode
131 -# Forgot something, want to add more? Just make the changes and do:
132 @code
133 git commit --amend
134 git push review
135 @endcode
136
137 Further reading: http://www.coreboot.org/Git
138
139 @section timeline When can I expect my contribution to be committed?
140
141 The code review is intended to take as long as a week or two to allow
142 maintainers and contributors who work on OpenOCD only in their spare
143 time oportunity to perform a review and raise objections.
144
145 With Gerrit much of the urgency of getting things committed has been
146 removed as the work in progress is safely stored in Gerrit and
147 available if someone needs to build on your work before it is
148 submitted to the official repository.
149
150 Another factor that contributes to the desire for longer cool-off
151 times (the time a patch lies around without any further changes or
152 comments), it means that the chances of quality regression on the
153 master branch will be much reduced.
154
155 If a contributor pushes a patch, it is considered good form if another
156 contributor actually approves and submits that patch.
157
158 @section browsing Browsing Patches
159 All OpenOCD patches can be reviewed <a href="http://openocd.zylin.com/">here</a>.
160 */
161 /** @file
162 This file contains the @ref patchguide page.
163 */