From c1cb20971ea89e4602bb23ba66180d647880bbef Mon Sep 17 00:00:00 2001 From: David Brownell Date: Fri, 8 Jan 2010 17:20:47 -0800 Subject: 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 --- .gitignore | 3 +++ BUGS | 4 ++-- Doxyfile.in | 2 +- NEWS | 5 ++++- PATCHES | 47 ----------------------------------------------- PATCHES.txt | 47 +++++++++++++++++++++++++++++++++++++++++++++++ doc/openocd.texi | 2 +- tools/release.sh | 2 +- 8 files changed, 59 insertions(+), 53 deletions(-) delete mode 100644 PATCHES create mode 100644 PATCHES.txt diff --git a/.gitignore b/.gitignore index 5ec831ed..e37ee5a1 100644 --- a/.gitignore +++ b/.gitignore @@ -66,6 +66,9 @@ stamp-vti INSTALL NOTES +# coexist with quilt +patches + # Eclipse stuff .project .cproject diff --git a/BUGS b/BUGS index 961b3394..36a7da37 100644 --- a/BUGS +++ b/BUGS @@ -26,8 +26,8 @@ that may be important. http://www.kernel.org/pub/software/scm/git/docs/git-bisect.html If possible, please develop and attach a patch that helps to expose or -solve the reported problem. See the PATCHES file for more information -for that process. +solve the reported problem. See the PATCHES.txt file for information +about that process. Attach all files directly to your posting. The mailing list knows to transform attachments to links, but attachments must be less than 300KB diff --git a/Doxyfile.in b/Doxyfile.in index 49630f2f..519bb2f8 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -567,7 +567,7 @@ WARN_LOGFILE = INPUT = @srcdir@/doc/manual \ @srcdir@/TODO \ @srcdir@/BUGS \ - @srcdir@/PATCHES \ + @srcdir@/PATCHES.txt \ @srcdir@/src \ @srcdir@/config.h diff --git a/NEWS b/NEWS index ba7e0e60..b1696065 100644 --- a/NEWS +++ b/NEWS @@ -8,6 +8,7 @@ JTAG Layer: Support USB-JTAG, Altera USB-Blaster and compatibles. Boundary Scan: + Target Layer: General - new "reset-assert" event, for systems without SRST @@ -36,6 +37,8 @@ Target Layer: ETM, ETB - "trigger_percent" command moved ETM --> ETB - "etm trigger_debug" command added + MIPS + - use fastdata writes Freescale DSP563xx cores (partial support) Flash Layer: @@ -81,4 +84,4 @@ For older NEWS, see the NEWS files associated with each release For more information about contributing test reports, bug fixes, or new features and device support, please read the new Developer Manual (or -the BUGS and PATCHES files in the source archive). +the BUGS and PATCHES.txt files in the source archive). diff --git a/PATCHES b/PATCHES deleted file mode 100644 index 856b0947..00000000 --- a/PATCHES +++ /dev/null @@ -1,47 +0,0 @@ -// 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. -*/ diff --git a/PATCHES.txt b/PATCHES.txt new file mode 100644 index 00000000..856b0947 --- /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. +*/ diff --git a/doc/openocd.texi b/doc/openocd.texi index 84bdb3c4..2e0143ed 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -223,7 +223,7 @@ communication between developers: @uref{https://lists.berlios.de/mailman/listinfo/openocd-development} Discuss and submit patches to this list. -The @file{PATCHES} file contains basic information about how +The @file{PATCHES.txt} file contains basic information about how to prepare patches. diff --git a/tools/release.sh b/tools/release.sh index c464c49f..12dfdb6a 100755 --- a/tools/release.sh +++ b/tools/release.sh @@ -205,7 +205,7 @@ For older NEWS, see the NEWS files associated with each release For more information about contributing test reports, bug fixes, or new features and device support, please read the new Developer Manual (or -the BUGS and PATCHES files in the source archive). +the BUGS and PATCHES.txt files in the source archive). NEWS git add NEWS -- cgit v1.2.3