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.

48 lines
1.4 KiB

  1. // This file is part of the Doxygen Developer Manual
  2. /** @page patchguide Patch Guidelines
  3. Please mail patches to: @par
  5. Note that you can't send patches to that list unless
  6. you're a member, despite what the list info page says.
  7. @section Patch Guidelines in a Nutshell
  8. Your patches should be against git mainline. Submit output
  9. of "git diff"; equivalently, quilt patches are OK.
  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. git diff >mypatch.txt
  28. @endcode
  29. @section More Information on Patching
  30. The @ref primerpatches provides a more complete guide to creating,
  31. managing, and contributing patches to the OpenOCD project.
  32. */
  33. /** @file
  34. This file contains the @ref patchguide page.
  35. */