[libvirt PATCH v3 2/4] docs: Move all images to a subdirectory
Andrea Bolognani
abologna at redhat.com
Tue Jan 4 13:56:00 UTC 2022
This unclutters the top-level docs directory.
Signed-off-by: Andrea Bolognani <abologna at redhat.com>
Reviewed-by: Ani Sinha <ani at anisinha.ca>
---
docs/api.rst | 6 ++---
docs/goals.html.in | 2 +-
docs/{ => images}/event_loop_simple.png | Bin
docs/{ => images}/event_loop_simple.svg | 0
docs/{ => images}/event_loop_worker.png | Bin
docs/{ => images}/event_loop_worker.svg | 0
docs/{ => images}/libvirt-daemon-arch.png | Bin
docs/{ => images}/libvirt-daemon-arch.svg | 0
docs/{ => images}/libvirt-driver-arch.png | Bin
docs/{ => images}/libvirt-driver-arch.svg | 0
docs/{ => images}/libvirt-object-model.png | Bin
docs/{ => images}/libvirt-object-model.svg | 0
.../libvirt-virConnect-example.png | Bin
.../libvirt-virConnect-example.svg | 0
docs/images/meson.build | 24 ++++++++++++++++++
.../{ => images}/migration-managed-direct.png | Bin
.../{ => images}/migration-managed-direct.svg | 0
docs/{ => images}/migration-managed-p2p.png | Bin
docs/{ => images}/migration-managed-p2p.svg | 0
docs/{ => images}/migration-native.png | Bin
docs/{ => images}/migration-native.svg | 0
docs/{ => images}/migration-tunnel.png | Bin
docs/{ => images}/migration-tunnel.svg | 0
.../migration-unmanaged-direct.png | Bin
.../migration-unmanaged-direct.svg | 0
docs/{ => images}/node.gif | Bin
docs/{ => images}/node.svg | 0
docs/internals.html.in | 2 +-
docs/internals/eventloop.html.in | 4 +--
docs/meson.build | 13 +---------
docs/migration.rst | 10 ++++----
31 files changed, 37 insertions(+), 24 deletions(-)
rename docs/{ => images}/event_loop_simple.png (100%)
rename docs/{ => images}/event_loop_simple.svg (100%)
rename docs/{ => images}/event_loop_worker.png (100%)
rename docs/{ => images}/event_loop_worker.svg (100%)
rename docs/{ => images}/libvirt-daemon-arch.png (100%)
rename docs/{ => images}/libvirt-daemon-arch.svg (100%)
rename docs/{ => images}/libvirt-driver-arch.png (100%)
rename docs/{ => images}/libvirt-driver-arch.svg (100%)
rename docs/{ => images}/libvirt-object-model.png (100%)
rename docs/{ => images}/libvirt-object-model.svg (100%)
rename docs/{ => images}/libvirt-virConnect-example.png (100%)
rename docs/{ => images}/libvirt-virConnect-example.svg (100%)
create mode 100644 docs/images/meson.build
rename docs/{ => images}/migration-managed-direct.png (100%)
rename docs/{ => images}/migration-managed-direct.svg (100%)
rename docs/{ => images}/migration-managed-p2p.png (100%)
rename docs/{ => images}/migration-managed-p2p.svg (100%)
rename docs/{ => images}/migration-native.png (100%)
rename docs/{ => images}/migration-native.svg (100%)
rename docs/{ => images}/migration-tunnel.png (100%)
rename docs/{ => images}/migration-tunnel.svg (100%)
rename docs/{ => images}/migration-unmanaged-direct.png (100%)
rename docs/{ => images}/migration-unmanaged-direct.svg (100%)
rename docs/{ => images}/node.gif (100%)
rename docs/{ => images}/node.svg (100%)
diff --git a/docs/api.rst b/docs/api.rst
index a8f527e197..d9f01fb403 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -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
diff --git a/docs/goals.html.in b/docs/goals.html.in
index 39d5e75359..d205bf4f42 100644
--- a/docs/goals.html.in
+++ b/docs/goals.html.in
@@ -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/event_loop_simple.png b/docs/images/event_loop_simple.png
similarity index 100%
rename from docs/event_loop_simple.png
rename to docs/images/event_loop_simple.png
diff --git a/docs/event_loop_simple.svg b/docs/images/event_loop_simple.svg
similarity index 100%
rename from docs/event_loop_simple.svg
rename to docs/images/event_loop_simple.svg
diff --git a/docs/event_loop_worker.png b/docs/images/event_loop_worker.png
similarity index 100%
rename from docs/event_loop_worker.png
rename to docs/images/event_loop_worker.png
diff --git a/docs/event_loop_worker.svg b/docs/images/event_loop_worker.svg
similarity index 100%
rename from docs/event_loop_worker.svg
rename to docs/images/event_loop_worker.svg
diff --git a/docs/libvirt-daemon-arch.png b/docs/images/libvirt-daemon-arch.png
similarity index 100%
rename from docs/libvirt-daemon-arch.png
rename to docs/images/libvirt-daemon-arch.png
diff --git a/docs/libvirt-daemon-arch.svg b/docs/images/libvirt-daemon-arch.svg
similarity index 100%
rename from docs/libvirt-daemon-arch.svg
rename to docs/images/libvirt-daemon-arch.svg
diff --git a/docs/libvirt-driver-arch.png b/docs/images/libvirt-driver-arch.png
similarity index 100%
rename from docs/libvirt-driver-arch.png
rename to docs/images/libvirt-driver-arch.png
diff --git a/docs/libvirt-driver-arch.svg b/docs/images/libvirt-driver-arch.svg
similarity index 100%
rename from docs/libvirt-driver-arch.svg
rename to docs/images/libvirt-driver-arch.svg
diff --git a/docs/libvirt-object-model.png b/docs/images/libvirt-object-model.png
similarity index 100%
rename from docs/libvirt-object-model.png
rename to docs/images/libvirt-object-model.png
diff --git a/docs/libvirt-object-model.svg b/docs/images/libvirt-object-model.svg
similarity index 100%
rename from docs/libvirt-object-model.svg
rename to docs/images/libvirt-object-model.svg
diff --git a/docs/libvirt-virConnect-example.png b/docs/images/libvirt-virConnect-example.png
similarity index 100%
rename from docs/libvirt-virConnect-example.png
rename to docs/images/libvirt-virConnect-example.png
diff --git a/docs/libvirt-virConnect-example.svg b/docs/images/libvirt-virConnect-example.svg
similarity index 100%
rename from docs/libvirt-virConnect-example.svg
rename to docs/images/libvirt-virConnect-example.svg
diff --git a/docs/images/meson.build b/docs/images/meson.build
new file mode 100644
index 0000000000..85a35da4aa
--- /dev/null
+++ b/docs/images/meson.build
@@ -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
diff --git a/docs/migration-managed-direct.png b/docs/images/migration-managed-direct.png
similarity index 100%
rename from docs/migration-managed-direct.png
rename to docs/images/migration-managed-direct.png
diff --git a/docs/migration-managed-direct.svg b/docs/images/migration-managed-direct.svg
similarity index 100%
rename from docs/migration-managed-direct.svg
rename to docs/images/migration-managed-direct.svg
diff --git a/docs/migration-managed-p2p.png b/docs/images/migration-managed-p2p.png
similarity index 100%
rename from docs/migration-managed-p2p.png
rename to docs/images/migration-managed-p2p.png
diff --git a/docs/migration-managed-p2p.svg b/docs/images/migration-managed-p2p.svg
similarity index 100%
rename from docs/migration-managed-p2p.svg
rename to docs/images/migration-managed-p2p.svg
diff --git a/docs/migration-native.png b/docs/images/migration-native.png
similarity index 100%
rename from docs/migration-native.png
rename to docs/images/migration-native.png
diff --git a/docs/migration-native.svg b/docs/images/migration-native.svg
similarity index 100%
rename from docs/migration-native.svg
rename to docs/images/migration-native.svg
diff --git a/docs/migration-tunnel.png b/docs/images/migration-tunnel.png
similarity index 100%
rename from docs/migration-tunnel.png
rename to docs/images/migration-tunnel.png
diff --git a/docs/migration-tunnel.svg b/docs/images/migration-tunnel.svg
similarity index 100%
rename from docs/migration-tunnel.svg
rename to docs/images/migration-tunnel.svg
diff --git a/docs/migration-unmanaged-direct.png b/docs/images/migration-unmanaged-direct.png
similarity index 100%
rename from docs/migration-unmanaged-direct.png
rename to docs/images/migration-unmanaged-direct.png
diff --git a/docs/migration-unmanaged-direct.svg b/docs/images/migration-unmanaged-direct.svg
similarity index 100%
rename from docs/migration-unmanaged-direct.svg
rename to docs/images/migration-unmanaged-direct.svg
diff --git a/docs/node.gif b/docs/images/node.gif
similarity index 100%
rename from docs/node.gif
rename to docs/images/node.gif
diff --git a/docs/node.svg b/docs/images/node.svg
similarity index 100%
rename from docs/node.svg
rename to docs/images/node.svg
diff --git a/docs/internals.html.in b/docs/internals.html.in
index 3a96ff73b4..e474f7ddd7 100644
--- a/docs/internals.html.in
+++ b/docs/internals.html.in
@@ -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"
diff --git a/docs/internals/eventloop.html.in b/docs/internals/eventloop.html.in
index aa22ba15cd..1a24254fc5 100644
--- a/docs/internals/eventloop.html.in
+++ b/docs/internals/eventloop.html.in
@@ -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
diff --git a/docs/meson.build b/docs/meson.build
index 04e32f7bf1..6f1ca5c6ff 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -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')
diff --git a/docs/migration.rst b/docs/migration.rst
index 247f345f8c..11beeedc1f 100644
--- a/docs/migration.rst
+++ b/docs/migration.rst
@@ -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
--
2.31.1
More information about the libvir-list
mailing list