summaryrefslogtreecommitdiff
path: root/libgps.xml
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2011-08-26 14:47:05 -0400
committerEric S. Raymond <esr@thyrsus.com>2011-08-26 14:47:05 -0400
commit574a52109b76e59e71fd4a8099ba0493e47e1e41 (patch)
tree210e232cc0d83eaf2db63726db52182437d13bd2 /libgps.xml
parent13c7e896247e24d86b10249ce73d999559a99727 (diff)
downloadgpsd-574a52109b76e59e71fd4a8099ba0493e47e1e41.tar.gz
Make the sock_export=no build.
The way I fixed this extends the library API so some functions which were previously undefined for shm transport are now defined. This doesn't change the binary API of the library in the normal (sock_export=yes) case at all, so I'm not bumping its version. No changes in the daemon. All regression tests pass (in the normal sock_export=yes build).
Diffstat (limited to 'libgps.xml')
-rw-r--r--libgps.xml6
1 files changed, 3 insertions, 3 deletions
diff --git a/libgps.xml b/libgps.xml
index a05e4ce9..02d93eb8 100644
--- a/libgps.xml
+++ b/libgps.xml
@@ -121,7 +121,7 @@ these.</para>
<para><function>gps_close()</function> ends the session.</para>
<para><function>gps_send()</function> writes a command to the daemon.
-It is not available when using the shared-memory export.
+It does nothing when using the shared-memory export.
The second argument must be a format string containing elements from
the command set documented at
<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
@@ -142,7 +142,7 @@ socket to the daemon has closed or if the shared-memory segment was
unavailable, and 0 if no data is available.</para>
<para><function>gps_waiting()</function> can be used to check whether
-there is data from the daemon (it is not available when usng the
+there is data from the daemon (it always returns true when using the
shared-memory export). The second argument is the maximum amount of
time to wait (in microseconds) on input before returning. It returns
true if there input waiting, false on timeout (no data waiting) or
@@ -158,7 +158,7 @@ Included in case your application wishes to manage socket I/O
itself.</para>
<para><function>gps_data()</function> returns the contents of the
-client data buffer (not available when using the shared-memory
+client data buffer (it returns NULL when using the shared-memory
export). Use with care; this may fail to be a NUL-terminated string if
WATCH_RAW is enabled.</para>