From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <david@tethera.net>
Received: from localhost (localhost [127.0.0.1])
 by arlo.cworth.org (Postfix) with ESMTP id 0B3E96DE12BD
 for <notmuch@notmuchmail.org>; Tue, 19 Mar 2019 16:41:40 -0700 (PDT)
X-Virus-Scanned: Debian amavisd-new at cworth.org
X-Spam-Flag: NO
X-Spam-Score: -0.015
X-Spam-Level: 
X-Spam-Status: No, score=-0.015 tagged_above=-999 required=5
 tests=[AWL=-0.014, SPF_PASS=-0.001] autolearn=disabled
Received: from arlo.cworth.org ([127.0.0.1])
 by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)
 with ESMTP id GqYldh8a7mN0 for <notmuch@notmuchmail.org>;
 Tue, 19 Mar 2019 16:41:38 -0700 (PDT)
Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197])
 by arlo.cworth.org (Postfix) with ESMTPS id 7620D6DE12B7
 for <notmuch@notmuchmail.org>; Tue, 19 Mar 2019 16:41:38 -0700 (PDT)
Received: from remotemail by fethera.tethera.net with local (Exim 4.89)
 (envelope-from <david@tethera.net>)
 id 1h6OMR-0000kO-2T; Tue, 19 Mar 2019 19:41:35 -0400
Received: (nullmailer pid 24975 invoked by uid 1000);
 Tue, 19 Mar 2019 23:41:33 -0000
From: David Bremner <david@tethera.net>
To: Jani Nikula <jani@nikula.org>, notmuch@notmuchmail.org
Subject: Re: [PATCH] doc: add support for adding configure options as Sphinx
 tags
In-Reply-To: <20190319190146.26155-1-jani@nikula.org>
References: <20190319190146.26155-1-jani@nikula.org>
Date: Tue, 19 Mar 2019 20:41:33 -0300
Message-ID: <875zse5t5e.fsf@tethera.net>
MIME-Version: 1.0
Content-Type: text/plain
X-BeenThere: notmuch@notmuchmail.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Use and development of the notmuch mail system."
 <notmuch.notmuchmail.org>
List-Unsubscribe: <https://notmuchmail.org/mailman/options/notmuch>,
 <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
List-Archive: <http://notmuchmail.org/pipermail/notmuch/>
List-Post: <mailto:notmuch@notmuchmail.org>
List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
List-Subscribe: <https://notmuchmail.org/mailman/listinfo/notmuch>,
 <mailto:notmuch-request@notmuchmail.org?subject=subscribe>
X-List-Received-Date: Tue, 19 Mar 2019 23:41:40 -0000

Jani Nikula <jani@nikula.org> writes:

> Add the configure options specified in $(TAGS) that equal 1 as tags on
> the Sphinx command line using the -t option. The tags may be used to
> conditionally include documentation using the Sphinx "only" directive
> [1].
>
> As an example, indicate in the documentation whether the Xapian field
> processor is likely to be available (assuming the notmuch binary was
> built in the same environment as the documentation).
>
> [1] http://www.sphinx-doc.org/en/stable/markup/misc.html#including-content-based-on-tags
>
> ---
>
> This is something I wrote two years ago, ISTR David asking about
> something like this on IRC, but I've already forgotten what it was
> about...
> ---
>  doc/Makefile.local                | 7 ++++++-
>  doc/man7/notmuch-search-terms.rst | 8 ++++++++
>  2 files changed, 14 insertions(+), 1 deletion(-)
>
> diff --git a/doc/Makefile.local b/doc/Makefile.local
> index bab3d0d286ce..95df9ae82b4f 100644
> --- a/doc/Makefile.local
> +++ b/doc/Makefile.local
> @@ -7,8 +7,13 @@ SPHINXOPTS    := -q
>  SPHINXBUILD   = sphinx-build
>  DOCBUILDDIR      := $(dir)/_build
>  
> +# Configure options to be added as Sphinx tags.
> +# Add "-t <tag>" for each make variable in TAGS that equals 1.
> +TAGS := HAVE_XAPIAN_FIELD_PROCESSOR HAVE_XAPIAN_COMPACT

Is there a good reason TAGS not defined in Makefile.config? Or just a
lack of tuits?

d