summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2005-06-27 16:20:44 +0000
committerEric S. Raymond <esr@thyrsus.com>2005-06-27 16:20:44 +0000
commite7d20f03c99f5d77d3be5411bab5fe56fe6cfb4f (patch)
tree694346571643a7526a113f0e7b4317a5be353891 /HACKING
parent9a6866f081e124630cb5409b245b22df2e03167d (diff)
downloadgpsd-e7d20f03c99f5d77d3be5411bab5fe56fe6cfb4f.tar.gz
Another test case is firm.
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING39
1 files changed, 24 insertions, 15 deletions
diff --git a/HACKING b/HACKING
index b6cdc83c..9fdc49b9 100644
--- a/HACKING
+++ b/HACKING
@@ -8,27 +8,36 @@ If you're looking for things to hack on, first see the TODO file.
We prefer diff -u format, but diff -c is acceptable. Do not send
patches in the default (-e or ed) mode, as they are too brittle.
-If you are introducing a new feature, include a documentation patch.
+Before shipping a patch, you should go through the following checklist:
-If you are contributing a driver for a new GPS, please also do the
-following things:
+(1) If you are introducing a new feature or driver, include a
+ documentation patch.
+
+(2) Use the regression-test suite -- "make testregress" -- to check
+ that your patch doesn't break the handling of any already-supported GPS.
-1) Send us a representative sample of the GPS output for future
- regression-testing.
+(3) If you have valgrind(1) on your development system, run
+ valgrind-audit and look out for reports of memory leaks and
+ other dynamic-allocation problems (see <http://valgrind.org> for
+ a description of this tool if you don't already know about it).
+ If you can't run valgrind. tell us that you couldn't do it.
-2) Write a hardware entry describing the GPS for the hardware page at
- <http://gpsd.berlios.de/hardware.html>.
+(4) If you have splint(1) on your development system, make sure the
+ patched code displays no warnings when you run 'make
+ splint' (see <http://www.splint.org> for further description of
+ this tool if you don't already know about it). If you can't run
+ splint. tell us that you couldn't do it.
+
+If you are contributing a driver for a new GPS, please also do the
+following things:
-There's a whole section on adding new drivers Later in this document.
+(5) Send us a representative sample of the GPS output for future
+ regression-testing.
-Before shipping a patch, it is a good idea to make sure the patched
-code displays no warnings when you run 'make splint'. See
-http://www.splint.org for a description of this tool. It is also
-a good idea to run valgrind-audit and look out for reports of memory
-leaks and other dynamic-allocation problems.
+(6) Write a hardware entry describing the GPS for the hardware page at
+ <http://gpsd.berlios.de/hardware.html>.
-Also, use the regression-test suite -- "make testregress" -- to check
-that your patch doesn't break the handling of any already-supported GPS.
+There's a whole section on adding new drivers later in this document.
** The license on contributions