[libvirt PATCH v3 0/4] docs: Unclutter top-level directory

Changes from [v2]: * drop all changes related to icons. Changes from [v1]: * extend scope to include icons and CSS files. [v2] https://listman.redhat.com/archives/libvir-list/2021-December/msg00828.html [v1] https://listman.redhat.com/archives/libvir-list/2021-December/msg00818.html Andrea Bolognani (4): docs: Drop structures.svg docs: Move all images to a subdirectory docs: Move all CSS files to a subdirectory docs: Move font definitions with other CSS files docs/api.rst | 6 +- docs/{fonts/stylesheet.css => css/fonts.css} | 18 +- docs/{ => css}/generic.css | 0 docs/{ => css}/libvirt.css | 4 +- docs/{ => css}/main.css | 2 +- docs/css/meson.build | 17 ++ docs/{ => css}/mobile.css | 2 +- docs/fonts/meson.build | 1 - 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 | 18 +- docs/migration.rst | 10 +- docs/page.xsl | 2 +- docs/structures.svg | 187 ------------------ 40 files changed, 69 insertions(+), 230 deletions(-) rename docs/{fonts/stylesheet.css => css/fonts.css} (60%) rename docs/{ => css}/generic.css (100%) rename docs/{ => css}/libvirt.css (98%) rename docs/{ => css}/main.css (68%) create mode 100644 docs/css/meson.build rename docs/{ => css}/mobile.css (95%) 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%) delete mode 100644 docs/structures.svg -- 2.31.1

