diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-05-19 21:42:07 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-05-19 21:42:07 -0700 |
| commit | 2c123e082a4fea6fa82132f6ab0f7257daac3f59 (patch) | |
| tree | 31c8329fc8c32d7b835ba55977c6911192b39fe0 /docs/man/man3compat.desc | |
| parent | 0c3178860cb14b095e809676d5c4401cf65f5f58 (diff) | |
| download | nng-2c123e082a4fea6fa82132f6ab0f7257daac3f59.tar.gz nng-2c123e082a4fea6fa82132f6ab0f7257daac3f59.tar.bz2 nng-2c123e082a4fea6fa82132f6ab0f7257daac3f59.zip | |
fixes #458 Improve man page section descriptions.
Diffstat (limited to 'docs/man/man3compat.desc')
| -rw-r--r-- | docs/man/man3compat.desc | 14 |
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. |