diff options
| author | Eric Wong <e@80x24.org> | 2016-02-22 00:23:33 +0000 |
|---|---|---|
| committer | Eric Wong <e@80x24.org> | 2016-02-22 00:29:53 +0000 |
| commit | e2604972452d6d553c9c5bb60bf8637c7213695e (patch) | |
| tree | 5f03030ce42bfe2c1cb055880d9c14bfcd41baa4 | |
| parent | c3b628c5446853e9c16d7f8ebffd6a48343bab33 (diff) | |
| download | yahns-e2604972452d6d553c9c5bb60bf8637c7213695e.tar.gz | |
Remove all pandoc references. We shouldn't need to clutter our documentation with out-of-date references to pandoc, and pod2man is probably widely-available enough that nobody should need to install it. Reduce HTTP redirects when linking to external sites. It's also excessive to mention libkqueue as using the native implementation (whether it be kqueue or epoll) is preferred and easier.
| -rw-r--r-- | Documentation/GNUmakefile | 1 | ||||
| -rw-r--r-- | HACKING | 12 | ||||
| -rw-r--r-- | README | 11 |
3 files changed, 9 insertions, 15 deletions
diff --git a/Documentation/GNUmakefile b/Documentation/GNUmakefile index 6db8d49..ee27399 100644 --- a/Documentation/GNUmakefile +++ b/Documentation/GNUmakefile @@ -6,7 +6,6 @@ INSTALL = install POD2MAN = pod2man -include ../GIT-VERSION-FILE release := yahns $(VERSION) -PANDOC_OPTS = -f markdown --email-obfuscation=none POD2MAN_OPTS = -v -r '$(release)' --stderr -d 1994-10-02 -c 'yahns user manual' pod2man = $(POD2MAN) $(POD2MAN_OPTS) POD2TEXT = pod2text @@ -4,10 +4,10 @@ development dependencies * minitest RubyGem (version 4 or 5, standard in Ruby 2.0+) * curl - http://curl.haxx.se/ - we don't trust our own Ruby abilities :> * dd(1) - standard POSIX tool - to feed curl -* ab - http://httpd.apache.org - for concurrent testing +* ab - http://httpd.apache.org/ - for concurrent testing * GNU make - https://www.gnu.org/software/make/ * git - http://www.git-scm.com/ -* ruby - http://www.ruby-lang.org/ +* ruby - http://www.ruby-lang.org/en/ git clone git://yhbt.net/yahns @@ -32,14 +32,12 @@ V - set to 1 for verbose test output (may be mangled if multithreaded) documentation ------------- -We use pandoc for converting Markdown to (groff) man: - -* pandoc - http://johnmacfarlane.net/pandoc/ +We use pod2man(1) distributed with Perl 5 for generating manpages. installing from git ------------------- -* make install-gem (pandoc is required for generating manpages) +* make install-gem contact ------- @@ -51,7 +49,7 @@ formatted using git-request-pull(1). Mailing list archives: http://yhbt.net/yahns-public/ No subscription is necessary to post to the mailing list. -Please remember to Cc: all recipients. +Please remember to Cc: all recipients as subscription is optional. Copyright (C) 2013-2016 all contributors <yahns-public@yhbt.net> License: GPL-3.0+ <http://www.gnu.org/licenses/gpl-3.0.txt> @@ -102,17 +102,14 @@ multiple threads. 1. blocking acceptors 2. non-blocking event loop workers * epoll (or kqueue) acts as a queue (by using one-shot notifications) -* acceptors accept new clients and put them in the epoll "queue" +* acceptors accept new clients and put them in the queue * workers pull clients off the queue, rearming them to epoll on EAGAIN The end result is clients transition freely and fairly between threads and will always be able to find the next idle thread to run on. -This design works with kqueue, too, and we support kqueue. In fact, got -our design inspiration from the name "kqueue" when working on another -project. We may also support libkqueue: - - http://sourceforge.net/projects/libkqueue/ +The design inspiration from the name "kqueue" when working on another +project. In addition to multiple threads, yahns optionally supports multiple processes to work around low FD limits as well as contention in the: @@ -125,7 +122,7 @@ processes to work around low FD limits as well as contention in the: Copyright --------- -Copyright 2013-2015, all contributors (see git repo). +Copyright 2013-2016, all contributors (see git repo). License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt> yahns is copyrighted Free Software by all contributors, see logs in |