It was introduced in ff4ede005567 but it doesn't seem to have ever actually been used anywhere. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ani Sinha <ani@anisinha.ca> --- docs/structures.svg | 187 -------------------------------------------- 1 file changed, 187 deletions(-) delete mode 100644 docs/structures.svg diff --git a/docs/structures.svg b/docs/structures.svg deleted file mode 100644 index e52d606ae3..0000000000 --- a/docs/structures.svg +++ /dev/null @@ -1,187 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!-- Creator: fig2dev Version 3.2.7b-dev --> -<!-- CreationDate: 2020-07-10 10:26:02 --> -<!-- Magnification: 1 --> -<svg xmlns="http://www.w3.org/2000/svg" - xmlns:xlink="http://www.w3.org/1999/xlink" - width="458pt" height="312pt" - viewBox="885 525 7628 5190"> -<g fill="none"> -<!-- Line --> -<rect x="1125" y="825" width="1275" height="2025" - stroke="#000000" stroke-width="8px"/> -<!-- Line --> -<defs> -<clipPath id="cp0"> - <path clip-rule="evenodd" d="M 885,525 H 8513 V 5715 H 885 z - M 5039,1170 5039,1230 5182,1207 5182,1193z"/> -</clipPath> -</defs> -<polyline points=" 2400,1200 5175,1200" clip-path="url(#cp0)" - stroke="#000000" stroke-width="8px"/> -<!-- Forward arrow to point 5175,1200 --> -<polygon points=" 5039,1230 5159,1200 5039,1170 5039,1230" - stroke="#000000" stroke-width="8px" stroke-miterlimit="8" fill="#000000"/> -<!-- Line --> -<defs> -<clipPath id="cp1"> - <path clip-rule="evenodd" d="M 885,525 H 8513 V 5715 H 885 z - M 5053,1957 5036,2015 5180,2033 5183,2020z"/> -</clipPath> -</defs> -<polyline points=" 2400,1200 5175,2025" clip-path="url(#cp1)" - stroke="#000000" stroke-width="8px"/> -<!-- Forward arrow to point 5175,2025 --> -<polygon points=" 5036,2015 5159,2020 5053,1957 5036,2015" - stroke="#000000" stroke-width="8px" stroke-miterlimit="8" fill="#000000"/> -<!-- Line --> -<rect x="5175" y="975" width="750" height="525" rx="105" - stroke="#000000" stroke-width="8px"/> -<!-- Line --> -<rect x="5175" y="1875" width="750" height="525" rx="105" - stroke="#000000" stroke-width="8px"/> -<!-- Line --> -<rect x="1500" y="4500" width="900" height="750" rx="105" - stroke="#000000" stroke-width="8px"/> -<!-- Line --> -<defs> -<clipPath id="cp2"> - <path clip-rule="evenodd" d="M 885,525 H 8513 V 5715 H 885 z - M 1845,2986 1905,2986 1882,2843 1868,2843z"/> -</clipPath> -</defs> -<polyline points=" 1875,4725 1875,2850" clip-path="url(#cp2)" - stroke="#000000" stroke-width="8px"/> -<!-- Forward arrow to point 1875,2850 --> -<polygon points=" 1905,2986 1875,2866 1845,2986 1905,2986" - stroke="#000000" stroke-width="8px" stroke-miterlimit="8" fill="#000000"/> -<!-- Line --> -<defs> -<clipPath id="cp3"> - <path clip-rule="evenodd" d="M 885,525 H 8513 V 5715 H 885 z - M 2524,4436 2485,4390 2390,4499 2399,4510z"/> -</clipPath> -</defs> -<polyline points=" 5175,2175 2400,4500" clip-path="url(#cp3)" - stroke="#000000" stroke-width="8px"/> -<!-- Forward arrow to point 2400,4500 --> -<polygon points=" 2485,4390 2412,4490 2524,4436 2485,4390" - stroke="#000000" stroke-width="8px" stroke-miterlimit="8" fill="#000000"/> -<!-- Line --> -<defs> -<clipPath id="cp4"> - <path clip-rule="evenodd" d="M 885,525 H 8513 V 5715 H 885 z - M 2513,4418 2468,4378 2390,4501 2401,4510z"/> -</clipPath> -</defs> -<polyline points=" 5175,1350 2400,4500" clip-path="url(#cp4)" - stroke="#000000" stroke-width="8px"/> -<!-- Forward arrow to point 2400,4500 --> -<polygon points=" 2468,4378 2411,4488 2513,4418 2468,4378" - stroke="#000000" stroke-width="8px" stroke-miterlimit="8" fill="#000000"/> -<!-- Line --> -<defs> -<clipPath id="cp5"> - <path clip-rule="evenodd" d="M 885,525 H 8513 V 5715 H 885 z - M 6689,1170 6689,1230 6832,1207 6832,1193z"/> -</clipPath> -</defs> -<polyline points=" 5925,1200 6825,1200" clip-path="url(#cp5)" - stroke="#000000" stroke-width="8px"/> -<!-- Forward arrow to point 6825,1200 --> -<polygon points=" 6689,1230 6809,1200 6689,1170 6689,1230" - stroke="#000000" stroke-width="8px" stroke-miterlimit="8" fill="#000000"/> -<!-- Line --> -<defs> -<clipPath id="cp6"> - <path clip-rule="evenodd" d="M 885,525 H 8513 V 5715 H 885 z - M 6689,2070 6689,2130 6832,2107 6832,2093z"/> -</clipPath> -</defs> -<polyline points=" 5925,2100 6825,2100" clip-path="url(#cp6)" - stroke="#000000" stroke-width="8px"/> -<!-- Forward arrow to point 6825,2100 --> -<polygon points=" 6689,2130 6809,2100 6689,2070 6689,2130" - stroke="#000000" stroke-width="8px" stroke-miterlimit="8" fill="#000000"/> -<!-- Line --> -<rect x="3900" y="4650" width="2850" height="225" - stroke="#000000" stroke-width="8px"/> -<!-- Line --> -<polyline points=" 4200,4650 4200,4875" - stroke="#000000" stroke-width="8px"/> -<!-- Line --> -<polyline points=" 4500,4650 4500,4875" - stroke="#000000" stroke-width="8px"/> -<!-- Line --> -<polyline points=" 4725,4650 4725,4875" - stroke="#000000" stroke-width="8px"/> -<!-- Line --> -<polyline points=" 6450,4650 6450,4875" - stroke="#000000" stroke-width="8px"/> -<!-- Line --> -<polyline points=" 6150,4650 6150,4875" - stroke="#000000" stroke-width="8px"/> -<!-- Line --> -<defs> -<clipPath id="cp7"> - <path clip-rule="evenodd" d="M 885,525 H 8513 V 5715 H 885 z - M 5174,1617 5231,1638 5259,1496 5246,1491z"/> -</clipPath> -</defs> -<polyline points=" 4050,4725 5250,1500" clip-path="url(#cp7)" - stroke="#000000" stroke-width="8px"/> -<!-- Forward arrow to point 5250,1500 --> -<polygon points=" 5231,1638 5244,1515 5174,1617 5231,1638" - stroke="#000000" stroke-width="8px" stroke-miterlimit="8" fill="#000000"/> -<!-- Line --> -<defs> -<clipPath id="cp8"> - <path clip-rule="evenodd" d="M 885,525 H 8513 V 5715 H 885 z - M 5173,2516 5229,2538 5259,2396 5246,2391z"/> -</clipPath> -</defs> -<polyline points=" 4350,4725 5250,2400" clip-path="url(#cp8)" - stroke="#000000" stroke-width="8px"/> -<!-- Forward arrow to point 5250,2400 --> -<polygon points=" 5229,2538 5244,2415 5173,2516 5229,2538" - stroke="#000000" stroke-width="8px" stroke-miterlimit="8" fill="#000000"/> -<!-- Line --> -<defs> -<clipPath id="cp9"> - <path clip-rule="evenodd" d="M 885,525 H 8513 V 5715 H 885 z - M 3764,4770 3764,4830 3907,4807 3907,4793z"/> -</clipPath> -</defs> -<polyline points=" 2250,4800 3900,4800" clip-path="url(#cp9)" - stroke="#000000" stroke-width="8px"/> -<!-- Forward arrow to point 3900,4800 --> -<polygon points=" 3764,4830 3884,4800 3764,4770 3764,4830" - stroke="#000000" stroke-width="8px" stroke-miterlimit="8" fill="#000000"/> -<!-- Text --> -<text xml:space="preserve" x="1275" y="1125" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="216" text-anchor="start">Domains</text> -<!-- Text --> -<text xml:space="preserve" x="1275" y="1440" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="216" text-anchor="start">hash </text> -<!-- Text --> -<text xml:space="preserve" x="4725" y="750" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="216" text-anchor="start">virDomainPtr</text> -<!-- Text --> -<text xml:space="preserve" x="975" y="5700" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="216" text-anchor="start">virConnectionPtr</text> -<!-- Text --> -<text xml:space="preserve" x="900" y="4200" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="216" text-anchor="start">domains</text> -<!-- Text --> -<text xml:space="preserve" x="3450" y="2475" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="216" text-anchor="start">conn</text> -<!-- Text --> -<text xml:space="preserve" x="6075" y="1050" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="216" text-anchor="start">name</text> -<!-- Text --> -<text xml:space="preserve" x="6975" y="1275" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="216" text-anchor="start">"Domain-0"</text> -<!-- Text --> -<text xml:space="preserve" x="6975" y="2175" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="216" text-anchor="start">"fc4"</text> -<!-- Text --> -<text xml:space="preserve" x="1275" y="1755" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="216" text-anchor="start">table</text> -<!-- Text --> -<text xml:space="preserve" x="1275" y="2385" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="216" text-anchor="start">name</text> -<!-- Text --> -<text xml:space="preserve" x="1275" y="2070" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="216" text-anchor="start">based on</text> -<!-- Text --> -<text xml:space="preserve" x="2850" y="5100" fill="#000000" font-family="Times" font-style="normal" font-weight="normal" font-size="216" text-anchor="start">ids</text> -</g> -</svg> -- 2.31.1

