From: Kashyap Chamarthy <kchamart@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>
Cc: "Daniel P. Berrange" <berrange@redhat.com>,
QEMU Developers <qemu-devel@nongnu.org>,
Eduardo Habkost <ehabkost@redhat.com>
Subject: Re: [PATCH v2 1/2] docs: Convert qemu-cpu-models.texi to rST
Date: Wed, 19 Feb 2020 17:40:07 +0100 [thread overview]
Message-ID: <20200219164007.GC24572@paraplu> (raw)
In-Reply-To: <CAFEAcA94A3doGQthOTrPuMadOfqrSLBadUbi+3BpHr1MGp_w1A@mail.gmail.com>
On Wed, Feb 19, 2020 at 01:16:11PM +0000, Peter Maydell wrote:
[...]
> 3) we create a qemu-cpu-models.7 manpage, so the parts
> of Makefile that currently handle creating it from the
> texi need to be changed to do it from the rST instead.
> You can look at how we handle qemu-block-drivers.7
> for an example. Don't forget that you'll need to add
> a line to docs/system/conf.py to get Sphinx to build
> the manpage, as well as the makefile changes.
> You can check how the manpage renders with
> 'man -l /path/to/builddir/docs/interop/qemu-cpu-models.7'
Peter, how are you able to generate those *.7 `nroff` man pages? When I
do 'make sphinxbuild' from my build dir ($HOME/buld/qemu), I only see:
$> make sphinxdocs
[...]
make: Nothing to be done for 'sphinxdocs'.
$> ls -ls docs/system/ | awk '{print $10}';
genindex.html
index.html
objects.inv
qemu-block-drivers.html
qemu-cpu-models.html
search.html
searchindex.js
_static
No *.7 `nroff` files in docs/system/ nor in docs/interop/.
FWIW, I do have the below bit in docs/system/conf.py:
...
man_pages = [
('qemu-block-drivers', 'qemu-block-drivers',
u'QEMU block drivers reference',
['Fabrice Bellard and the QEMU Project developers'], 7),
('qemu-cpu-models', 'qemu-cpu-models',
u'QEMU CPU Models',
['Fabrice Bellard and the QEMU Project developers'], 7)
]
...
[...]
--
/kashyap
next prev parent reply other threads:[~2020-02-19 17:06 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-19 11:46 [PATCH v2 0/2] This small series does two things: Kashyap Chamarthy
2020-02-19 11:46 ` [PATCH v2 1/2] docs: Convert qemu-cpu-models.texi to rST Kashyap Chamarthy
2020-02-19 13:16 ` Peter Maydell
2020-02-19 15:22 ` Kashyap Chamarthy
2020-02-19 16:40 ` Kashyap Chamarthy [this message]
2020-02-19 17:57 ` Peter Maydell
2020-02-20 10:23 ` Kashyap Chamarthy
2020-02-20 10:56 ` Peter Maydell
2020-02-19 11:46 ` [PATCH v2 2/2] qemu-cpu-models.rst: Document -noTSX, mds-no, taa-no, and tsx-ctrl Kashyap Chamarthy
2020-02-19 12:05 ` [PATCH v2 0/2] This small series does two things: no-reply
2020-02-19 14:06 ` Kashyap Chamarthy
2020-02-19 12:07 ` qemu-cpu-models: Convert to rST; document other MSR bits [Was: Re: [PATCH v2 0/2] This small series does two things:] Kashyap Chamarthy
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=20200219164007.GC24572@paraplu \
--to=kchamart@redhat.com \
--cc=berrange@redhat.com \
--cc=ehabkost@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).