summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/todo/configurable_markdown_path.mdwn39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/todo/configurable_markdown_path.mdwn b/doc/todo/configurable_markdown_path.mdwn
index 2d67aabac..b8b4f06e6 100644
--- a/doc/todo/configurable_markdown_path.mdwn
+++ b/doc/todo/configurable_markdown_path.mdwn
@@ -18,3 +18,42 @@ determine which Perl module to use.
>
> I would not recommend using Gruber's perl markdown. It is old, terminally
> buggy, and unmaintained. --[[Joey]] [[!tag reviewed]]
+
+----
+
+I wasn't trying to make an external markdown the default, I was trying
+to make the currently hardcoded `/usr/bin/markdown` configurable. It
+should only use an external process if `markdown_path` is set, which
+it is not by default. Consider the following tests from clean checkouts:
+
+Current ikiwiki trunk:
+
+ $ PERL5LIB="." time ikiwiki --setup docwiki.setup
+ ...
+ 38.73user 0.62system 1:20.90elapsed 48%CPU (0avgtext+0avgdata 103040maxresident)k
+ 0inputs+6472outputs (0major+19448minor)pagefaults 0swaps
+
+My mdwn branch:
+
+ $ PERL5LIB="." time ikiwiki --setup docwiki.setup
+ ...
+ Markdown: Text::Markdown::markdown()
+ ...
+ 39.17user 0.73system 1:21.77elapsed 48%CPU (0avgtext+0avgdata 103072maxresident)k
+ 0inputs+6472outputs (0major+19537minor)pagefaults 0swaps
+
+My mdwn branch with `markdown_path => "/usr/bin/markdown"` added in
+`docwiki.setup` (on my system, `/usr/bin/markdown` is a command-line
+wrapper for `Text::Markdown::markdown`).
+
+ $ PERL5LIB="." time ikiwiki --setup docwiki.setup
+ ...
+ Markdown: /usr/bin/markdown
+ ...
+ 175.35user 18.99system 6:38.19elapsed 48%CPU (0avgtext+0avgdata 92320maxresident)k
+ 0inputs+17608outputs (0major+2189080minor)pagefaults 0swaps
+
+So my patch doesn't make ikiwiki slow unless the user explicitly
+requests an extenral markdown, which they would presumably only do to
+work around bugs in their system's Perl implementation.
+ -- [[wtk]]