On Tue, Jan 04, 2022 at 02:55:59PM +0100, Andrea Bolognani wrote:
It was introduced in ff4ede005567 but it doesn't seem to have ever actually been used anywhere.
Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ani Sinha <ani@anisinha.ca> --- docs/structures.svg | 187 -------------------------------------------- 1 file changed, 187 deletions(-) delete mode 100644 docs/structures.svg
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|

This unclutters the top-level docs directory. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ani Sinha <ani@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

On Tue, Jan 04, 2022 at 02:56:00PM +0100, Andrea Bolognani wrote:
This unclutters the top-level docs directory.
Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ani Sinha <ani@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%)
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|

This unclutters the top-level docs directory. Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- docs/{ => css}/generic.css | 0 docs/{ => css}/libvirt.css | 4 ++-- docs/{ => css}/main.css | 2 +- docs/css/meson.build | 16 ++++++++++++++++ docs/{ => css}/mobile.css | 2 +- docs/meson.build | 5 +---- docs/page.xsl | 2 +- 7 files changed, 22 insertions(+), 9 deletions(-) rename docs/{ => css}/generic.css (100%) rename docs/{ => css}/libvirt.css (98%) rename docs/{ => css}/main.css (66%) create mode 100644 docs/css/meson.build rename docs/{ => css}/mobile.css (95%) diff --git a/docs/generic.css b/docs/css/generic.css similarity index 100% rename from docs/generic.css rename to docs/css/generic.css diff --git a/docs/libvirt.css b/docs/css/libvirt.css similarity index 98% rename from docs/libvirt.css rename to docs/css/libvirt.css index 5195588a8f..b08271ea4d 100644 --- a/docs/libvirt.css +++ b/docs/css/libvirt.css @@ -10,7 +10,7 @@ } #home { - background-image: url(logos/logo-banner-light-256.png); + background-image: url(../logos/logo-banner-light-256.png); background-repeat: no-repeat; background-position: left center; height: 100px; @@ -419,7 +419,7 @@ div.panel h2, #index.document h1 { border: 0px; text-indent: 100%; white-space: nowrap; overflow: hidden; - background: url(logos/logo-banner-dark-800.png) no-repeat center center; + background: url(../logos/logo-banner-dark-800.png) no-repeat center center; height: 300px; } diff --git a/docs/main.css b/docs/css/main.css similarity index 66% rename from docs/main.css rename to docs/css/main.css index 71f7b7a6a0..8961f1a4b4 100644 --- a/docs/main.css +++ b/docs/css/main.css @@ -1,4 +1,4 @@ -@import url(fonts/stylesheet.css); +@import url(../fonts/stylesheet.css); @import url(generic.css); @import url(libvirt.css); @import url(mobile.css); diff --git a/docs/css/meson.build b/docs/css/meson.build new file mode 100644 index 0000000000..35e56347a6 --- /dev/null +++ b/docs/css/meson.build @@ -0,0 +1,16 @@ +docs_css_files = [ + 'generic.css', + 'libvirt.css', + 'main.css', + 'mobile.css', +] + +install_data(docs_css_files, install_dir: docs_html_dir / 'css') + +foreach file : docs_css_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 / 'css') +endforeach diff --git a/docs/mobile.css b/docs/css/mobile.css similarity index 95% rename from docs/mobile.css rename to docs/css/mobile.css index 366d0f1a5d..ae833b6eea 100644 --- a/docs/mobile.css +++ b/docs/css/mobile.css @@ -3,7 +3,7 @@ width: 100%; display: block; margin: 0px; - background: white url(logos/logo-banner-dark-256.png) no-repeat center center; + background: white url(../logos/logo-banner-dark-256.png) no-repeat center center; height: 94px; } #home a { diff --git a/docs/meson.build b/docs/meson.build index 6f1ca5c6ff..3e912f21ad 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -13,11 +13,7 @@ docs_assets = [ 'favicon.ico', 'favicon-16x16.png', 'favicon-32x32.png', - 'generic.css', - 'libvirt.css', - 'main.css', 'manifest.json', - 'mobile.css', 'mstile-150x150.png', ] @@ -288,6 +284,7 @@ html_xslt_gen = [] # --- end of XSLT processing --- +subdir('css') subdir('fonts') subdir('go') subdir('html') diff --git a/docs/page.xsl b/docs/page.xsl index 580387ac59..fd67918d3b 100644 --- a/docs/page.xsl +++ b/docs/page.xsl @@ -91,7 +91,7 @@ <head> <meta charset="UTF-8"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> - <link rel="stylesheet" type="text/css" href="{$href_base}main.css"/> + <link rel="stylesheet" type="text/css" href="{$href_base}css/main.css"/> <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/> <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/> <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/> -- 2.31.1

