Add an 'internals' subfolder to 'docs/kbase' to house all the documents under internals. The output files are still under 'docs/kbase'. Signed-off-by: Peter Krempa <pkrempa@xxxxxxxxxx> --- docs/kbase/index.rst | 4 +- .../incremental-backup.rst} | 0 docs/kbase/internals/meson.build | 55 +++++++++++++++++++ .../migration.rst} | 0 docs/kbase/meson.build | 4 +- 5 files changed, 59 insertions(+), 4 deletions(-) rename docs/kbase/{incrementalbackupinternals.rst => internals/incremental-backup.rst} (100%) create mode 100644 docs/kbase/internals/meson.build rename docs/kbase/{migrationinternals.rst => internals/migration.rst} (100%) diff --git a/docs/kbase/index.rst b/docs/kbase/index.rst index 4e18acd4d9..c6748e8883 100644 --- a/docs/kbase/index.rst +++ b/docs/kbase/index.rst @@ -79,9 +79,9 @@ Debugging Internals --------- -`Incremental backup internals <incrementalbackupinternals.html>`__ +`Incremental backup internals <internals/incremental-backup.html>`__ Incremental backup implementation details relevant for users -`VM migration internals <migrationinternals.html>`__ +`VM migration internals <internals/migration.html>`__ VM migration implementation details, complementing the info in `migration <../migration.html>`__ diff --git a/docs/kbase/incrementalbackupinternals.rst b/docs/kbase/internals/incremental-backup.rst similarity index 100% rename from docs/kbase/incrementalbackupinternals.rst rename to docs/kbase/internals/incremental-backup.rst diff --git a/docs/kbase/internals/meson.build b/docs/kbase/internals/meson.build new file mode 100644 index 0000000000..923e262706 --- /dev/null +++ b/docs/kbase/internals/meson.build @@ -0,0 +1,55 @@ +docs_kbase_internals_files = [ + 'incremental-backup', + 'migration', +] + + +html_xslt_gen_install_dir = docs_html_dir / 'kbase' / 'internals' +html_xslt_gen = [] + +foreach name : docs_kbase_internals_files + rst_file = '@0@.rst'.format(name) + + html_xslt_gen += { + 'name': name, + 'file': docs_rst2html5_gen.process(rst_file), + 'source': 'docs' / 'kbase' / 'internals' / rst_file, + 'href_base': '../../', + } +endforeach + +# keep the XSLT processing code block in sync with docs/meson.build + +# --- begin of XSLT processing --- + +foreach data : html_xslt_gen + html_filename = data['name'] + '.html' + + html_file = custom_target( + html_filename, + input: data.get('file', data['name'] + '.html.in'), + output: html_filename, + command: [ + xsltproc_prog, + '--stringparam', 'pagesrc', data.get('source', ''), + '--stringparam', 'builddir', meson.build_root(), + '--stringparam', 'timestamp', docs_timestamp, + '--stringparam', 'href_base', data.get('href_base', ''), + '--nonet', + site_xsl, + '@INPUT@', + ], + depends: data.get('depends', []), + depend_files: [ page_xsl ], + capture: true, + install: true, + install_dir: html_xslt_gen_install_dir, + ) + + install_web_deps += html_file + install_web_files += html_file.full_path() + ':' + html_xslt_gen_install_dir +endforeach + +html_xslt_gen = [] + +# --- end of XSLT processing --- diff --git a/docs/kbase/migrationinternals.rst b/docs/kbase/internals/migration.rst similarity index 100% rename from docs/kbase/migrationinternals.rst rename to docs/kbase/internals/migration.rst diff --git a/docs/kbase/meson.build b/docs/kbase/meson.build index e37feb6d30..269bf64a94 100644 --- a/docs/kbase/meson.build +++ b/docs/kbase/meson.build @@ -2,7 +2,6 @@ docs_kbase_files = [ 'backing_chains', 'debuglogs', 'domainstatecapture', - 'incrementalbackupinternals', 'index', 'kvm-realtime', 'launch_security_sev', @@ -12,7 +11,6 @@ docs_kbase_files = [ 'locking-sanlock', 'memorydevices', 'merging_disk_image_chains', - 'migrationinternals', 'qemu-core-dump', 'qemu-passthrough-security', 'rpm-deployment', @@ -73,3 +71,5 @@ endforeach html_xslt_gen = [] # --- end of XSLT processing --- + +subdir('internals') -- 2.35.1