Skip to contentSkip to conversation

doc: add install_tag to meson

PATCH In review [email protected] 3 participants 4 messages Dec 23, 2024 – Nov 25, 2025 Arm/Amlogic Meson SoC support

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: add install_tag to meson

From: "[email protected]" <[email protected]>

This allows building and installing only the documentation, without recompiling the whole project, using:

meson build -Denable_docs=true
meson compile -C build doc
meson install -C build --no-rebuild --tags doc

In Debian/Ubuntu the documentation is built separately from the binaries, in a separate architecture-independent build job, so that it has to be done only once, instead of once per supported architecture.

---
This requires meson 0.60, so there's a warning printed as the minimum defined is 0.57, but it's harmless, and the feature is only used when explicitly invoked with --tags, which simply has to be done with newer meson versions. If install --tags is not used, then there's no issue.

 doc/api/meson.build    | 3 +++
 doc/guides/meson.build | 1 +
 2 files changed, 4 insertions(+)
doc/api/meson.build +3 -0
index ac6eb8236d..9b66dce4f3 100644
@@ -27,6 +27,7 @@ example = custom_target('examples.dox',
         depfile: 'examples.dox.d',
         install: get_option('enable_docs'),
         install_dir: htmldir,
+        install_tag: 'doc',
         build_by_default: get_option('enable_docs'))
 
 # set up common Doxygen configuration
@@ -76,6 +77,7 @@ doxy_html_build = custom_target('doxygen-html',
         command: [generate_doxygen, '@OUTPUT@', doxygen, '@INPUT@'],
         install: get_option('enable_docs'),
         install_dir: htmldir,
+        install_tag: 'doc',
         build_by_default: get_option('enable_docs'))
 
 doc_targets += doxy_html_build
@@ -90,6 +92,7 @@ doxy_man_build = custom_target('doxygen-man',
         command: [generate_doxygen, '@OUTPUT@', doxygen, '@INPUT@'],
         install: get_option('enable_docs'),
         install_dir: get_option('datadir'),
+        install_tag: 'doc',
         build_by_default: get_option('enable_docs'))
 
 doc_targets += doxy_man_build
doc/guides/meson.build +1 -0
index f8bbfba9f5..04bfbd1326 100644
@@ -22,6 +22,7 @@ html_guides = custom_target('html_guides',
         depfile: '.html.d',
         build_by_default: get_option('enable_docs'),
         install: get_option('enable_docs'),
+        install_tag: 'doc',
         install_dir: htmldir)
 
 doc_targets += html_guides
Signature · 1 line
2.45.2
Acked-by on v1 1/1
#1 lore raw
Quoted 20 lines · On Mon, Dec 23, 2024 at 01:21:13PM +0000, [email protected] wrote:

From: "[email protected]" <[email protected]>

This allows building and installing only the documentation, without recompiling the whole project, using:

meson build -Denable_docs=true
meson compile -C build doc
meson install -C build --no-rebuild --tags doc

In Debian/Ubuntu the documentation is built separately from the binaries, in a separate architecture-independent build job, so that it has to be done only once, instead of once per supported architecture.

---
This requires meson 0.60, so there's a warning printed as the minimum defined is 0.57, but it's harmless, and the feature is only used when explicitly invoked with --tags, which simply has to be done with newer meson versions. If install --tags is not used, then there's no issue.

Quoted 4 lines
 doc/api/meson.build    | 3 +++
 doc/guides/meson.build | 1 +
 2 files changed, 4 insertions(+)
#2 lore raw
Quoted 22 lines · Bruce Richardson
Quoted 20 lines · On Mon, Dec 23, 2024 at 01:21:13PM +0000, [email protected] wrote:

From: "[email protected]" <[email protected]>

This allows building and installing only the documentation, without recompiling the whole project, using:

meson build -Denable_docs=true
meson compile -C build doc
meson install -C build --no-rebuild --tags doc

In Debian/Ubuntu the documentation is built separately from the binaries, in a separate architecture-independent build job, so that it has to be done only once, instead of once per supported architecture.

---
This requires meson 0.60, so there's a warning printed as the minimum defined is 0.57, but it's harmless, and the feature is only used when explicitly invoked with --tags, which simply has to be done with newer meson versions. If install --tags is not used, then there's no issue.

Quoted 5 lines
Quoted 4 lines
 doc/api/meson.build    | 3 +++
 doc/guides/meson.build | 1 +
 2 files changed, 4 insertions(+)

Hi Thomas, looks like this was never applied? Is there anything missing? Thanks

#3 lore raw
In reply to Bruce Richardson

06/01/2025 11:29, Bruce Richardson:

Quoted 21 lines · On Mon, Dec 23, 2024 at 01:21:13PM +0000, [email protected] wrote:
Quoted 20 lines

From: "[email protected]" <[email protected]>

This allows building and installing only the documentation, without recompiling the whole project, using:

meson build -Denable_docs=true
meson compile -C build doc
meson install -C build --no-rebuild --tags doc

In Debian/Ubuntu the documentation is built separately from the binaries, in a separate architecture-independent build job, so that it has to be done only once, instead of once per supported architecture.

---
This requires meson 0.60, so there's a warning printed as the minimum defined is 0.57, but it's harmless, and the feature is only used when explicitly invoked with --tags, which simply has to be done with newer meson versions. If install --tags is not used, then there's no issue.

Quoted 5 lines
Quoted 4 lines
 doc/api/meson.build    | 3 +++
 doc/guides/meson.build | 1 +
 2 files changed, 4 insertions(+)

This patch was missed.
Applied, thanks.