[gpsd-dev] [PATCH 1/2] Moves Linux-only ppscheck program back to contrib/.

[Fred Wright]

This reverts commit 9a0920a90ca06fad897e4e6c25b773ac039eb3fa,
except for retaining the added man page source (now in contrib/).

Since the TIOCMIWAIT ioctl is Linux-only, and clock_gettime()
is also unavailable on some platforms, making ppscheck a "full-
fledged program" breaks the build on most non-Linux platforms.
Both of those things would need alternative implementations before
this program could be considered portable.
---
 .gitignore                           | 1 -
 SConstruct                           | 9 ++-------
 contrib/README                       | 6 ++++++
 ppscheck.c => contrib/ppscheck.c     | 0
 ppscheck.xml => contrib/ppscheck.xml | 0
 5 files changed, 8 insertions(+), 8 deletions(-)
 rename ppscheck.c => contrib/ppscheck.c (100%)
 rename ppscheck.xml => contrib/ppscheck.xml (100%)

diff --git a/.gitignore b/.gitignore
index 19ef772..2783e44 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,7 +12,6 @@ cgpxlogger
 gpspipe
 gps2udp
 ntpshmmon
-ppscheck
 *.exe
 # These are built from .in files
 jsongen.py
diff --git a/SConstruct b/SConstruct
index 213245e..2e88849 100644
--- a/SConstruct
+++ b/SConstruct
@@ -1252,8 +1252,6 @@ cgps = env.Program('cgps', ['cgps.c'],
 ntpshmmon = env.Program('ntpshmmon', ['ntpshmmon.c'],
                         LIBS=['gps_static'], LIBPATH='.',
                         parse_flags=gpsflags)
-ppscheck = env.Program('ppscheck', ['ppscheck.c'],
-                        parse_flags=gpsflags)
 
 bin_binaries = []
 sbin_binaries = []
@@ -1263,7 +1261,7 @@ if env["gpsdclients"]:
     sbin_binaries += [gpsdctl]
     bin_binaries += [gpsdecode, gpsctl, gpspipe, gps2udp, gpxlogger, lcdgps]
 if env["timeservice"] or env["gpsdclients"]:
-    bin_binaries += [ntpshmmon, "ppscheck"]
+    bin_binaries += [ntpshmmon]
 if env["ncurses"]:
     if env["gpsdclients"]:
         bin_binaries += [cgps]
@@ -1552,7 +1550,6 @@ base_manpages = {
     "gpsdecode.1": "gpsdecode.xml",
     "srec.5": "srec.xml",
     "ntpshmmon.1": "ntpshmmon.xml",
-    "ppscheck.8": "ppscheck.xml",
     }
 python_manpages = {
     "gpsprof.1": "gpsprof.xml",
@@ -2063,7 +2060,6 @@ htmlpages = Split('''
     www/libgps.html
     www/libgpsmm.html
     www/ntpshmmon.html
-    www/ppscheck.html
     www/performance/performance.html
     www/replacing-nmea.html
     www/srec.html
@@ -2219,8 +2215,7 @@ else:
 
 # Tags for Emacs and vi
 misc_sources = ['cgps.c', 'gpsctl.c', 'gpsdctl.c', 'gpspipe.c',
-                'gps2udp.c', 'gpsdecode.c', 'gpxlogger.c', 'ntpshmmon.c',
-                'ppscheck.c']
+                'gps2udp.c', 'gpsdecode.c', 'gpxlogger.c', 'ntpshmmon.c']
 sources = libgpsd_sources + libgps_sources \
           + gpsd_sources + gpsmon_sources + misc_sources
 env.Command('TAGS', sources, ['etags ' + " ".join(sources)])
diff --git a/contrib/README b/contrib/README
index e069733..745d1d5 100644
--- a/contrib/README
+++ b/contrib/README
@@ -37,6 +37,12 @@ ntpoffset generate an estimate of your GPS's offset from a 
peerstats
 file.  For instructions on how to use this script, see the GPSD Time
 Service HOWTO in this distrubution, in the www/ subdirectory.
 
+ppscheck watches a specified serial device for changes in handshake lines
+CD, RI, and CTS by running ioctl(...., TIOCMIWAIT, ...) in a loop.  When it
+sees a state change it emits a timestamped line of output dumping the state
+of the handshake signals. It's useful for checking whether a device is
+emitting 1PPS.  There is troubleshooting advice in the header comment.
+  
 skyview.php is used to generate pictures of your skyview, and may be
 used to help determine if a given antenna placement is appropriate for
 some purpose. This tool take a count of samples to collect from GPSD, and
diff --git a/ppscheck.c b/contrib/ppscheck.c
similarity index 100%
rename from ppscheck.c
rename to contrib/ppscheck.c
diff --git a/ppscheck.xml b/contrib/ppscheck.xml
similarity index 100%
rename from ppscheck.xml
rename to contrib/ppscheck.xml
-- 
2.9.2