[nanomsg] Re: NNG Reference Manual on leanup

  • From: "Garrett D'Amore" <garrett@xxxxxxxxxx>
  • To: nanomsg@xxxxxxxxxxxxx
  • Date: Fri, 09 Mar 2018 15:10:25 +0000

Thanks for the feedback! I will make the corrections and post an update
shortly.
On Fri, Mar 9, 2018 at 2:22 AM Patrik Wenger <paddor@xxxxxxxxx> wrote:

Hi Garret

Thanks for publishing the manual! I got a copy of it yesterday and read
a lot. I find it super interesting.

My 5 cents:

* There is a layout error (I guess) in the end of the OPTIONS section of
nngcat(1).
* A few times (such as in nng_recvmsg(3)) I noticed that a "*" is
missing in the SYNOPSIS of a few functions, such as in nng_listener_*(3)
and nng_recvmsg(3) (unless I'm wrong and those parameters are really
passed as copies).
* In the section "Message Handling Functions", the description for
nng_msg_len(3) is wrong.
* The man pages for nng_msg_set_pipe(3) and nng_msg_get_pipe(3) seem to
be missing.


Best regards,
Patrik

On 08.03.2018 19:18, Garrett D'Amore wrote:
Hello everyone,

If you’re using NNG, you might be interested to know that I’ve
published the NNG reference manual as a consolidated document on
Leanpub.  You can purchase it here:

https://leanpub.com/nngmanual

There isn’t anything there that I haven’t posted on the main website,
but I’ve spent some non-trivial amount of effort formatting this as a
single defined book.

Be aware that the epub format is still a little rough around the edges
— I recommend the PDF if you can use that.  (This is due to
limitations in the epub backend in Asciidoctor — I may spend some more
time trying to fix it, but I’ve already spent far too much time
working on this.  I feel like I have a much better understanding of
Knuth now.)

The book isn’t free, but it only costs $0.99 at minimum (feel free to
offer more though!).  Again, you can get the same content on the web
for free.

Thanks!

 - Garrett



Other related posts: