]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: Move all images to a subdirectory
authorAndrea Bolognani <abologna@redhat.com>
Tue, 21 Dec 2021 11:11:25 +0000 (12:11 +0100)
committerAndrea Bolognani <abologna@redhat.com>
Tue, 4 Jan 2022 14:47:25 +0000 (15:47 +0100)
This unclutters the top-level docs directory.

Signed-off-by: Andrea Bolognani <abologna@redhat.com>
Reviewed-by: Ani Sinha <ani@anisinha.ca>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
31 files changed:
docs/api.rst
docs/goals.html.in
docs/images/event_loop_simple.png [moved from docs/event_loop_simple.png with 100% similarity]
docs/images/event_loop_simple.svg [moved from docs/event_loop_simple.svg with 100% similarity]
docs/images/event_loop_worker.png [moved from docs/event_loop_worker.png with 100% similarity]
docs/images/event_loop_worker.svg [moved from docs/event_loop_worker.svg with 100% similarity]
docs/images/libvirt-daemon-arch.png [moved from docs/libvirt-daemon-arch.png with 100% similarity]
docs/images/libvirt-daemon-arch.svg [moved from docs/libvirt-daemon-arch.svg with 100% similarity]
docs/images/libvirt-driver-arch.png [moved from docs/libvirt-driver-arch.png with 100% similarity]
docs/images/libvirt-driver-arch.svg [moved from docs/libvirt-driver-arch.svg with 100% similarity]
docs/images/libvirt-object-model.png [moved from docs/libvirt-object-model.png with 100% similarity]
docs/images/libvirt-object-model.svg [moved from docs/libvirt-object-model.svg with 100% similarity]
docs/images/libvirt-virConnect-example.png [moved from docs/libvirt-virConnect-example.png with 100% similarity]
docs/images/libvirt-virConnect-example.svg [moved from docs/libvirt-virConnect-example.svg with 100% similarity]
docs/images/meson.build [new file with mode: 0644]
docs/images/migration-managed-direct.png [moved from docs/migration-managed-direct.png with 100% similarity]
docs/images/migration-managed-direct.svg [moved from docs/migration-managed-direct.svg with 100% similarity]
docs/images/migration-managed-p2p.png [moved from docs/migration-managed-p2p.png with 100% similarity]
docs/images/migration-managed-p2p.svg [moved from docs/migration-managed-p2p.svg with 100% similarity]
docs/images/migration-native.png [moved from docs/migration-native.png with 100% similarity]
docs/images/migration-native.svg [moved from docs/migration-native.svg with 100% similarity]
docs/images/migration-tunnel.png [moved from docs/migration-tunnel.png with 100% similarity]
docs/images/migration-tunnel.svg [moved from docs/migration-tunnel.svg with 100% similarity]
docs/images/migration-unmanaged-direct.png [moved from docs/migration-unmanaged-direct.png with 100% similarity]
docs/images/migration-unmanaged-direct.svg [moved from docs/migration-unmanaged-direct.svg with 100% similarity]
docs/images/node.gif [moved from docs/node.gif with 100% similarity]
docs/images/node.svg [moved from docs/node.svg with 100% similarity]
docs/internals.html.in
docs/internals/eventloop.html.in
docs/meson.build
docs/migration.rst

index a8f527e197ac225eb6e4e362d13e79bbc06f559a..d9f01fb403c72ddf531aa91e09cb1d7d135f79c4 100644 (file)
@@ -260,6 +260,6 @@ rules and guidelines. In order to add new API functionality follow the
 instructions regarding `implementing a new API in
 libvirt <api_extension.html>`__.
 
-.. |first class objects exposed by the API| image:: libvirt-object-model.png
-.. |The libvirt driver architecture| image:: libvirt-driver-arch.png
-.. |The libvirt daemon and remote architecture| image:: libvirt-daemon-arch.png
+.. |first class objects exposed by the API| image:: images/libvirt-object-model.png
+.. |The libvirt driver architecture| image:: images/libvirt-driver-arch.png
+.. |The libvirt daemon and remote architecture| image:: images/libvirt-daemon-arch.png
index 39d5e75359810c19bebef63e17171e3e19c8ffa9..d205bf4f423a50926a450ad81ca4aa12a7f0777e 100644 (file)
@@ -15,7 +15,7 @@
     virtualized machine provided by the hypervisor</li>
     </ul>
     <p class="image">
-      <img alt="Hypervisor and domains running on a node" src="node.gif"/>
+      <img alt="Hypervisor and domains running on a node" src="images/node.gif"/>
     </p>
     <p>Now we can define the goal of libvirt: <b> to provide a common and
     stable layer sufficient to securely manage domains on a node, possibly