On Tue, Jan 04, 2022 at 02:56:01PM +0100, Andrea Bolognani wrote:
This unclutters the top-level docs directory.
Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- docs/{ => css}/generic.css | 0 docs/{ => css}/libvirt.css | 4 ++-- docs/{ => css}/main.css | 2 +- docs/css/meson.build | 16 ++++++++++++++++ docs/{ => css}/mobile.css | 2 +- docs/meson.build | 5 +---- docs/page.xsl | 2 +- 7 files changed, 22 insertions(+), 9 deletions(-) rename docs/{ => css}/generic.css (100%) rename docs/{ => css}/libvirt.css (98%) rename docs/{ => css}/main.css (66%) create mode 100644 docs/css/meson.build rename docs/{ => css}/mobile.css (95%)
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|

We have a subdirectory specifically for CSS files now, so it makes sense to have the stylesheet that defines fonts to be there too. Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- docs/{fonts/stylesheet.css => css/fonts.css} | 18 +++++++++--------- docs/css/main.css | 2 +- docs/css/meson.build | 1 + docs/fonts/meson.build | 1 - 4 files changed, 11 insertions(+), 11 deletions(-) rename docs/{fonts/stylesheet.css => css/fonts.css} (60%) diff --git a/docs/fonts/stylesheet.css b/docs/css/fonts.css similarity index 60% rename from docs/fonts/stylesheet.css rename to docs/css/fonts.css index 1a06f22c35..214d324346 100644 --- a/docs/fonts/stylesheet.css +++ b/docs/css/fonts.css @@ -1,62 +1,62 @@ @font-face { font-family: 'LibvirtOverpass'; - src: url('overpass-regular.woff') format('woff'); + src: url('../fonts/overpass-regular.woff') format('woff'); font-weight: normal; font-style: normal; } @font-face { font-family: 'LibvirtOverpass'; - src: url('overpass-italic.woff') format('woff'); + src: url('../fonts/overpass-italic.woff') format('woff'); font-weight: normal; font-style: italic; } @font-face { font-family: 'LibvirtOverpass'; - src: url('overpass-bold.woff') format('woff'); + src: url('../fonts/overpass-bold.woff') format('woff'); font-weight: bold; font-style: normal; } @font-face { font-family: 'LibvirtOverpass'; - src: url('overpass-bold-italic.woff') format('woff'); + src: url('../fonts/overpass-bold-italic.woff') format('woff'); font-weight: bold; font-style: italic; } @font-face { font-family: 'LibvirtOverpassLight'; - src: url('overpass-light.woff') format('woff'); + src: url('../fonts/overpass-light.woff') format('woff'); font-weight: 300; font-style: normal; } @font-face { font-family: 'LibvirtOverpassLight'; - src: url('overpass-light-italic.woff') format('woff'); + src: url('../fonts/overpass-light-italic.woff') format('woff'); font-weight: 300; font-style: italic; } @font-face { font-family: 'LibvirtOverpassMono'; - src: url('overpass-mono-regular.woff') format('woff'); + src: url('../fonts/overpass-mono-regular.woff') format('woff'); font-weight: normal; font-style: normal; } @font-face { font-family: 'LibvirtOverpassMono'; - src: url('overpass-mono-bold.woff') format('woff'); + src: url('../fonts/overpass-mono-bold.woff') format('woff'); font-weight: bold; font-style: normal; } @font-face { font-family: 'LibvirtOverpassMonoLight'; - src: url('overpass-mono-light.woff') format('woff'); + src: url('../fonts/overpass-mono-light.woff') format('woff'); font-weight: 300; font-style: normal; } diff --git a/docs/css/main.css b/docs/css/main.css index 8961f1a4b4..88e453aca6 100644 --- a/docs/css/main.css +++ b/docs/css/main.css @@ -1,4 +1,4 @@ -@import url(../fonts/stylesheet.css); +@import url(fonts.css); @import url(generic.css); @import url(libvirt.css); @import url(mobile.css); diff --git a/docs/css/meson.build b/docs/css/meson.build index 35e56347a6..384f6e789f 100644 --- a/docs/css/meson.build +++ b/docs/css/meson.build @@ -1,4 +1,5 @@ docs_css_files = [ + 'fonts.css', 'generic.css', 'libvirt.css', 'main.css', diff --git a/docs/fonts/meson.build b/docs/fonts/meson.build index e4109c6e7d..53a060b972 100644 --- a/docs/fonts/meson.build +++ b/docs/fonts/meson.build @@ -1,6 +1,5 @@ fonts = [ 'LICENSE.rst', - 'stylesheet.css', 'overpass-bold-italic.woff', 'overpass-bold.woff', 'overpass-italic.woff', -- 2.31.1

On Tue, Jan 04, 2022 at 02:56:02PM +0100, Andrea Bolognani wrote:
We have a subdirectory specifically for CSS files now, so it makes sense to have the stylesheet that defines fonts to be there too.
Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- docs/{fonts/stylesheet.css => css/fonts.css} | 18 +++++++++--------- docs/css/main.css | 2 +- docs/css/meson.build | 1 + docs/fonts/meson.build | 1 - 4 files changed, 11 insertions(+), 11 deletions(-) rename docs/{fonts/stylesheet.css => css/fonts.css} (60%)
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|

On Tue, Jan 04, 2022 at 02:55:58PM +0100, Andrea Bolognani wrote:
Changes from [v2]:
* drop all changes related to icons.
Changes from [v1]:
* extend scope to include icons and CSS files.
[v2] https://listman.redhat.com/archives/libvir-list/2021-December/msg00828.html [v1] https://listman.redhat.com/archives/libvir-list/2021-December/msg00818.html
Andrea Bolognani (4): docs: Drop structures.svg docs: Move all images to a subdirectory docs: Move all CSS files to a subdirectory docs: Move font definitions with other CSS files
docs/{ => images}/node.gif | Bin docs/{ => images}/node.svg | 0
Ewwwwwwwwwwwww, just noticed "gif" file, how did we let that get in here. We should burn it [1] ! But seriously, pre-existing + tangential problem so not actually asking you to fix it in this series, unless you fancy it. Regards, Daniel [1] https://burnallgifs.org/archives/ -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|

On Tue, Jan 04, 2022 at 02:25:14PM +0000, Daniel P. Berrangé wrote:
On Tue, Jan 04, 2022 at 02:55:58PM +0100, Andrea Bolognani wrote:
docs/{ => images}/node.gif | Bin
Ewwwwwwwwwwwww, just noticed "gif" file, how did we let that get in here. We should burn it [1] !
But seriously, pre-existing + tangential problem so not actually asking you to fix it in this series, unless you fancy it.
Yeah, I noticed that as well while preparing these patches and had the very same reaction :) Sort of forgot about it in the meantime, but now that you've reminded me I'll look into addressing it with a follow-up patch. -- Andrea Bolognani / Red Hat / Virtualization

On Tue, Jan 04, 2022 at 09:45:16AM -0500, Andrea Bolognani wrote:
On Tue, Jan 04, 2022 at 02:25:14PM +0000, Daniel P. Berrangé wrote:
On Tue, Jan 04, 2022 at 02:55:58PM +0100, Andrea Bolognani wrote:
docs/{ => images}/node.gif | Bin
Ewwwwwwwwwwwww, just noticed "gif" file, how did we let that get in here. We should burn it [1] !
But seriously, pre-existing + tangential problem so not actually asking you to fix it in this series, unless you fancy it.
Yeah, I noticed that as well while preparing these patches and had the very same reaction :) Sort of forgot about it in the meantime, but now that you've reminded me I'll look into addressing it with a follow-up patch.
Done. https://listman.redhat.com/archives/libvir-list/2022-January/msg00317.html -- Andrea Bolognani / Red Hat / Virtualization
participants (2)
-
Andrea Bolognani
-
Daniel P. Berrangé