Re: [PATCH 2/2] doc: add a hint about field processor support availability

Subject:Re: [PATCH 2/2] doc: add a hint about field processor support availability

Date:Sun, 12 Jan 2020 17:13:59 +0200

To:Jani Nikula ,notmuch@notmuchmail.org

Cc:

From:Tomi Ollila


On Sat, Jan 11 2020, Jani Nikula wrote:

> In most cases the documentation and the notmuch binary will be built
> on the same machine and the same dependencies. Hint at the field
> processor support availability in the man page based on the
> documentation build host.

I have to still grasp the TAGOPTS line in previous and this message =D

But, if we already made Xapian 1.4 minimun requirement in the next notmuch
release, there XAPIAN_FIELD_PROCESSOR is always supported and all these
conditionals could be removed (before even adding new)...

Tomi

> ---
>  doc/Makefile.local                | 2 +-
>  doc/man7/notmuch-search-terms.rst | 8 ++++++++
>  2 files changed, 9 insertions(+), 1 deletion(-)
>
> diff --git a/doc/Makefile.local b/doc/Makefile.local
> index c78aea49a108..cb01306c0b7c 100644
> --- a/doc/Makefile.local
> +++ b/doc/Makefile.local
> @@ -9,7 +9,7 @@ DOCBUILDDIR      := $(dir)/_build
>  
>  # Configure options to be added as Sphinx tags.
>  # Add "-t <tag>" for each make variable in TAGS that equals 1.
> -TAGS := WITH_EMACS
> +TAGS := WITH_EMACS HAVE_XAPIAN_FIELD_PROCESSOR
>  TAGOPTS := $(patsubst %=1,-t %,$(filter %=1,$(foreach tag,$(TAGS),$(tag)=$(value $(tag)))))
>  
>  # Internal variables.
> diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst
> index 1dd2dc5813f5..9e3b9398c58d 100644
> --- a/doc/man7/notmuch-search-terms.rst
> +++ b/doc/man7/notmuch-search-terms.rst
> @@ -457,6 +457,14 @@ notmuch was built against a sufficiently recent version of Xapian by running
>  
>    % notmuch config get built_with.field_processor
>  
> +.. only:: HAVE_XAPIAN_FIELD_PROCESSOR
> +
> +   The documentation was built on a host with field processor support.
> +
> +.. only:: not HAVE_XAPIAN_FIELD_PROCESSOR
> +
> +   The documentation was built on a host without field processor support.
> +
>  Currently the following features require field processor support:
>  
>  - non-range date queries, e.g. "date:today"
> -- 
> 2.20.1
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> https://notmuchmail.org/mailman/listinfo/notmuch
_______________________________________________
notmuch mailing list
notmuch@notmuchmail.org
https://notmuchmail.org/mailman/listinfo/notmuch

Thread: