From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S935370AbcJXIW2 (ORCPT ); Mon, 24 Oct 2016 04:22:28 -0400 Received: from mga05.intel.com ([192.55.52.43]:19782 "EHLO mga05.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S934105AbcJXIWY (ORCPT ); Mon, 24 Oct 2016 04:22:24 -0400 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.31,541,1473145200"; d="scan'208";a="776777431" From: Jani Nikula To: Johannes Berg , Markus Heiser , Jonathan Corbet Cc: Mauro Carvalho Chehab , LKML Mailing List , linux-doc@vger.kernel.org Subject: Re: The downside of math:: In-Reply-To: <1477295547.4085.8.camel@sipsolutions.net> Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo References: <20161019170246.339eff9d@lwn.net> <20161019222618.154434f3@vento.lan> <877f93qdd2.fsf@intel.com> <20161021153806.5c9b5d7b@lwn.net> <3D1565DE-2513-4326-9FFC-6DF713238B51@darmarit.de> <1477295547.4085.8.camel@sipsolutions.net> Date: Mon, 24 Oct 2016 11:22:21 +0300 Message-ID: <874m42p35u.fsf@intel.com> MIME-Version: 1.0 Content-Type: text/plain Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Mon, 24 Oct 2016, Johannes Berg 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