All of lore.kernel.org
 help / color / mirror / Atom feed
From: Johannes Berg <johannes@sipsolutions.net>
To: Markus Heiser <markus.heiser@darmarit.de>,
	Jonathan Corbet <corbet@lwn.net>,
	Jani Nikula <jani.nikula@linux.intel.com>
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 09:52:27 +0200	[thread overview]
Message-ID: <1477295547.4085.8.camel@sipsolutions.net> (raw)
In-Reply-To: <3D1565DE-2513-4326-9FFC-6DF713238B51@darmarit.de>

On Sun, 2016-10-23 at 12:58 +0200, Markus Heiser wrote:

> If you don't want to see a warning log, we have to consider 
> a solution like Johannes Berg posted here:
> 
>  https://www.mail-archive.com/linux-doc@vger.kernel.org/msg07071.html
> 
> @johannes: since this thread and our "sequence diagrams" thread
> addressing the same questions (how should we handle dependencies from
> extensions) I propose to continue the discussion here in this thread
> with Jon.

Sure.

As I said before, regarding the annoying "while (build fails)" loop
mentioned above - I think that's actually somewhat *better* than just
(silently?) failing the build because some dependency wasn't there.

Perhaps, with my code suitably adjusted (should be easy), we could
provide some kind of command line option like "DISABLE_PLUGINS=xyz" so
you could just build as though you had no plugins installed, to avoid
all the follow-up errors. (We'd implement this by changing my dummy
code to also pass the import statement, like this:

setup = create_setup("sphinxcontrib.plantuml", ["uml"])

and moving the try/except clause into the dummy, and then that can read
the environment variable easily and avoid even trying to import when
it's set - that way, no dependencies can be needed.

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

Sure, we probably shouldn't add seqdiag, plantuml, and others that all
the do the same thing - if only for the sake of consistency in the
generated output! - but having the ability to have such things is very
nice and helpful for documentation.

johannes

  reply	other threads:[~2016-10-24  7:52 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 [this message]
2016-10-24  8:22           ` Jani Nikula
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=1477295547.4085.8.camel@sipsolutions.net \
    --to=johannes@sipsolutions.net \
    --cc=corbet@lwn.net \
    --cc=jani.nikula@linux.intel.com \
    --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.