qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Peter Maydell <peter.maydell@linaro.org>
To: Paolo Bonzini <pbonzini@redhat.com>
Cc: QEMU Developers <qemu-devel@nongnu.org>,
	Stefan Hajnoczi <stefanha@redhat.com>
Subject: Re: [PATCH 0/4] docs: Miscellaneous rST conversions
Date: Tue, 25 Feb 2020 17:59:33 +0000	[thread overview]
Message-ID: <CAFEAcA9KmsHS4fnYWvpMMa5SLLUBjiPcOsfmGOHcWopd11M3+g@mail.gmail.com> (raw)
In-Reply-To: <6ed08bea-4fcb-08dc-417c-a0f534173a31@redhat.com>

On Tue, 25 Feb 2020 at 17:48, Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> On 25/02/20 18:11, Peter Maydell wrote:
> >> I assume these are not meant to be applied now, except patch 2?
> > No, I intended them to be reviewable and applied now. Why
> > do you think we should wait?
>
> Because they remove information from qemu-doc.texi.  I think it's
> feasible to do a mass conversion quite soon, within a single pull
> request, the only important part that is missing is the hxtool conversion.

My assumption was that we would attack this by:
 * converting chunks of the documentation which are in qemu-doc.texi
   but which aren't in the qemu.1 manpage (basically in the way this
   series is doing)
 * get the qapidoc generation conversion reviewed and into
   master (since at the moment it outputs into files included
   from qemu-doc)
 * convert the manpage parts; we have the machinery for dealing
   with the hxtool files, it just needs a little more work

> (See also the patches I posted today, which take the opposite direction
> of making qemu-doc.texi's structure more like what we'll have in the end
> in docs/system).

This ought to make it easier to do the conversion of the
various subparts, right?

Incidentally:
> makeinfo -o - --docbook security.texi  | pandoc -f docbook -t rst

security texi was the really easy one here. I had to do more
manual formatting fixups on qemu-deprecated.texi which I'm
sceptical would have worked out as nicely done automatically.

The automatic conversion rune also doesn't seem to get quotes
and apostrophes right: it has turned "guest B's disk image" into
something with a smartquote character in it, for instance.

thanks
-- PMM


  reply	other threads:[~2020-02-25 18:00 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-25 15:41 [PATCH 0/4] docs: Miscellaneous rST conversions Peter Maydell
2020-02-25 15:41 ` [PATCH 1/4] docs: Convert security.texi to rST format Peter Maydell
2020-02-26 11:48   ` Aleksandar Markovic
2020-02-25 15:41 ` [PATCH 2/4] docs: Remove the "CPU emulation" part of the "Implementation notes" Peter Maydell
2020-02-26 11:33   ` Aleksandar Markovic
2020-02-25 15:41 ` [PATCH 3/4] docs: Convert 'managed start up options' docs to rST Peter Maydell
2020-02-26 11:49   ` Aleksandar Markovic
2020-02-25 15:41 ` [PATCH 4/4] docs: Convert qemu-deprecated.texi " Peter Maydell
2020-02-26  0:33   ` Alistair Francis
2020-02-26 11:24   ` Aleksandar Markovic
2020-02-25 17:01 ` [PATCH 0/4] docs: Miscellaneous rST conversions Paolo Bonzini
2020-02-25 17:11   ` Peter Maydell
2020-02-25 17:48     ` Paolo Bonzini
2020-02-25 17:59       ` Peter Maydell [this message]
2020-02-25 18:28         ` Paolo Bonzini
2020-02-25 18:56           ` Peter Maydell
2020-02-25 19:10             ` Paolo Bonzini
2020-02-25 19:50               ` Peter Maydell
2020-02-25 20:09                 ` Paolo Bonzini
2020-02-25 22:32                   ` Peter Maydell
2020-02-26  7:50         ` Markus Armbruster
2020-02-26  8:40           ` 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=CAFEAcA9KmsHS4fnYWvpMMa5SLLUBjiPcOsfmGOHcWopd11M3+g@mail.gmail.com \
    --to=peter.maydell@linaro.org \
    --cc=pbonzini@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanha@redhat.com \
    /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).