Skip to content
Snippets Groups Projects
Select Git revision
  • 49036463dbebcd4c5722f89b86dc6cec777bab0f
  • master default protected
  • v0.10.0
  • v0.10.0-rc2
  • v0.10.0-rc1
  • v0.9.0
  • v0.9.0-rc1
  • v0.8.0
  • v0.8.0-rc2
  • v0.8.0-rc1
  • v0.7.0
  • v0.7.0-rc2
  • v0.7.0-rc1
  • v0.6.1
  • v0.6.0
  • v0.6.0-rc2
  • v0.6.0-rc1
  • v0.5.0
  • v0.5.0-rc2
  • v0.5.0-rc1
  • v0.4.0
  • v0.4.0-rc2
22 results

PATCHES

Blame
  • PATCHES 1.43 KiB
    // This file is part of the Doyxgen Developer Manual
    /** @page patchguide Patch Guidelines
    
    Please mail patches to: @par
    	openocd-development@lists.berlios.de
    
    Note that you can't send patches to that list unless
    you're a member, despite what the list info page says.
    
    @section Patch Guidelines in a Nutshell
    
    Your patches should be against git mainline.  Submit output
    of "git diff"; equivalently, quilt patches are OK.
    
    It should be a "good patch": focus it on a single
    issue, and make it be easily reviewable. Don't make
    it so large that it's hard to review; split large
    patches into smaller ones. (That can also help
    track down bugs later on.) All patches should
    be "clean", which includes preserving the existing
    coding style and updating documentation as needed.j
    
    Attach the patch to the email as a .txt file and
    also write a short change log entry that maintainers
    can copy and paste into the commit message
    
    Say if it's a bugfix (describe the bug) or a new
    feature. Don't expect patches to merge immediately
    for the next release. Be ready to rework patches
    in response to feedback.
    
    Add yourself to the GPL copyright for non-trivial changes.
    
    To create a patch from the command line:
    @code 
    	git diff >mypatch.txt
    @endcode
    
    @section More Information on Patching
    
    The @ref primerpatches provides a more complete guide to creating,
    managing, and contributing patches to the OpenOCD project.
    
     */
    /** @file
    This file contains the @ref patchguide page.
    */