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.
 
 
 
 
 
 

58 lines
1.7 KiB

  1. /** @page patchguide Patch Guidelines
  2. Please mail patches to:
  3. openocd-development@lists.berlios.de
  4. Note that you can't send patches to that list unless
  5. you're a member, despite what the list info page says.
  6. @section Patch Guidelines in a Nutshell
  7. The patch should be against svn trunk using an SVN
  8. diff. If you use git-svn, a git diff or patch is OK
  9. too; likewise a quilt patch, if you use quilt.
  10. It should be a "good patch": focus it on a single
  11. issue, and make it be easily reviewable. Don't make
  12. it so large that it's hard to review; split large
  13. patches into smaller ones. (That can also help
  14. track down bugs later on.) All patches should
  15. be "clean", which includes preserving the existing
  16. coding style and updating documentation as needed.j
  17. Attach the patch to the email as a .txt file and
  18. also write a short change log entry that maintainers
  19. can copy and paste into the commit message
  20. Say if it's a bugfix (describe the bug) or a new
  21. feature. Don't expect patches to merge immediately
  22. for the next release. Be ready to rework patches
  23. in response to feedback.
  24. Add yourself to the GPL copyright for non-trivial changes.
  25. To create a patch from the command line:
  26. @code
  27. svn diff >mypatch.txt
  28. @endcode
  29. See: @par
  30. http://svnbook.red-bean.com/en/1.0/re09.html
  31. Remember to use "svn add" on new files first: @par
  32. http://svnbook.red-bean.com/en/1.0/re01.html
  33. If you have a decent SVN GUI, then that should be
  34. able to create and apply patches as well...
  35. @section More Information on Patching
  36. The @ref primerpatches provides a more complete guide to creating,
  37. managing, and contributing patches to the OpenOCD project.
  38. */
  39. /** @file
  40. This file contains the @ref patchguide page.
  41. */