diff --git a/docs/images/meson.build b/docs/images/meson.build
new file mode 100644 (file)
index 0000000..85a35da
--- /dev/null
@@ -0,0 +1,24 @@
+docs_image_files = [
+  'event_loop_simple.png',
+  'event_loop_worker.png',
+  'libvirt-daemon-arch.png',
+  'libvirt-driver-arch.png',
+  'libvirt-object-model.png',
+  'libvirt-virConnect-example.png',
+  'migration-managed-direct.png',
+  'migration-managed-p2p.png',
+  'migration-native.png',
+  'migration-tunnel.png',
+  'migration-unmanaged-direct.png',
+  'node.gif',
+]
+
+install_data(docs_image_files, install_dir: docs_html_dir / 'images')
+
+foreach file : docs_image_files
+  # This hack enables us to view the web pages
+  # from within the uninstalled build tree
+  configure_file(input: file, output: file, copy: true)
+
+  install_web_files += '@0@:@1@'.format(meson.current_source_dir() / file, docs_html_dir / 'images')
+endforeach
similarity index 100%
rename from docs/node.gif
rename to docs/images/node.gif
similarity index 100%
rename from docs/node.svg
rename to docs/images/node.svg
index 3a96ff73b49f033ce7e70c995471b589d4b412cd..e474f7ddd7bcdb7f0920b04307cf2a308eca6a0f 100644 (file)
@@ -35,7 +35,7 @@
 
     <p class="image">
       <img alt="virConnectOpen calling sequence"
-           src="libvirt-virConnect-example.png"/>
+           src="images/libvirt-virConnect-example.png"/>
     </p>
     <ul>
         <li>"virsh -c qemu:///system list --all"
index aa22ba15cd8dcad3650288e1cb3a334c72bbcc86..1a24254fc565036a526484557aa9be6f8e76c169 100644 (file)
@@ -29,7 +29,7 @@
     not waiting for direct user input and have no graphical
     interface. Such as Libvirt.</p>
 
-    <img alt="event loop" src="../event_loop_simple.png"/>
+    <img alt="event loop" src="../images/event_loop_simple.png"/>
 
     <p>In Libvirt this approach is used in combination with
     <code>poll(2)</code> as all the communication with its
@@ -70,7 +70,7 @@
     acceptable for Libvirt. Therefore we have came up with the
     following solution.</p>
 
-    <img alt="event loop" src="../event_loop_worker.png"/>
+    <img alt="event loop" src="../images/event_loop_worker.png"/>
 
     <p>The event loop does only necessary minimum and hand over
     message processing to another thread. In fact, there can be
index 04e32f7bf1b68b44ca14dc42adc1a91cbf24f489..6f1ca5c6ff6e12c742f48d79080e64550e51d957 100644 (file)
@@ -10,27 +10,15 @@ docs_assets = [
   'android-chrome-256x256.png',
   'apple-touch-icon.png',
   'browserconfig.xml',
-  'event_loop_simple.png',
-  'event_loop_worker.png',
   'favicon.ico',
   'favicon-16x16.png',
   'favicon-32x32.png',
   'generic.css',
   'libvirt.css',
-  'libvirt-daemon-arch.png',
-  'libvirt-driver-arch.png',
-  'libvirt-object-model.png',
-  'libvirt-virConnect-example.png',
   'main.css',
   'manifest.json',
-  'migration-managed-direct.png',
-  'migration-managed-p2p.png',
-  'migration-native.png',
-  'migration-tunnel.png',
-  'migration-unmanaged-direct.png',
   'mobile.css',
   'mstile-150x150.png',
-  'node.gif',
 ]
 
 docs_html_in_files = [
@@ -303,6 +291,7 @@ html_xslt_gen = []
 subdir('fonts')
 subdir('go')
 subdir('html')
+subdir('images')
 subdir('internals')
 subdir('js')
 subdir('kbase')
index 247f345f8c7c051fee9a47e30623d938c97135f7..11beeedc1f5365294eb6d6f9a08b61fc8b803abc 100644 (file)
@@ -478,13 +478,13 @@ guest doing a lot of I/O to a local fast storage the
 synchronously written to the destination. This may harm I/O performance during
 the migration.
 
-.. |Migration native path| image:: migration-native.png
+.. |Migration native path| image:: images/migration-native.png
    :class: diagram
-.. |Migration tunnel path| image:: migration-tunnel.png
+.. |Migration tunnel path| image:: images/migration-tunnel.png
    :class: diagram
-.. |Migration direct, managed| image:: migration-managed-direct.png
+.. |Migration direct, managed| image:: images/migration-managed-direct.png
    :class: diagram
-.. |Migration peer-to-peer| image:: migration-managed-p2p.png
+.. |Migration peer-to-peer| image:: images/migration-managed-p2p.png
    :class: diagram
-.. |Migration direct, unmanaged| image:: migration-unmanaged-direct.png
+.. |Migration direct, unmanaged| image:: images/migration-unmanaged-direct.png
    :class: diagram