aboutsummaryrefslogtreecommitdiff
path: root/PATCHES.txt
diff options
context:
space:
mode:
authorDavid Brownell <dbrownell@users.sourceforge.net>2010-01-08 17:20:47 -0800
committerDavid Brownell <dbrownell@users.sourceforge.net>2010-01-08 17:20:47 -0800
commitc1cb20971ea89e4602bb23ba66180d647880bbef (patch)
tree54759a26b900460590b019fd7b4b6a7cf14e20dd /PATCHES.txt
parent296a011db5833b8a3258a058e6a805cc5ddb2bfe (diff)
downloadriscv-openocd-c1cb20971ea89e4602bb23ba66180d647880bbef.zip
riscv-openocd-c1cb20971ea89e4602bb23ba66180d647880bbef.tar.gz
riscv-openocd-c1cb20971ea89e4602bb23ba66180d647880bbef.tar.bz2
Coexist with quilt: rename PATCHES --> PATCHES.txt
The issues is on Win32, which ignores case in filesystem and thus doesn't tolerate the quilt "patches" directory. Rename, and add "patches" to .gitignore so that developers can choose to use quilt for local patch management. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Diffstat (limited to 'PATCHES.txt')
-rw-r--r--PATCHES.txt47
1 files changed, 47 insertions, 0 deletions
diff --git a/PATCHES.txt b/PATCHES.txt
new file mode 100644
index 0000000..856b094
--- /dev/null
+++ b/PATCHES.txt
@@ -0,0 +1,47 @@
+// This file is part of the Doxygen 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.
+*/