shaba/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 17:34:18 +03:00
Code Releases Activity
3f01ecd830
libvirt/docs
History
Andrea Bolognani 3f01ecd830 docs: Improve documentation for dies and clusters 
I've seen examples in the wild of the cluster attribute having
non-zero value on x86_64.

This is obviously quite confusing, but it's the information that
Linux exposes to userspace and we don't really have a way to tell
apart a valid die/cluster ID from a dummy one.

What ultimately matters is that the underlying assumptions about
topology are respected, which they are: in the x86_64 cases that
I have analyzed, for example, each "cluster" contained exactly
one core, so any program that would use this information to
influence guest topology decisions would be unaffected by the
additional level showing up in the hierarchy.

In an attempt to reduce confusion, remove any reference to any
specific value for the attributes having any special meaning
attached to it.

In fact, since there are plans to make it possible to create
guests with multiple CPU clusters on x86_64, rework the note
into a more generic warning cautioning users that an attribute
showing up here does not imply that the same attribute can be
used when defining a guest CPU topology.

Signed-off-by: Andrea Bolognani <abologna@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2024-02-08 18:41:47 +01:00
..
css css: Move generic styles to 'generic.css' 2024-02-08 16:48:47 +01:00
fonts meson: Work around configure_file(copy:true) deprecation 2023-04-20 15:30:18 +02:00
gitdm gitdm: Add other email into Red Hat company list 2021-10-12 16:46:45 +02:00
go docs: go: Add 'go-import' metadata via rST 2023-06-02 09:39:10 +02:00
html docs: xsl: Properly propagate 'href_base' as XSL template parameter 2024-02-08 16:48:47 +01:00
images meson: Work around configure_file(copy:true) deprecation 2023-04-20 15:30:18 +02:00
js js: Separate the virt-tools blog planet loader code 2024-02-08 16:48:47 +01:00
kbase docs: fix typo in qemu-passthrough-security 2024-01-03 16:05:03 +00:00
logos meson: Work around configure_file(copy:true) deprecation 2023-04-20 15:30:18 +02:00
manpages virDomainBlockResize: Introduce VIR_DOMAIN_BLOCK_RESIZE_CAPACITY 2023-12-14 16:09:05 +01:00
404.rst docs: Convert 404 page to rST 2023-02-21 10:58:59 +01:00
acl.rst docs: acl: Convert to 'rst' 2023-05-17 16:54:23 +02:00
aclpolkit.rst docs: acl: Convert to 'rst' 2023-05-17 16:54:23 +02:00
advanced-tests.rst tests: Rename 'qemuxml2argvtest' to 'qemuxmlconftest' 2024-01-17 17:31:12 +01:00
android-chrome-192x192.png
android-chrome-256x256.png
api_extension.rst docs: Update obsolete reference to formatdomain.html.in 2022-03-22 11:05:09 +01:00
api.rst docs: Remove extra leading slash in 'api' and 'formatdomaincaps' pages 2022-06-01 12:27:10 +02:00
apple-touch-icon.png
apps.rst docs: apps: Add a new section for backup utilities and mention 'virtnbdbackup' 2023-04-03 11:09:39 +02:00
auditlog.rst docs: html.in: Convert auditlog to rst 2021-03-15 17:31:57 +01:00
auth.rst docs: auth: Fix a couple of stylistic issues 2021-03-23 17:55:06 +01:00
best-practices.rst docs: Update best practices wrt "Fixes:" and GitLab 2022-10-25 08:37:28 +02:00
bindings.rst docs: update docs pointing to old mailing list addrs 2023-10-31 10:04:27 +00:00
browserconfig.xml
bugs.rst docs: bugs: Remove raw HTML anchor 'quality' 2022-04-25 16:33:01 +02:00
cgroups.rst docs: Convert 'cgroups' page to rST 2022-04-01 16:33:19 +02:00
ci-dashboard.rst docs: Move the CI dashboard to its own RST module 2022-07-14 17:31:21 +02:00
ci-runners.rst docs: ci-runners: Add a note on a new runner registration process 2023-10-11 09:43:09 +02:00
ci.rst docs: ci: Update the description on the integration CI GitLab variables 2023-10-11 09:43:09 +02:00
clangd.rst docs: expand clangd instructions 2023-07-17 10:43:29 -05:00
coding-style.rst coding style: Follow our own rule on comment style 2023-04-04 12:16:09 +02:00
committer-guidelines.rst meson: adjust our documentation to mention meson instead of autoconf 2020-08-03 09:27:09 +02:00
compiling.rst docs: compiling: Add a note about use of CFLAGS for optimization 2023-09-04 13:32:28 +02:00
contact.rst docs: update docs pointing to old mailing list addrs 2023-10-31 10:04:27 +00:00
contribute.rst docs: Missing "full-stop"/"period" on some bullet items 2023-07-14 15:19:10 +02:00
csharp.rst docs: convert 'csharp' page to rst 2022-04-07 15:10:26 +02:00
daemons.rst docs: Move 'tlscerts' page to 'kbase/' 2022-04-07 15:10:26 +02:00
dbus.rst docs: convert 'dbus' page to rst 2022-04-07 15:10:26 +02:00
docs.rst docs: Link to java.libvirt.org 2023-04-27 11:06:42 +02:00
downloads.rst docs: update docs pointing to old mailing list addrs 2023-10-31 10:04:27 +00:00
drivers.rst docs: drivers: Mention KVM/HVF in the link of qemu driver 2022-05-19 10:10:31 +02:00
drvbhyve.rst docs: drvbhve: Fix local anchor links 2022-04-19 16:19:48 +02:00
drvch.rst Add basic driver for the Cloud-Hypervisor 2021-06-04 10:56:06 +01:00
drvesx.rst Correct links to TLS certificate setup page 2022-04-25 16:33:01 +02:00
drvhyperv.rst docs: Update various URLs 2022-05-24 12:19:16 +02:00
drvlxc.rst docs: formatdomain: Remove 'elementsOSContainer' anchor 2022-06-01 12:27:09 +02:00
drvnodedev.rst docs: Convert 'formatnode' page to rst 2022-04-19 16:19:48 +02:00
drvopenvz.rst docs: Convert 'drvopenvz' page to rST 2022-04-01 16:33:19 +02:00
drvqemu.rst docs: drvqemu: Fix a typo 2023-01-12 11:40:21 +01:00
drvsecret.rst docs: Convert 'drvsecret' page to rST 2022-04-01 16:33:19 +02:00
drvtest.rst docs: Convert 'drvtest' page to rST 2022-04-01 16:33:19 +02:00
drvvbox.rst vbox: Drop support for virtualbox-6.0.0 2023-01-24 10:24:07 +01:00
drvvirtuozzo.rst docs: Convert 'drvvirtuozzo' page to rST 2022-04-01 16:33:19 +02:00
drvvmware.rst docs: Convert 'drvvmware' page to rST 2022-04-01 16:33:19 +02:00
drvxen.rst docs: Convert 'drvxen' page to rST 2022-04-01 16:33:19 +02:00
errors.rst docs: Convert 'errors' page to rST 2022-03-08 17:40:47 +01:00
favicon-16x16.png
favicon-32x32.png
favicon.ico
firewall.rst docs: Convert 'formatnwfilter' page to rst 2022-04-19 16:19:48 +02:00
format.rst docs: Convert 'format' page to rST 2022-04-01 16:33:19 +02:00
formatbackup.rst docs: formatdomain: Remove 'elementsDisks' anchor 2022-06-01 12:27:09 +02:00
formatcaps.rst docs: Improve documentation for dies and clusters 2024-02-08 18:41:47 +01:00
formatcheckpoint.rst docs: formatdomain: Remove 'elementsDisks' anchor 2022-06-01 12:27:09 +02:00
formatdomain.rst conf: Introduce dynamicMemslots attribute for virtio-mem 2024-01-30 10:44:36 +01:00
formatdomaincaps.rst test_driver: Implement virConnectGetDomainCapabilities() 2023-09-21 08:45:31 +02:00
formatnetwork.rst network: Make virtual domains resolvable from the host 2024-02-07 14:19:42 +01:00
formatnetworkport.rst tests: remove explicit <driver name='vfio'/> from hostdev test cases 2024-01-07 23:59:00 -05:00
formatnode.rst schema: nodedev: Fix schema attribute value for the 'vport_ops' capability 2022-09-01 13:11:09 +02:00
formatnwfilter.rst docs: Convert 'formatnwfilter' page to rst 2022-04-19 16:19:48 +02:00
formatsecret.rst docs: formatdomain: Remove 'elementsTpm' anchor 2022-06-01 12:27:10 +02:00
formatsnapshot.rst docs: formatdomain: Remove 'seclabel' anchor 2022-06-01 12:27:10 +02:00
formatstorage.rst Remove support for building the sheepdog storage driver backend 2022-09-01 13:11:09 +02:00
formatstoragecaps.rst docs: Convert 'formatstoragecaps' page to rST 2022-04-07 17:15:52 +02:00
formatstorageencryption.rst qemu: add luks-any encryption support for RBD images 2023-03-16 15:19:36 +01:00
glib-adoption.rst docs: glib-adoption: add string arrays and objects 2020-10-02 14:10:44 +02:00
goals.rst docs: Convert 'goals' to rST 2022-03-08 17:40:47 +01:00
golang.rst docs: Add sub-page for all golang modules 2023-02-15 12:38:45 +01:00
governance.rst docs: governance: Remove unused HTML anchors 2022-04-25 16:33:01 +02:00
hacking.rst docs: Advise running CI tests prior to submission 2023-07-14 15:19:24 +02:00
hooks.rst bhyve: Feed hook scripts with domain XML 2023-09-04 11:03:33 +02:00
index.rst js: Separate the virt-tools blog planet loader code 2024-02-08 16:48:47 +01:00
issue-handling.rst docs: Add article about handling upstream issues 2022-07-26 16:35:57 +02:00
libvirt-go-xml.rst docs: go: Add 'go-import' metadata via rST 2023-06-02 09:39:10 +02:00
libvirt-go.rst docs: go: Add 'go-import' metadata via rST 2023-06-02 09:39:10 +02:00
logging.rst docs: logging: Replace example by link to kbase/debuglogs.html 2022-04-01 16:33:20 +02:00
macos.rst docs: Add support page for libvirt on macOS 2022-01-25 16:54:44 +01:00
manifest.json
meson.build meson: Rename build_tests -> tests_enabled 2023-10-26 11:31:25 +02:00
migration.rst docs: Move all images to a subdirectory 2022-01-04 15:47:25 +01:00
mstile-150x150.png
newapi.xsl docs: page.xsl: Split up 'href_base' for assets and links 2024-02-08 16:48:47 +01:00
newreposetup.rst docs: update docs pointing to old mailing list addrs 2023-10-31 10:04:27 +00:00
nss.rst docs: Convert 'nss' page to rST 2022-03-10 17:52:07 +01:00
page.xsl docs: page.xsl: Split up 'href_base' for assets and links 2024-02-08 16:48:47 +01:00
pci-addresses.rst tests: remove explicit <driver name='vfio'/> from hostdev test cases 2024-01-07 23:59:00 -05:00
pci-hotplug.rst docs: pci-hotplug: Fix local anchor links 2022-04-19 16:19:48 +02:00
platforms.rst docs: Fix spelling for Homebrew 2022-04-14 11:54:28 +02:00
programming-languages.rst Fix capitalization "CLang" -> "Clang" 2020-11-12 15:01:42 +01:00
python.rst docs: convert 'python' page to rst 2022-04-07 15:10:26 +02:00
remote.rst docs: remote: Fix anchor names in links to uri.html 2022-06-01 12:27:10 +02:00
securityprocess.rst docs: update docs pointing to old mailing list addrs 2023-10-31 10:04:27 +00:00
site.xsl docs: page.xsl: Split up 'href_base' for assets and links 2024-02-08 16:48:47 +01:00
storage.rst Remove support for building the sheepdog storage driver backend 2022-09-01 13:11:09 +02:00
strategy.rst docs: Convert 'strategy' to rST 2022-03-08 17:40:47 +01:00
styleguide.rst Use 'libvirt.org' instead of 'www.libvirt.org' 2023-04-03 09:19:05 +02:00
submitting-patches.rst docs: update docs pointing to old mailing list addrs 2023-10-31 10:04:27 +00:00
support.rst docs: Convert 'support' page to rST 2022-03-08 17:40:47 +01:00
testapi.rst docs: update docs pointing to old mailing list addrs 2023-10-31 10:04:27 +00:00
testing.rst docs: testing: Adjust the docs on how to run container workloads locally 2023-10-11 09:43:09 +02:00
testtck.rst docs: testtck: Expand the 'Run TCK' section on making use of ci/jobs.sh 2023-10-11 09:43:09 +02:00
uri.rst uri: Fix link to qemu KVM example config 2022-06-01 12:27:10 +02:00
windows.rst docs: Update URL for MinGW 2022-05-24 12:19:15 +02:00