[nanomsg] Re: Separating the library from the docs

  • From: luca barbato <luca.barbato@xxxxxxxxxxx>
  • To: nanomsg@xxxxxxxxxxxxx
  • Date: Wed, 14 Aug 2013 12:03:05 +0200

On Wed, Aug 14, 2013 at 9:15 AM, Martin Sustrik <sustrik@xxxxxxxxxx> wrote:

> Hi Luca,
>
>
>  I'm not sure exactly why having the current --enable-doc is not enough
>> to cover the situation.
>>
>
> The problem is that until there are distro packages available, the only
> distribution channels are git repo and source packages. None of them
> contains generated man pages.
>
> So, being a regular user, you just download the package and build it. As
> you probably don't have asciidoc and friends installed, you won't have man
> pages available.
>
> There are two possible solutions:
>
> 1. Ignore it. People should install the doc toolchain if they want to use
> docs while offline.
> 2. Package the generated docs in the source package.
>
> I was trying to come up with a way to do 2.) cleanly, but I guess we'll
> just proceed with 1.) for now.
>

2 is done right now currently.

tar -tf nanomsg-0.tar.xz
nanomsg-0/
nanomsg-0/config.sub
nanomsg-0/depcomp
nanomsg-0/AUTHORS
nanomsg-0/configure
nanomsg-0/ltmain.sh
nanomsg-0/version.sh
nanomsg-0/config.guess
nanomsg-0/install-sh
nanomsg-0/aclocal.m4
nanomsg-0/perf/
nanomsg-0/perf/remote_thr.c
nanomsg-0/perf/local_thr.c
nanomsg-0/perf/inproc_thr.c
nanomsg-0/perf/inproc_lat.c
nanomsg-0/perf/local_lat.c
nanomsg-0/perf/remote_lat.c
nanomsg-0/perf/CMakeLists.txt
nanomsg-0/COPYING
nanomsg-0/tests/
nanomsg-0/tests/survey.c
nanomsg-0/tests/domain.c
nanomsg-0/tests/tcp.c
nanomsg-0/tests/pubsub.c
nanomsg-0/tests/symbol.c
nanomsg-0/tests/hash.c
nanomsg-0/tests/msg.c
nanomsg-0/tests/poll.c
nanomsg-0/tests/shutdown.c
nanomsg-0/tests/separation.c
nanomsg-0/tests/bus.c
nanomsg-0/tests/tcp_shutdown.c
nanomsg-0/tests/inproc_shutdown.c
nanomsg-0/tests/reqrep.c
nanomsg-0/tests/fanout.c
nanomsg-0/tests/inproc.c
nanomsg-0/tests/iovec.c
nanomsg-0/tests/fanin.c
nanomsg-0/tests/ipc_shutdown.c
nanomsg-0/tests/list.c
nanomsg-0/tests/pair.c
nanomsg-0/tests/block.c
nanomsg-0/tests/emfile.c
nanomsg-0/tests/prio.c
nanomsg-0/tests/ipc.c
nanomsg-0/tests/trie.c
nanomsg-0/tests/timeo.c
nanomsg-0/tests/CMakeLists.txt
nanomsg-0/tests/device.c
nanomsg-0/README
nanomsg-0/Makefile.in
nanomsg-0/src/
nanomsg-0/src/protocol.h
nanomsg-0/src/transports/
nanomsg-0/src/transports/tcp/
nanomsg-0/src/transports/tcp/tcp.c
nanomsg-0/src/transports/tcp/stcp.c
nanomsg-0/src/transports/tcp/ctcp.h
nanomsg-0/src/transports/tcp/stcp.h
nanomsg-0/src/transports/tcp/ctcp.c
nanomsg-0/src/transports/tcp/tcp.h
nanomsg-0/src/transports/tcp/atcp.c
nanomsg-0/src/transports/tcp/btcp.c
nanomsg-0/src/transports/tcp/atcp.h
nanomsg-0/src/transports/tcp/btcp.h
nanomsg-0/src/transports/ipc/
nanomsg-0/src/transports/ipc/cipc.c
nanomsg-0/src/transports/ipc/bipc.h
nanomsg-0/src/transports/ipc/bipc.c
nanomsg-0/src/transports/ipc/ipc.h
nanomsg-0/src/transports/ipc/sipc.h
nanomsg-0/src/transports/ipc/cipc.h
nanomsg-0/src/transports/ipc/aipc.h
nanomsg-0/src/transports/ipc/aipc.c
nanomsg-0/src/transports/ipc/ipc.c
nanomsg-0/src/transports/ipc/sipc.c
nanomsg-0/src/transports/utils/
nanomsg-0/src/transports/utils/backoff.h
nanomsg-0/src/transports/utils/literal.c
nanomsg-0/src/transports/utils/dns.c
nanomsg-0/src/transports/utils/dns_getaddrinfo_a.inc
nanomsg-0/src/transports/utils/streamhdr.h
nanomsg-0/src/transports/utils/backoff.c
nanomsg-0/src/transports/utils/iface.c
nanomsg-0/src/transports/utils/literal.h
nanomsg-0/src/transports/utils/port.h
nanomsg-0/src/transports/utils/iface.h
nanomsg-0/src/transports/utils/dns_getaddrinfo_a.h
nanomsg-0/src/transports/utils/dns.h
nanomsg-0/src/transports/utils/dns_getaddrinfo.inc
nanomsg-0/src/transports/utils/streamhdr.c
nanomsg-0/src/transports/utils/port.c
nanomsg-0/src/transports/utils/dns_getaddrinfo.h
nanomsg-0/src/transports/inproc/
nanomsg-0/src/transports/inproc/cinproc.h
nanomsg-0/src/transports/inproc/sinproc.c
nanomsg-0/src/transports/inproc/sinproc.h
nanomsg-0/src/transports/inproc/binproc.h
nanomsg-0/src/transports/inproc/msgqueue.h
nanomsg-0/src/transports/inproc/cinproc.c
nanomsg-0/src/transports/inproc/binproc.c
nanomsg-0/src/transports/inproc/inproc.c
nanomsg-0/src/transports/inproc/msgqueue.c
nanomsg-0/src/transports/inproc/ins.h
nanomsg-0/src/transports/inproc/inproc.h
nanomsg-0/src/transports/inproc/ins.c
nanomsg-0/src/fanin.h
nanomsg-0/src/pair.h
nanomsg-0/src/pubsub.h
nanomsg-0/src/core/
nanomsg-0/src/core/sock.c
nanomsg-0/src/core/symbol.c
nanomsg-0/src/core/global.h
nanomsg-0/src/core/pipe.c
nanomsg-0/src/core/sockbase.c
nanomsg-0/src/core/ep.c
nanomsg-0/src/core/global.c
nanomsg-0/src/core/sock.h
nanomsg-0/src/core/epbase.c
nanomsg-0/src/core/ep.h
nanomsg-0/src/core/device.c
nanomsg-0/src/transport.h
nanomsg-0/src/protocols/
nanomsg-0/src/protocols/fanin/
nanomsg-0/src/protocols/fanin/source.c
nanomsg-0/src/protocols/fanin/sink.h
nanomsg-0/src/protocols/fanin/sink.c
nanomsg-0/src/protocols/fanin/xsource.h
nanomsg-0/src/protocols/fanin/xsink.h
nanomsg-0/src/protocols/fanin/xsource.c
nanomsg-0/src/protocols/fanin/source.h
nanomsg-0/src/protocols/fanin/xsink.c
nanomsg-0/src/protocols/survey/
nanomsg-0/src/protocols/survey/xrespondent.c
nanomsg-0/src/protocols/survey/xsurveyor.c
nanomsg-0/src/protocols/survey/surveyor.c
nanomsg-0/src/protocols/survey/xrespondent.h
nanomsg-0/src/protocols/survey/surveyor.h
nanomsg-0/src/protocols/survey/respondent.c
nanomsg-0/src/protocols/survey/respondent.h
nanomsg-0/src/protocols/survey/xsurveyor.h
nanomsg-0/src/protocols/fanout/
nanomsg-0/src/protocols/fanout/xpush.h
nanomsg-0/src/protocols/fanout/pull.h
nanomsg-0/src/protocols/fanout/xpull.h
nanomsg-0/src/protocols/fanout/xpush.c
nanomsg-0/src/protocols/fanout/xpull.c
nanomsg-0/src/protocols/fanout/pull.c
nanomsg-0/src/protocols/fanout/push.h
nanomsg-0/src/protocols/fanout/push.c
nanomsg-0/src/protocols/pair/
nanomsg-0/src/protocols/pair/xpair.h
nanomsg-0/src/protocols/pair/pair.h
nanomsg-0/src/protocols/pair/xpair.c
nanomsg-0/src/protocols/pair/pair.c
nanomsg-0/src/protocols/bus/
nanomsg-0/src/protocols/bus/xbus.h
nanomsg-0/src/protocols/bus/xbus.c
nanomsg-0/src/protocols/bus/bus.c
nanomsg-0/src/protocols/bus/bus.h
nanomsg-0/src/protocols/reqrep/
nanomsg-0/src/protocols/reqrep/req.c
nanomsg-0/src/protocols/reqrep/rep.h
nanomsg-0/src/protocols/reqrep/xrep.c
nanomsg-0/src/protocols/reqrep/xrep.h
nanomsg-0/src/protocols/reqrep/req.h
nanomsg-0/src/protocols/reqrep/xreq.h
nanomsg-0/src/protocols/reqrep/xreq.c
nanomsg-0/src/protocols/reqrep/rep.c
nanomsg-0/src/protocols/utils/
nanomsg-0/src/protocols/utils/priolist.c
nanomsg-0/src/protocols/utils/dist.c
nanomsg-0/src/protocols/utils/fq.h
nanomsg-0/src/protocols/utils/dist.h
nanomsg-0/src/protocols/utils/lb.c
nanomsg-0/src/protocols/utils/fq.c
nanomsg-0/src/protocols/utils/excl.c
nanomsg-0/src/protocols/utils/lb.h
nanomsg-0/src/protocols/utils/excl.h
nanomsg-0/src/protocols/utils/priolist.h
nanomsg-0/src/protocols/pubsub/
nanomsg-0/src/protocols/pubsub/pub.c
nanomsg-0/src/protocols/pubsub/pub.h
nanomsg-0/src/protocols/pubsub/trie.h
nanomsg-0/src/protocols/pubsub/sub.h
nanomsg-0/src/protocols/pubsub/sub.c
nanomsg-0/src/protocols/pubsub/trie.c
nanomsg-0/src/ipc.h
nanomsg-0/src/aio/
nanomsg-0/src/aio/fsm.c
nanomsg-0/src/aio/fsm.h
nanomsg-0/src/aio/timer.h
nanomsg-0/src/aio/usock_posix.h
nanomsg-0/src/aio/poller_poll.inc
nanomsg-0/src/aio/pool.c
nanomsg-0/src/aio/worker.h
nanomsg-0/src/aio/worker_posix.h
nanomsg-0/src/aio/ctx.c
nanomsg-0/src/aio/worker.c
nanomsg-0/src/aio/worker_win.inc
nanomsg-0/src/aio/poller_epoll.inc
nanomsg-0/src/aio/usock.h
nanomsg-0/src/aio/poller_poll.h
nanomsg-0/src/aio/pool.h
nanomsg-0/src/aio/usock_posix.inc
nanomsg-0/src/aio/poller_epoll.h
nanomsg-0/src/aio/ctx.h
nanomsg-0/src/aio/usock_win.h
nanomsg-0/src/aio/worker_posix.inc
nanomsg-0/src/aio/timerset.h
nanomsg-0/src/aio/usock.c
nanomsg-0/src/aio/poller_kqueue.h
nanomsg-0/src/aio/usock_win.inc
nanomsg-0/src/aio/worker_win.h
nanomsg-0/src/aio/poller_kqueue.inc
nanomsg-0/src/aio/poller.c
nanomsg-0/src/aio/poller.h
nanomsg-0/src/aio/timerset.c
nanomsg-0/src/aio/timer.c
nanomsg-0/src/nn.h
nanomsg-0/src/tcp.h
nanomsg-0/src/fanout.h
nanomsg-0/src/survey.h
nanomsg-0/src/reqrep.h
nanomsg-0/src/bus.h
nanomsg-0/src/inproc.h
nanomsg-0/src/utils/
nanomsg-0/src/utils/efd_eventfd.h
nanomsg-0/src/utils/efd_socketpair.h
nanomsg-0/src/utils/efd_win.inc
nanomsg-0/src/utils/chunk.h
nanomsg-0/src/utils/glock.h
nanomsg-0/src/utils/thread_posix.h
nanomsg-0/src/utils/atomic.h
nanomsg-0/src/utils/hash.c
nanomsg-0/src/utils/msg.c
nanomsg-0/src/utils/efd_pipe.inc
nanomsg-0/src/utils/alloc.h
nanomsg-0/src/utils/sem.c
nanomsg-0/src/utils/atomic.c
nanomsg-0/src/utils/chunkref.c
nanomsg-0/src/utils/chunk.c
nanomsg-0/src/utils/sem.h
nanomsg-0/src/utils/thread.h
nanomsg-0/src/utils/thread_posix.inc
nanomsg-0/src/utils/alloc.c
nanomsg-0/src/utils/wire.h
nanomsg-0/src/utils/thread.c
nanomsg-0/src/utils/wire.c
nanomsg-0/src/utils/efd.h
nanomsg-0/src/utils/efd.c
nanomsg-0/src/utils/random.c
nanomsg-0/src/utils/efd_pipe.h
nanomsg-0/src/utils/sleep.c
nanomsg-0/src/utils/efd_socketpair.inc
nanomsg-0/src/utils/err.c
nanomsg-0/src/utils/clock.h
nanomsg-0/src/utils/efd_win.h
nanomsg-0/src/utils/sleep.h
nanomsg-0/src/utils/fast.h
nanomsg-0/src/utils/cont.h
nanomsg-0/src/utils/list.h
nanomsg-0/src/utils/list.c
nanomsg-0/src/utils/chunkref.h
nanomsg-0/src/utils/thread_win.h
nanomsg-0/src/utils/random.h
nanomsg-0/src/utils/err.h
nanomsg-0/src/utils/queue.c
nanomsg-0/src/utils/mutex.c
nanomsg-0/src/utils/glock.c
nanomsg-0/src/utils/queue.h
nanomsg-0/src/utils/thread_win.inc
nanomsg-0/src/utils/mutex.h
nanomsg-0/src/utils/msg.h
nanomsg-0/src/utils/hash.h
nanomsg-0/src/utils/clock.c
nanomsg-0/src/utils/efd_eventfd.inc
nanomsg-0/src/CMakeLists.txt
nanomsg-0/configure.ac
nanomsg-0/libnanomsg.pc.in
nanomsg-0/m4/
nanomsg-0/m4/ltsugar.m4
nanomsg-0/m4/lt~obsolete.m4
nanomsg-0/m4/libtool.m4
nanomsg-0/m4/ax_pthread.m4
nanomsg-0/m4/ltversion.m4
nanomsg-0/m4/dolt.m4
nanomsg-0/m4/ltoptions.m4
nanomsg-0/Makefile.am
nanomsg-0/doc/
nanomsg-0/doc/nn_inproc.7
nanomsg-0/doc/nn_send.3
nanomsg-0/doc/nn_close.3
nanomsg-0/doc/nn_freemsg.3
nanomsg-0/doc/nn_device.3
nanomsg-0/doc/nn_shutdown.3
nanomsg-0/doc/nn_pubsub.7
nanomsg-0/doc/nn_survey.7
nanomsg-0/doc/nn_symbol.3
nanomsg-0/doc/nn_term.3
nanomsg-0/doc/asciidoc.conf.in
nanomsg-0/doc/nn_bind.3
nanomsg-0/doc/nn_recv.3
nanomsg-0/doc/nn_setsockopt.3
nanomsg-0/doc/nn_strerror.3
nanomsg-0/doc/nn_recvmsg.3
nanomsg-0/doc/nn_allocmsg.3
nanomsg-0/doc/nn_ipc.7
nanomsg-0/doc/nn_connect.3
nanomsg-0/doc/nn_cmsg.3
nanomsg-0/doc/nn_fanout.7
nanomsg-0/doc/nn_sendmsg.3
nanomsg-0/doc/nn_socket.3
nanomsg-0/doc/nn_errno.3
nanomsg-0/doc/nn_getsockopt.3
nanomsg-0/doc/nn_tcp.7
nanomsg-0/doc/nn_fanin.7
nanomsg-0/doc/nn_pair.7
nanomsg-0/doc/nn_reqrep.7
nanomsg-0/doc/nanomsg.7
nanomsg-0/doc/CMakeLists.txt
nanomsg-0/doc/nn_bus.7
nanomsg-0/missing
nanomsg-0/.version
nanomsg-0/CMakeLists.txt
nanomsg-0/test-driver
nanomsg-0/compile

I just have to make sure the install target installs them even on
--disable-doc

lu

Other related posts: