build: add dedicated docs target

Introduce a 'docs' target which only builds the documentation. This
avoids overhead in the CI build and reduces dependencies when building
just the documentation.

Signed-off-by: Daniel Wagner <[email protected]>

Author: igaw

Documentation/meson.build

@@ -302,7 +302,7 @@ if want_docs != 'false'
                             '@INPUT@',
                         ],
                     )
-                    custom_target(
+                    doc_tgts += custom_target(
                         adoc.underscorify() + '_man',
                         input: xml,
                         output: '@[email protected]',
@@ -330,7 +330,7 @@ if want_docs != 'false'
                     output: adoc + '.hsubst',
                     configuration: substs,
                 )
-                custom_target(
+                doc_tgts += custom_target(
                     adoc.underscorify() + '_html',
                     input: subst,
                     output: '@[email protected]',

libnvme/doc/meson.build

@@ -62,7 +62,7 @@ if want_docs != 'false'
                 c = run_command(list_man_pages, apif, check: true)
                 man_pages = c.stdout().split()
                 foreach page : man_pages
-                    custom_target(
+                    doc_tgts += custom_target(
                         page.underscorify() + '_man',
                         input: apif,
                         output: page + '.2',
@@ -94,7 +94,7 @@ if want_docs != 'false'
         htmldir = join_paths(get_option('htmldir'), 'nvme')
         sphinx_build = find_program('sphinx-build-3', 'sphinx-build')
         if sphinx_build.found() and want_docs_build
-            custom_target(
+            doc_tgts += custom_target(
                 'generate_doc_html',
                 input: [static_sources, rst],
                 output: 'html',

libnvme/doc/rst/meson.build

@@ -16,7 +16,7 @@ if want_docs != 'false'
                     output: '@[email protected]',
                     configuration: rst_conf,
                 )
-                rst = custom_target(
+                doc_tgts += custom_target(
                     apif.underscorify() + '_rst',
                     input: subst,
                     output: '@[email protected]',

meson.build

@@ -464,6 +464,8 @@ substs.set('VERSION_MAJOR', libnvme_so_version.split('.')[0])
 
 
 ################################################################################
+doc_tgts = []
+
 subdir('ccan')      # declares: ccan_dep
 subdir('libnvme')   # declares: libnvme_dep
 
@@ -607,6 +609,17 @@ if want_nvme
     subdir('Documentation')
 endif
 
+if doc_tgts.length() == 0
+    doc_tgts += custom_target(
+        'docs-dummy',
+        output: 'docs.stamp',
+        command: ['true'],
+        build_by_default: false,
+    )
+endif
+
+alias_target('docs', doc_tgts)
+
 
 ################################################################################
 path_dict = {

scripts/build.sh

@@ -31,6 +31,7 @@ usage() {
     echo "  coverage            build coverage report"
     echo "  distro              build libnvme and nvme-cli separately"
     echo "  docs                build all documentation"
+    echo "  man_docs            build man documentation only"
     echo "  html_docs           build html documentation only"
     echo "  rst_docs            build rst documentation only"
     echo "  static              build a static binary"
@@ -153,18 +154,22 @@ config_meson_coverage() {
 
 config_meson_docs() {
     CC="${CC}" "${MESON}" setup                 \
-        -Dnvme=disabled                         \
-        -Dlibnvme=disabled                      \
         -Ddocs=all                              \
         -Ddocs-build=true                       \
         --prefix=/tmp/usr                       \
         "${BUILDDIR}"
 }
 
+config_meson_man_docs() {
+    CC="${CC}" "${MESON}" setup                 \
+        -Ddocs=man                              \
+        -Ddocs-build=true                       \
+        --prefix=/tmp/usr                       \
+        "${BUILDDIR}"
+}
+
 config_meson_html_docs() {
     CC="${CC}" "${MESON}" setup                 \
-        -Dnvme=disabled                         \
-        -Dlibnvme=disabled                      \
         -Ddocs=html                             \
         -Ddocs-build=true                       \
         --prefix=/tmp/usr                       \
@@ -173,8 +178,6 @@ config_meson_html_docs() {
 
 config_meson_rst_docs() {
     CC="${CC}" "${MESON}" setup                 \
-        -Dnvme=disabled                         \
-        -Dlibnvme=disabled                      \
         -Ddocs=rst                              \
         -Ddocs-build=true                       \
         --prefix=/tmp/usr                       \
@@ -252,6 +255,30 @@ build_meson() {
         -C "${BUILDDIR}"
 }
 
+build_meson_docs() {
+    "${MESON}" compile                          \
+        -C "${BUILDDIR}"                        \
+		docs
+}
+
+build_meson_man_docs() {
+    "${MESON}" compile                          \
+        -C "${BUILDDIR}"                        \
+		docs
+}
+
+build_meson_html_docs() {
+    "${MESON}" compile                          \
+        -C "${BUILDDIR}"                        \
+		docs
+}
+
+build_meson_rst_docs() {
+    "${MESON}" compile                          \
+        -C "${BUILDDIR}"                        \
+		docs
+}
+
 test_meson() {
     local args=(-C "${BUILDDIR}")
 
@@ -266,6 +293,22 @@ test_meson() {
     "${MESON}" test "${args[@]}"
 }
 
+test_meson_docs() {
+	true
+}
+
+test_meson_man_docs() {
+	true
+}
+
+test_meson_html_docs() {
+	true
+}
+
+test_meson_rst_docs() {
+	true
+}
+
 test_meson_coverage() {
     "${MESON}" test                             \
         -C "${BUILDDIR}"