From c0f61809faa86228b958f8b7e12d0d98faae3c4c Mon Sep 17 00:00:00 2001 From: Andres Freund Date: Wed, 29 Mar 2023 15:33:49 -0700 Subject: [PATCH v4 3/6] meson: add docs, docs_pdf options --- meson.build | 37 ++++++++++++++++++++++++++++++++++ meson_options.txt | 9 +++++++++ doc/src/sgml/installation.sgml | 33 ++++++++++++++++++++++++++++++ doc/src/sgml/meson.build | 21 ++++++------------- 4 files changed, 85 insertions(+), 15 deletions(-) diff --git a/meson.build b/meson.build index 61e94be8641..1f2ec448684 100644 --- a/meson.build +++ b/meson.build @@ -341,6 +341,8 @@ program_zstd = find_program(get_option('ZSTD'), native: true, required: false) dtrace = find_program(get_option('DTRACE'), native: true, required: get_option('dtrace')) missing = find_program('config/missing', native: true) cp = find_program('cp', required: false, native: true) +xmllint_bin = find_program(get_option('XMLLINT'), native: true, required: false) +xsltproc_bin = find_program(get_option('XSLTPROC'), native: true, required: false) bison_flags = [] if bison.found() @@ -567,6 +569,39 @@ endif +############################################################### +# Option: docs in HTML and man page format +############################################################### + +docs_opt = get_option('docs') +docs_dep = not_found_dep +if not docs_opt.disabled() + if xmllint_bin.found() and xsltproc_bin.found() + docs_dep = declare_dependency() + elif docs_opt.enabled() + error('missing required tools for docs in HTML / man page format') + endif +endif + + + +############################################################### +# Option: docs in PDF format +############################################################### + +docs_pdf_opt = get_option('docs_pdf') +docs_pdf_dep = not_found_dep +if not docs_pdf_opt.disabled() + fop = find_program(get_option('FOP'), native: true, required: docs_pdf_opt) + if xmllint_bin.found() and xsltproc_bin.found() and fop.found() + docs_pdf_dep = declare_dependency() + elif docs_pdf_opt.enabled() + error('missing required tools for docs in PDF format') + endif +endif + + + ############################################################### # Library: GSSAPI ############################################################### @@ -3322,6 +3357,8 @@ if meson.version().version_compare('>=0.57') { 'bonjour': bonjour, 'bsd_auth': bsd_auth, + 'docs': docs_dep, + 'docs_pdf': docs_pdf_dep, 'gss': gssapi, 'icu': icu, 'ldap': ldap, diff --git a/meson_options.txt b/meson_options.txt index 4402dd4299d..c203dcce6fe 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -79,6 +79,12 @@ option('bonjour', type : 'feature', value: 'auto', option('bsd_auth', type : 'feature', value: 'auto', description: 'build with BSD Authentication support') +option('docs', type : 'feature', value: 'auto', + description: 'documentation in HTML and man page format') + +option('docs_pdf', type : 'feature', value: 'auto', + description: 'documentation in PDF format') + option('dtrace', type : 'feature', value: 'disabled', description: 'DTrace support') @@ -159,6 +165,9 @@ option('DTRACE', type : 'string', value: 'dtrace', option('FLEX', type : 'array', value: ['flex', 'win_flex'], description: 'path to flex binary') +option('FOP', type : 'string', value: 'fop', + description: 'path to fop binary') + option('GZIP', type : 'string', value: 'gzip', description: 'path to gzip binary') diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml index 70ab5b77d86..8b87a274fcb 100644 --- a/doc/src/sgml/installation.sgml +++ b/doc/src/sgml/installation.sgml @@ -2893,6 +2893,39 @@ ninja install + + Documentation + + + See for the tools needed for building + the documentation. + + + + + + + + + Enables the building of documentation in HTML and + man format. It defaults to auto. + + + + + + + + + Enables the building of documentation in PDF + format. It defaults to auto. + + + + + + + Miscellaneous diff --git a/doc/src/sgml/meson.build b/doc/src/sgml/meson.build index 66c0061e96b..7719adfc73b 100644 --- a/doc/src/sgml/meson.build +++ b/doc/src/sgml/meson.build @@ -5,9 +5,6 @@ installdocs = [] alldocs = [] doc_generated = [] -xmllint_bin = find_program(get_option('XMLLINT'), native: true, required: false) - - version_sgml = configure_file( input: 'version.sgml.in', output: 'version.sgml', @@ -68,8 +65,6 @@ if not xmllint_bin.found() endif pandoc = find_program('pandoc', native: true, required: false) -xsltproc_bin = find_program(get_option('XSLTPROC'), native: true, required: false) -fop = find_program('fop', native: true, required: false) xmltools_wrapper = [ python, files('xmltools_dep_wrapper'), @@ -113,7 +108,7 @@ endif # # Full documentation as html, text # -if xsltproc_bin.found() +if docs_dep.found() xsltproc_html_flags = xsltproc_flags + [ '--param', 'website.stylesheet', '1' ] @@ -204,7 +199,7 @@ endif # # Man pages # -if xsltproc_bin.found() +if docs_dep.found() # FIXME: implement / consider sqlmansectnum logic man = custom_target('man', input: ['stylesheet-man.xsl', postgres_full_xml], @@ -233,7 +228,7 @@ endif # # Full documentation as PDF # -if fop.found() and xsltproc_bin.found() +if docs_pdf_dep.found() xsltproc_fo_flags = xsltproc_flags + [ '--stringparam', 'img.src.path', meson.current_source_dir() + '/' ] @@ -291,7 +286,7 @@ db2x_xsltproc = find_program('db2x_xsltproc', native: true, required: false) db2x_texixml = find_program('db2x_texixml', native: true, required: false) makeinfo = find_program('makeinfo', native: true, required: false) -if db2x_texixml.found() and db2x_xsltproc.found() and makeinfo.found() +if xsltproc_bin.found() and db2x_texixml.found() and db2x_xsltproc.found() and makeinfo.found() postgres_texixml = custom_target('postgres.texixml', output: 'postgres.texixml', command: [db2x_xsltproc, '-s', 'texi', @@ -315,15 +310,11 @@ if db2x_texixml.found() and db2x_xsltproc.found() and makeinfo.found() endif -if docs.length() == 0 - run_target('docs', command: [missing, 'xsltproc']) -else +if docs_dep.found() alias_target('docs', docs) alias_target('install-docs', installdocs) endif -if alldocs.length() == 0 - run_target('alldocs', command: [missing, 'xsltproc']) -else +if alldocs.length() != 0 alias_target('alldocs', alldocs) endif -- 2.38.0