Author: David Brownell <david-b@pacbell.net>
- Update PATCHES to better describe the policies in place git-svn-id: svn://svn.berlios.de/openocd/trunk@1872 b42882b7-edfa-0310-969c-e2dbd0fdcd60
This commit is contained in:
parent
988d6a49a9
commit
5982d4eca8
22
PATCHES
22
PATCHES
|
@ -6,15 +6,25 @@ Note that you can't send patches to that list unless
|
||||||
you're a member, despite what the list info page says.
|
you're a member, despite what the list info page says.
|
||||||
|
|
||||||
The patch should be against svn trunk using an SVN
|
The patch should be against svn trunk using an SVN
|
||||||
diff.
|
diff. If you use git-svn, a git diff or patch is OK
|
||||||
|
too; likewise a quilt patch, if you use quilt.
|
||||||
|
|
||||||
|
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
|
Attach the patch to the email as a .txt file and
|
||||||
also write a short change log entry that maintainers
|
also write a short change log entry that maintainers
|
||||||
can copy and paste into the commit message
|
can copy and paste into the commit message
|
||||||
|
|
||||||
(However, don't expect the maintainers to actually
|
Say if it's a bugfix (describe the bug) or a new
|
||||||
include such entries in their commit messages if
|
feature. Don't expect patches to merge immediately
|
||||||
they're longer than a single $SUBJECT line.)
|
for the next release. Be ready to rework patches
|
||||||
|
in response to feedback.
|
||||||
|
|
||||||
Add yourself to the GPL copyright for non-trivial changes.
|
Add yourself to the GPL copyright for non-trivial changes.
|
||||||
|
|
||||||
|
@ -22,14 +32,14 @@ To create a patch from the command line:
|
||||||
|
|
||||||
svn diff >mypatch.txt
|
svn diff >mypatch.txt
|
||||||
|
|
||||||
|
See:
|
||||||
|
|
||||||
http://svnbook.red-bean.com/en/1.0/re09.html
|
http://svnbook.red-bean.com/en/1.0/re09.html
|
||||||
|
|
||||||
NB! remember to use "svn add" on new files first!
|
NB! remember to use "svn add" on new files first!
|
||||||
|
|
||||||
http://svnbook.red-bean.com/en/1.0/re01.html
|
http://svnbook.red-bean.com/en/1.0/re01.html
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
If you have a decent SVN GUI, then that should be
|
If you have a decent SVN GUI, then that should be
|
||||||
able to create and apply patches as well...
|
able to create and apply patches as well...
|
||||||
|
|
Loading…
Reference in New Issue