Meson build: Add the build-manual option

kjellahl · kjellahl · commit 5073536fd166 · 2024-01-14T10:07:46.000+01:00
diff --git a/docs/docs/manual/meson.build b/docs/docs/manual/meson.build
@@ -3,11 +3,13 @@
 # input: install_datadir, sigcxx_pcname, tutorial_custom_cmd, python3,
 #        build_documentation, book_name, can_add_dist_script, xsltproc
 # output: can_parse_and_validate, build_pdf_by_default, can_build_pdf,
-#         install_tutorialdir
+#         install_tutorialdir, build_manual_opt, build_manual
+
+build_manual_opt = get_option('build-manual')
+build_manual = build_manual_opt and build_documentation
 
 xmllint = find_program('xmllint', required: false)
 can_parse_and_validate = xmllint.found()
-
 validate = get_option('validation') ? 'true' : 'false'
 
 dblatex = find_program('dblatex', required: false)
@@ -18,8 +20,8 @@ build_pdf_by_default = get_option('build-pdf')
 # Installation directories are relative to {prefix}.
 install_tutorialdir = install_datadir / 'doc' / book_name / 'tutorial'
 
-if not build_documentation
-  # Documentation shall not be built or installed.
+if not build_manual
+  # The manual shall not be built or installed.
   # Return to the calling meson.build file.
   subdir_done()
 endif
diff --git a/meson.build b/meson.build
@@ -335,16 +335,29 @@ if build_documentation_opt == 'if-maintainer-mode'
   real_build_documentation = ' (@0@)'.format(build_documentation)
 endif
 
-validate = get_option('validation') and can_parse_and_validate
+explain_man = ''
+if build_manual_opt and not build_manual
+  explain_man = ' (requires that documentation is built)'
+endif
+
+validate = get_option('validation') and can_parse_and_validate and build_manual
 explain_val = ''
 if get_option('validation') and not validate
-  explain_val = ' (requires xmllint with Relax NG and DocBook V5.0 support)'
+  if not build_manual
+    explain_val = ' (requires that the tutorial is built)'
+  else
+    explain_val = ' (requires xmllint with Relax NG and DocBook V5.0 support)'
+  endif
 endif
 
-build_pdf = build_pdf_by_default and can_build_pdf
+build_pdf = build_pdf_by_default and can_build_pdf and build_manual
 explain_pdf = ''
 if build_pdf_by_default and not build_pdf
-  explain_pdf = ' (requires dblatex or (xsltproc and fop))'
+  if not build_manual
+    explain_pdf = ' (requires that the tutorial is built)'
+  else
+    explain_pdf = ' (requires dblatex or (xsltproc and fop))'
+  endif
 endif
 
 summary = [
@@ -357,6 +370,7 @@ summary = [
                              format(cpp_warnings, warning_level, werror),
   '    Build deprecated API: @0@'.format(build_deprecated_api),
   'Build HTML documentation: @0@@1@'.format(build_documentation_opt, real_build_documentation),
+  '          Build tutorial: @0@@1@'.format(build_manual, explain_man),
   '          XML validation: @0@@1@'.format(validate, explain_val),
   '               Build PDF: @0@@1@'.format(build_pdf, explain_pdf),
   '  Build example programs: @0@'.format(build_examples),
diff --git a/meson_options.txt b/meson_options.txt
@@ -8,10 +8,12 @@ option('build-deprecated-api', type: 'boolean', value: true,
   description: 'Build deprecated API and include it in the library')
 option('build-documentation', type: 'combo', choices: ['false', 'if-maintainer-mode', 'true'],
   value: 'if-maintainer-mode', description: 'Build and install the documentation')
+option('build-manual', type: 'boolean', value: true,
+  description: 'Build tutorial HTML files, if documentation is built')
 option('validation', type: 'boolean', value: true,
-  description: 'Validate the tutorial XML file')
+  description: 'Validate the tutorial XML file, if tutorial HTML files are built')
 option('build-pdf', type: 'boolean', value: false,
-  description: 'Build tutorial PDF file')
+  description: 'Build tutorial PDF file, if tutorial HTML files are built')
 option('build-examples', type: 'boolean', value: true,
   description: 'Build example programs')
 option('build-tests', type: 'boolean', value: true,
