aboutsummaryrefslogtreecommitdiff
path: root/docs/man/man3compat.desc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/man3compat.desc')
-rw-r--r--docs/man/man3compat.desc14
1 files changed, 12 insertions, 2 deletions
diff --git a/docs/man/man3compat.desc b/docs/man/man3compat.desc
index a1141850..a35173c0 100644
--- a/docs/man/man3compat.desc
+++ b/docs/man/man3compat.desc
@@ -1,3 +1,13 @@
This section documents the _nanomsg_ 1.0 libary compatible functions.
-The functions in this section not be used except to aid in transitioning
-from the older _libnanomsg_ library. \ No newline at end of file
+
+These functions are provided as a transition aid, for application
+developers coming to _NNG_ from _libnanomsg_, and are discouraged
+from use in new applications.
+
+TIP: While this is discouraged for long term use, as a transition aid
+applications may use the value returned by the
+<<nng_socket_id.3#,nng_socket_id()>> in these functions just like a
+socket descriptor (as if the socket were opened
+via <<nn_socket.3compat#,nn_socket()>>).
+This sort of API intermixing should only be used during transition from
+the legacy API to the new API.