From: Paolo Bonzini <pbonzini@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org
Subject: [PATCH 0/5] docs: reorganize target-i386 to make room for SGX
Date: Tue, 7 Sep 2021 17:56:36 +0200 [thread overview]
Message-ID: <20210907155641.197844-1-pbonzini@redhat.com> (raw)
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
next reply other threads:[~2021-09-07 15:59 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-07 15:56 Paolo Bonzini [this message]
2021-09-07 15:56 ` [PATCH 1/5] docs: standardize book titles to === with overline Paolo Bonzini
2021-09-07 16:08 ` Peter Maydell
2021-09-07 15:56 ` [PATCH 2/5] docs: standardize directory index to --- " Paolo Bonzini
2021-09-07 16:08 ` Peter Maydell
2021-09-07 15:56 ` [PATCH 3/5] docs/system: standardize docs/system man page sections " Paolo Bonzini
2021-09-07 16:21 ` Peter Maydell
2021-09-07 15:56 ` [PATCH 4/5] docs/system: move x86 CPU configuration to a separate document Paolo Bonzini
2021-09-07 16:23 ` Peter Maydell
2021-09-07 15:56 ` [PATCH 5/5] docs/system: move SGX documentation within the system docs Paolo Bonzini
2021-09-07 16:28 ` Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210907155641.197844-1-pbonzini@redhat.com \
--to=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).