Re: The downside of math::

From	Johannes Berg <johannes@sipsolutions.net>
Newsgroups	linux.kernel
Subject	Re: The downside of math::
Date	2016-10-24 10:30 +0200
Message-ID	<svINQ-53o-19@gated-at.bofh.it> (permalink)
References	(2 earlier) <sumZ3-wo-19@gated-at.bofh.it> <suPHH-2MQ-21@gated-at.bofh.it> <svoFr-8iu-1@gated-at.bofh.it> <svIkN-4BM-11@gated-at.bofh.it> <svINQ-53o-21@gated-at.bofh.it>
Organization	linux.* mail to news gateway

Show all headers | View raw

> 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. 

Agree.

> 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.

All of that would be easy to achieve with something like the dummy
plugin I posted the other day :)


But yes, I also agree that we shouldn't add any dependencies where the
input isn't suitable as a fallback, since that also means that the
input is going to be difficult to read and write in the source, which
should remain a reasonable way to read things as well.

johannes

Thread

The downside of math:: Jonathan Corbet <corbet@lwn.net> - 2016-10-20 01:10 +0200
  Re: The downside of math:: Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-20 02:30 +0200
    Re: The downside of math:: Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-20 02:50 +0200
    Re: The downside of math:: Jani Nikula <jani.nikula@linux.intel.com> - 2016-10-20 17:00 +0200
      Re: The downside of math:: Markus Heiser <markus.heiser@darmarit.de> - 2016-10-20 17:20 +0200
      Re: The downside of math:: Jonathan Corbet <corbet@lwn.net> - 2016-10-21 23:40 +0200
        Re: The downside of math:: Markus Heiser <markus.heiser@darmarit.de> - 2016-10-23 13:00 +0200
          Re: The downside of math:: Johannes Berg <johannes@sipsolutions.net> - 2016-10-24 10:00 +0200
            Re: The downside of math:: Johannes Berg <johannes@sipsolutions.net> - 2016-10-24 10:30 +0200
              Re: The downside of math:: Jani Nikula <jani.nikula@linux.intel.com> - 2016-10-24 11:10 +0200
            Re: The downside of math:: Jani Nikula <jani.nikula@linux.intel.com> - 2016-10-24 10:30 +0200

csiph-web