Commit Graph

5 Commits

Author SHA1 Message Date
Sean Mooney 33a56781f4 fix sphinx-lint errors in docs and add ci
This change mainly fixes incorrect use of backticks
but also adress some other minor issues like unbalanced
backticks, incorrect spacing or missing _ in links.

This change add a tox target to run sphinx-lint
as well as adding it to the relevent tox envs to enforce
it in ci. pre-commit is leveraged to install and execute
sphinx-lint but it does not reqiure you to install the
hooks locally into your working dir.

Change-Id: Ib97b35c9014bc31876003cef4362c47a8a3a4e0e
2024-04-17 13:33:47 +01:00
Stephen Finucane 5b7a677082 docs: Further tweaks to the CPU models document
Address some feedback from the initial review:

- Fix grammar
- Reorganize document so it makes sense to talk about CPU mode
  configuration before CPU models
- Go into more detail about CPU mode defaults on different host
  architectures

Change-Id: I3fdd71581e088fd8b18f7377826d095072dd51c0
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2023-11-13 17:15:20 +00:00
Stephen Finucane 04b8693703 docs: Fold in MDS security flaw doc
There's no real need for this to exist as its own standalone document
now that we have a separate CPU models doc. Combine them.

Change-Id: I3a3e19b1f2660dd773fd3d47332abadc0c0e5c55
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-23 11:16:14 +00:00
Stephen Finucane be03ca7be7 docs: Clarify host-model, host-passthrough differences
Based on review feedback from kashyap.

Change-Id: Ief5debad29c10a0903f70d68d5bee21b4c1424b0
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-23 11:15:32 +00:00
Stephen Finucane ee1443bb3f docs: Add CPU models guide
More information taken out of the catchall KVM guide and put into its
own doc, where it belongs.

Change-Id: I4a03561368b945e3aacbef8011b46933cc1fcfd7
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-23 11:14:09 +00:00