Re: [PATCH 0/3] docs: Create a 'tools' manual

[Paolo Bonzini]

On 17/02/20 17:18, Peter Maydell wrote:
> The mechanics for handling .hx files are already in the tree;
> I can either help or work on the bit of qemu.1 that uses those.

Right, basically if somebody else does qemu.1 I won't complain. :)  But
recently I retested the makeinfo+pandoc magic formulae that convert the
rest into rST and they work so I can take care of that part.

> Kashyap has volunteered to do qemu-cpu-models.texi.
> I have patches on-list that try to do the QAPI doc-comments.
> 
> I think the next thing after this is to take chunks of documentation
> that are currently used in qemu-doc.html but not put into the
> qemu.1 manpage (ie which aren't in the 'man begin'/'man end'
> sections), and convert those into individual .rst files
> to go into docs/system:
> 
>  * docs/security.texi
>  * qemu-tech.texi
>  * qemu-deprecated.texi
>  * various bits of qemu-doc.texi that don't go in the
>    manpage and that are coherent chunks of documentation,
>    eg "Supported build platforms", the various "$ARCH System emulator"
>    sections

One initial step here is to split qemu-doc.texi into separate Texinfo
files.  I can take a look at that as well.

Paolo

> That will whittle qemu-doc.texi down to more or less just
> the contents of the manpage. Then we can convert that
> part to rST.
> 
> I note that softfreeze is now 1 month away -- we should
> decide whether we think we can get this basically all
> done by then, or whether there's a good "pause point"
> we'd like to use where, say, most of qemu-doc.texi
> remains as it is, or where it retains just the
> content that goes into the qemu.1 manpage.