From: Karthik Nayak <karthik.188@gmail.com>
Date: Tue, 16 Sep 2025 09:14:56 GMT
Subject: Re: [PATCH 1/3] meson: introduce a "docs" alias to compile documentation only
Message-ID: <CAOLa=ZRVaBp6DAM4gYXFjCRORYxObvWn5egrPAOcGZ42mxnsgg@mail.gmail.com>
In-Reply-To: <20250911-b4-pks-meson-docs-target-v1-1-a92c666ecef9@pks.im>

Patrick Steinhardt <ps@pks.im> writes:

> Meson does not currently provide a target to compile documentation,
> only. Instead, users needs to compile the whole project, which may be
> way more than they really intend to do.
>
> Introduce a new "docs" alias to plug this gap. This alias can be invoked
> e.g. with `meson compile docs`.
>

So earlier we would compile the documentation always (while the
dependencies are met). Now we move this to a "docs" subcommand...

[snip]

> diff --git a/meson.build b/meson.build
> index b3dfcc0497..40b2a2dc54 100644
> --- a/meson.build
> +++ b/meson.build
> @@ -2101,11 +2101,18 @@ endif
>
>  subdir('bin-wrappers')
>  if get_option('docs') != []
> +  doc_targets = []
>    subdir('Documentation')
>  endif
>
>  subdir('contrib')
>
> +# Note that the target is intentionally configured after including the
> +# 'contrib' directory, as some tool there also have their own manpages.
> +if get_option('docs') != []
> +  alias_target('docs', doc_targets)
> +endif
> +

Shouldn't we also add it to 'meson_options.txt' with default set to
true? That would ensure that `meson compile` would also build the docs.

>  exclude_from_check_headers = [
>    'compat/',
>    'unicode-width.h',
>
> --
> 2.51.0.450.g87641ccf93.dirty