yahns Ruby server user/dev discussion
 help / color / mirror / code / Atom feed
From: Eric Wong <e@80x24.org>
To: yahns-public@yhbt.net
Subject: [PUSHED] doc: switch to perlpod (from pandoc-flavored Markdown)
Date: Sun, 14 Feb 2016 11:28:56 +0000	[thread overview]
Message-ID: <20160214112856.GA17497@dcvr.yhbt.net> (raw)

pod2man(1) and pod2text(1) are already installed on most modern
GNU/Linix systems including Debian and RedHat-based systems;
pandoc(1) and Haskell are not, and we do not wish to waste
precious bandwidth and disk space of potential packagers.

perlpod(1) is also better standardized than any Markdown flavor,
especially when it comes to generating manpages.

Finally, I'm mildly proficient at Perl (it is similar to Ruby)
and can poke around at the source if I encounter breakage.
 Documentation/.gitignore       |   3 +
 Documentation/GNUmakefile      |  27 +-
 Documentation/yahns-rackup.pod | 176 +++++++++++
 Documentation/yahns-rackup.txt | 152 ----------
 Documentation/yahns.pod        |  97 +++++++
 Documentation/yahns.txt        |  72 -----
 Documentation/yahns_config.pod | 641 +++++++++++++++++++++++++++++++++++++++++
 Documentation/yahns_config.txt | 584 -------------------------------------
 Rakefile                       |   5 +
 9 files changed, 945 insertions(+), 812 deletions(-)
 create mode 100644 Documentation/yahns-rackup.pod
 delete mode 100644 Documentation/yahns-rackup.txt
 create mode 100644 Documentation/yahns.pod
 delete mode 100644 Documentation/yahns.txt
 create mode 100644 Documentation/yahns_config.pod
 delete mode 100644 Documentation/yahns_config.txt

<snip>  Big indentation changes necessary, so it breaks
rename detection.  Full patch here:


             reply	other threads:[~2016-02-14 11:28 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-02-14 11:28 Eric Wong [this message]
2016-02-14 11:29 ` [PATCH 1/2] doc: trim down documentation slightly Eric Wong
2016-02-14 11:33 ` [PATCH 2/2] doc: document ssl_ctx for "listen" directive Eric Wong
2016-02-14 21:33 ` [PATCH 3/2] doc: various doc and linkification improvements Eric Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

  List information: https://yhbt.net/yahns/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20160214112856.GA17497@dcvr.yhbt.net \
    --to=e@80x24.org \
    --cc=yahns-public@yhbt.net \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox


This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).