aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_compat.3compat.adoc
Commit message (Collapse)AuthorAge
* Remove the documentation for 3compat.Garrett D'Amore2024-10-06
|
* Harmonize the use of NNG in documentation.Garrett D'Amore2020-06-18
| | | | | NNG is always a noun, never an adjective, and should always be capitalized. We also reduced some unnecessary usages of it.
* Language cleanups in the documentation.Garrett D'Amore2020-06-18
| | | | | | Mostly this is removal of the smart quotes, which were over-used, and misused, and could have been mistaken to be pejorative. A few other minor nits were fixed while here.
* more .adoc markup fixes.Garrett D'Amore2019-06-29
| | | | | | | This is mostly mechanical-ish fixups to adjust markup style for cross references. A bit of care and feeding needed, so we haven't finished the list, but this gets a significant chunk of them.
* Fix numerous spelling errrors.Garrett D'Amore2018-05-30
| | | | | | | These were found with the help of "aspell". Additionally, while reviewing the output from the spell checker, several content errors were noticed and fixed.
* fixes #495 SEE ALSO should use [align=left]Garrett D'Amore2018-05-29
| | | | | | | | | | | | fixes #494 ERRORS section should use [horizontal] These changes address some basic formatting consistency things, and ultimately (when combined with other tooling changes that are not part of this repo) lead to vastly improved layout in the printed documentation. While here we removed trailing whitespace, and did certain other minor markup tweaks.
* fixes #469 SO_REUSEADDR should be enabledGarrett D'Amore2018-05-21
| | | | | | | | | | | | | | | | | | | fixes #468 TCP nodelay and keepalive should start usable fixes #467 NN_RCVMAXSZ option does not work (compat) fixes #465 Support NN_OPT_TCPNODELAY (compat) This is a rather larger change set than I'd like, but when adding support for legacy TCP keepalive, I found a number if issues using the legacy TCP test (which we are introducing with this commit.) This fixes the concerns that are relevant and addressible. We have elected not to try to support to local address binding at this time, and the IPv6 test case in the old code was wrong, so changes relevant to that are commented out. I've also updated the nng_compat manual page to reflect additional caveats that folks should be aware of, including the previously undocumented caveat around the NN_SNDBUF and NN_RCVBUF options.
* fixes #457 Create stub headers for compatibilityGarrett D'Amore2018-05-21
| | | | | | | | | | I actually made these real headers, not stubs While here I made some improvements to the nng_compat man page, to improve the language and also the presentation on some devices. (We were going nuts with the icons, instead, I've made a single new section, called Caveats, that lists a bunch of them.) This should not have any impact on binary compatibility.
* fixes #458 Improve man page section descriptions.Garrett D'Amore2018-05-19
|
* Markup fixes, ensuring links are colored properly.Garrett D'Amore2018-05-01
| | | | | | | | | It turns out that when creating cross references, we need to make any text styling (generally literal characters) outside of the link, to avoid having the styling override the link color. (We prefer to have links colored for ease of use.) While here a few other markup, and actual content, errors were fixed.
* fixes #387 Document that IPC paths must be absoluteGarrett D'Amore2018-04-30
|
* fixes #384 Add NN_PROTOCOL and relatedGarrett D'Amore2018-04-30
|
* fixes #344 nn_poll() legacy API missingGarrett D'Amore2018-04-16
| | | | | | | | | | | | This includes the test from legacy libnanomsg and a man page. We have refactored the message queue notification system so that it uses nni_pollable, leading we hope to a more consistent system, and reducing the code size and complexity. We also fixed the size of the NN_RCVFD and NN_SNDFD so that they are a SOCKET on Windows systems, rather than an integer. This addresses 64-bit compilation problems.
* fixes #303 Flesh out compatible API docsGarrett D'Amore2018-04-14
|
* fixes #287 remove NNG_OPT_DOMAIN, NNG_OPT_PROTOCOL, and NNG_OPT_TRANSPORTGarrett D'Amore2018-03-17
| | | | | While here we documented that certain options are not supported in the compatibility layer.
* fixes #286 nng_pair0_open (and all others) need man pageGarrett D'Amore2018-03-17
fixes #279 consider restructuring man sections This represents a rather significant rework, and major editing effort, for the entire set of manual pages. All of the pages now have a section number in their filename; this assists in some other tooling, particularly ebook generation as every link needs to be programmatically modified when combined into an ebook. Section 5 is introduced, and populated with pages for the main types, and all options are now documented. Numerous errors have been corrected, including rewriting certain portions such as the header section of the surveyor protocol. Much work has been done to facilitate index generation, although certainly more work remains here. Every internal link within these pages now resolves; there are no more dead links. (This is required to generate Kindle format books.)