You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

156 lines
5.5 KiB

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