From 63bdb2c28bc185096e579d1922d57cb71ecaa36b Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Mon, 30 Apr 2018 19:02:00 -0700
Subject: fixes #387 Document that IPC paths must be absolute

---
 docs/man/nng_compat.3compat.adoc | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'docs/man/nng_compat.3compat.adoc')

diff --git a/docs/man/nng_compat.3compat.adoc b/docs/man/nng_compat.3compat.adoc
index f46fc7df..42b0942e 100644
--- a/docs/man/nng_compat.3compat.adoc
+++ b/docs/man/nng_compat.3compat.adoc
@@ -115,9 +115,9 @@ Consequently, socket numbers can become quite large, and should
 probably not be used for array indices.
 
 NOTE: The following options (`nn_getsockopt`) are unsupported:
-`NN_IPC_INBUFSZ`, `NN_OUTBUFSZ`, `NN_SNDPRIO`, `NN_RCVPRIO`, `NN_IPV4ONLY`.
-Some of these may be supported in the future when the relevant support
-is added to _nng_.
+`NN_SNDPRIO`, `NN_RCVPRIO`, `NN_IPV4ONLY`.
+The priority options may be supported in the future, when
+the underlying capability is present in _nng_.
 
 NOTE: Access to statistics using this legacy API
 (`<<nn_get_statistic.3compat#,nn_get_statistic()>>`) is unsupported.
@@ -126,6 +126,9 @@ NOTE: Some transports can support longer URLs than legacy _libnanomsg_ can.
 It is a good idea to use short pathnames in URLs if interoperability
 is a concern.
 
+NOTE: Only absolute paths are supported in `ipc://` URLs.
+For example, `ipc:///tmp/mysocket` is acceptable, but `ipc://mysocket` is not.
+
 NOTE: Some transports are unusable from this mode.
 In particular, this legacy API offers no way to configure
 TLS parameters that are required for use.
-- 
cgit v1.2.3-70-g09d2

