[nanomsg] Separating the library from the docs

  • From: Martin Sustrik <sustrik@xxxxxxxxxx>
  • To: <nanomsg@xxxxxxxxxxxxx>
  • Date: Tue, 13 Aug 2013 11:15:45 +0200

Hi all,

Building nanomsg documentation is a very different beast from building the nanomsg library:

1. It requires different build tools (asciidoc, xmlto, xml2rfc)
2. These tools are not available on all platforms (Windows)
3. Most people building the library don't modify the documentation and would be OK with pre-generated doc files
5. Documentation is deployed in different way than the library
   a.) HTML docs are uploaded to the website
b.) RFCs are to be passed to IETF and eventually get published by RFC editor
   c.) man pages are bundled with the library

Given all the above it seems to me that making the documentation a separate project and adding the *generated* man pages to the library project would make sense.

Any opinions on that?
Martin

Other related posts: