From: Peter Maydell <peter.maydell@linaro.org>
To: qemu-devel@nongnu.org
Cc: Paolo Bonzini <pbonzini@redhat.com>,
Markus Armbruster <armbru@redhat.com>,
Maxim Cournoyer <maxim.cournoyer@gmail.com>
Subject: [RFC 1/2] docs: Mark rst files in the top level directory as orphan
Date: Mon, 9 Nov 2020 21:44:19 +0000 [thread overview]
Message-ID: <20201109214420.32131-2-peter.maydell@linaro.org> (raw)
In-Reply-To: <20201109214420.32131-1-peter.maydell@linaro.org>
We have a handful of rst files currently in the top level docs
directory. These need to be moved into their proper places in the
new manual framework, possibly involving splitting them into
multiple pieces.
In the meantime, to avoid warnings about these documents being
orphaned if you build a single Sphinx manual rooted in docs/,
mark each of them as being deliberate orphans.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
docs/cpu-hotplug.rst | 2 ++
docs/microvm.rst | 2 ++
docs/pr-manager.rst | 2 ++
docs/virtio-net-failover.rst | 2 ++
docs/virtio-pmem.rst | 1 +
5 files changed, 9 insertions(+)
diff --git a/docs/cpu-hotplug.rst b/docs/cpu-hotplug.rst
index d0b06403f19..d5fe2c7db1a 100644
--- a/docs/cpu-hotplug.rst
+++ b/docs/cpu-hotplug.rst
@@ -1,3 +1,5 @@
+:orphan:
+
===================
Virtual CPU hotplug
===================
diff --git a/docs/microvm.rst b/docs/microvm.rst
index fcf41fc1f6f..8de8cea1864 100644
--- a/docs/microvm.rst
+++ b/docs/microvm.rst
@@ -1,3 +1,5 @@
+:orphan:
+
====================
microvm Machine Type
====================
diff --git a/docs/pr-manager.rst b/docs/pr-manager.rst
index 9b1de198b1b..87a2f237f52 100644
--- a/docs/pr-manager.rst
+++ b/docs/pr-manager.rst
@@ -1,3 +1,5 @@
+:orphan:
+
======================================
Persistent reservation managers
======================================
diff --git a/docs/virtio-net-failover.rst b/docs/virtio-net-failover.rst
index 6002dc5d96e..9d50d457e72 100644
--- a/docs/virtio-net-failover.rst
+++ b/docs/virtio-net-failover.rst
@@ -1,3 +1,5 @@
+:orphan:
+
======================================
QEMU virtio-net standby (net_failover)
======================================
diff --git a/docs/virtio-pmem.rst b/docs/virtio-pmem.rst
index 4bf5d004432..aab35489851 100644
--- a/docs/virtio-pmem.rst
+++ b/docs/virtio-pmem.rst
@@ -1,3 +1,4 @@
+:orphan:
========================
QEMU virtio pmem
--
2.20.1
next prev parent reply other threads:[~2020-11-09 21:46 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-09 21:44 [RFC 0/2] Build a single Sphinx manual, not five Peter Maydell
2020-11-09 21:44 ` Peter Maydell [this message]
2020-11-09 21:44 ` [RFC 2/2] docs: Build and install all the docs in a single manual Peter Maydell
2020-11-10 16:40 ` [RFC 0/2] Build a single Sphinx manual, not five Paolo Bonzini
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=20201109214420.32131-2-peter.maydell@linaro.org \
--to=peter.maydell@linaro.org \
--cc=armbru@redhat.com \
--cc=maxim.cournoyer@gmail.com \
--cc=pbonzini@redhat.com \
--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).