From: Jani Nikula <jani.nikula@linux.intel.com>
To: Johannes Berg <johannes@sipsolutions.net>,
Markus Heiser <markus.heiser@darmarit.de>,
Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
LKML Mailing List <linux-kernel@vger.kernel.org>,
linux-doc@vger.kernel.org
Subject: Re: The downside of math::
Date: Mon, 24 Oct 2016 11:22:21 +0300 [thread overview]
Message-ID: <874m42p35u.fsf@intel.com> (raw)
In-Reply-To: <1477295547.4085.8.camel@sipsolutions.net>
On Mon, 24 Oct 2016, Johannes Berg <johannes@sipsolutions.net> wrote:
> On Sun, 2016-10-23 at 12:58 +0200, Markus Heiser wrote:
>> Further I think we should not generate more (and more) external
>> requirements like e.g. plantuml, Java or reportlab discussed here:
>
> I still disagree, I think we should make it easy to "opt out" for the
> build, but if we're really serious about writing good documentation we
> shouldn't (artificially) limit the tools available.
I'd like to refine: Do not add non-trivial hard dependencies. Do not add
dependencies the lack of which make large parts of generated
documentation useless.
Graceful degradation on unmet dependencies is the key here. Give a build
warn about missing dependencies. Try to do something sensible without
the dependency. For extension directives, all else failing, embed the
raw directive block contents using in the output, possibly accompanied
by a reStructuredText admonition block [1]. For the math and diagram
directives, I think this would work just fine.
BR,
Jani.
[1] http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions
--
Jani Nikula, Intel Open Source Technology Center
next prev parent reply other threads:[~2016-10-24 8:22 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-19 23:02 The downside of math:: Jonathan Corbet
2016-10-20 0:26 ` Mauro Carvalho Chehab
2016-10-20 0:48 ` Mauro Carvalho Chehab
2016-10-20 14:55 ` Jani Nikula
2016-10-20 15:15 ` Markus Heiser
2016-10-21 21:38 ` Jonathan Corbet
2016-10-23 10:58 ` Markus Heiser
2016-10-24 7:52 ` Johannes Berg
2016-10-24 8:22 ` Jani Nikula [this message]
2016-10-24 8:26 ` Johannes Berg
2016-10-24 9:06 ` Jani Nikula
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:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=874m42p35u.fsf@intel.com \
--to=jani.nikula@linux.intel.com \
--cc=corbet@lwn.net \
--cc=johannes@sipsolutions.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
--cc=mchehab@s-opensource.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* 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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.