qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 0/5] docs: reorganize target-i386 to make room for SGX


From: Paolo Bonzini
Subject: [PATCH 0/5] docs: reorganize target-i386 to make room for SGX
Date: Tue, 7 Sep 2021 17:56:36 +0200

The docs/ directory includes the documentation for many x86 features,
but target-i386.rst does not really have a structure that lends itself
to incorporating those documents.  One problem in particular is the
CPU model documentation, which is currently structured to be included
in both target-i386.rst and a man page.  This series changes that
documentation to be included from a subpage of target-i386.rst.

The first three patches use overline headings in standardized places
(book titles, docs/*/index.rst, man pages) to make include directives
easier to use from both manuals and man pages.

Based on this preparation, the fourth patch reorganizes target-i386.rst
so that it can be a place for many features currently documented in
docs/.  The new structure is inspired by the s390 documentation.
The final one converts the .txt file for SGX documentation to
reStructuredText and gives it a new home in docs/system/i386.

Paolo Bonzini (5):
  docs: standardize book titles to === with overline
  docs: standardize directory index to --- with overline
  docs/system: standardize man page section to --- with overline
  docs/system: move x86 CPU configuration to a separate document
  docs/system: move SGX documentation within the system docs

 docs/about/index.rst                        |  3 +-
 docs/devel/index.rst                        |  3 +-
 docs/index.rst                              |  1 +
 docs/interop/index.rst                      |  3 +-
 docs/specs/index.rst                        |  3 +-
 docs/system/cpu-models-x86.rst.inc          |  4 +-
 docs/system/i386/cpu.rst                    |  1 +
 docs/{intel-sgx.txt => system/i386/sgx.rst} | 70 ++++++++++-----------
 docs/system/index.rst                       |  3 +-
 docs/system/qemu-block-drivers.rst          |  4 ++
 docs/system/qemu-cpu-models.rst             | 10 ++-
 docs/system/qemu-manpage.rst                | 10 ++-
 docs/system/target-i386.rst                 |  9 ++-
 docs/tools/index.rst                        |  3 +-
 docs/tools/qemu-img.rst                     |  1 +
 docs/tools/qemu-nbd.rst                     |  1 +
 docs/tools/qemu-pr-helper.rst               |  1 +
 docs/tools/qemu-storage-daemon.rst          |  1 +
 docs/tools/qemu-trace-stap.rst              |  1 +
 docs/user/index.rst                         |  3 +-
 20 files changed, 84 insertions(+), 51 deletions(-)
 create mode 100644 docs/system/i386/cpu.rst
 rename docs/{intel-sgx.txt => system/i386/sgx.rst} (83%)

-- 
2.31.1




reply via email to

[Prev in Thread] Current Thread [Next in Thread]