[v4] qemu-cpu-models: Convert to rST; document other MSR bits

[PATCH v4 0/2] qemu-cpu-models: Convert to rST; document other MSR bits

Kashyap Chamarthy posted 2 patches 4 years, 2 months ago

Diff against v3 v3
Download series mbox

Test docker-quick@centos7 failed

Test FreeBSD passed

Test checkpatch passed

Test docker-mingw@fedora failed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20200225165618.6571-1-kchamart@redhat.com

Maintainers: Paolo Bonzini <pbonzini@redhat.com>, Eduardo Habkost <ehabkost@redhat.com>, Richard Henderson <rth@twiddle.net>, Peter Maydell <peter.maydell@linaro.org>

MAINTAINERS                     |   2 +-
Makefile                        |  12 +-
docs/conf.py                    |   2 +-
docs/qemu-cpu-models.texi       | 677 --------------------------------
docs/system/conf.py             |   5 +-
docs/system/index.rst           |   1 +
docs/system/qemu-cpu-models.rst | 535 +++++++++++++++++++++++++
qemu-doc.texi                   |   5 -
8 files changed, 548 insertions(+), 691 deletions(-)
delete mode 100644 docs/qemu-cpu-models.texi
create mode 100644 docs/system/qemu-cpu-models.rst

Expand all Fold all

[PATCH v4 0/2] qemu-cpu-models: Convert to rST; document other MSR bits

Posted by Kashyap Chamarthy 4 years, 2 months ago

In v4:
 - Correctly use the 'define-man-page' rule for qemu-cpu-models.7
   [pm215]
 - Fix author attribution as per the thread:
   Message-ID:
   <CAFEAcA8dTR6xkQnsf32HAo6aDXf5Z0UmkhL3+257KWLj1ES6Sw@mail.gmail.com>
   [danpb, pm215]
 - Don't reverse the existing order of the list of CPU models [pm215]
 - Use rST "definition lists" consistently throughout the document.
 - Consistently capitalize the phrase: "The QEMU Project Developers"
 - Update the year of copyright to 2020 in docs/conf.py
 - Fix two minor rST-related things [pbonzini]

In v3:
 - Address the comments from Peter Maydell, from here:
   https://lists.nongnu.org/archive/html/qemu-devel/2020-02/msg05155.html

This small series does two things:

(1) Convert the original qemu-cpu-models.texi to rST

(2) In a separate patch, incorporate the additional new content from
    this:
    https://lists.nongnu.org/archive/html/qemu-devel/2020-01/msg06455.html
    ([PATCH v3] qemu-cpu-models: Document -noTSX, mds-no, taa-no, and
    tsx-ctrl)

Sphinx rendering of v4:

    https://kashyapc.fedorapeople.org/QEMU_v4.2.0-1858-gdb736e0437/system/qemu-cpu-models.html

        - - -

(Note to self: The comma-separated list of CPU models are not terribly
legible that they are all different CPU models.  Wonder if we should do
something about it...)

Kashyap Chamarthy (2):
  docs: Convert qemu-cpu-models.texi to rST; related fixes
  qemu-cpu-models.rst: Document -noTSX, mds-no, taa-no, and tsx-ctrl

 MAINTAINERS                     |   2 +-
 Makefile                        |  12 +-
 docs/conf.py                    |   2 +-
 docs/qemu-cpu-models.texi       | 677 --------------------------------
 docs/system/conf.py             |   5 +-
 docs/system/index.rst           |   1 +
 docs/system/qemu-cpu-models.rst | 535 +++++++++++++++++++++++++
 qemu-doc.texi                   |   5 -
 8 files changed, 548 insertions(+), 691 deletions(-)
 delete mode 100644 docs/qemu-cpu-models.texi
 create mode 100644 docs/system/qemu-cpu-models.rst

-- 
2.21.0

Re: [PATCH v4 0/2] qemu-cpu-models: Convert to rST; document other MSR bits

Posted by Paolo Bonzini 4 years, 2 months ago

On 25/02/20 17:56, Kashyap Chamarthy wrote:
> In v4:
>  - Correctly use the 'define-man-page' rule for qemu-cpu-models.7
>    [pm215]
>  - Fix author attribution as per the thread:
>    Message-ID:
>    <CAFEAcA8dTR6xkQnsf32HAo6aDXf5Z0UmkhL3+257KWLj1ES6Sw@mail.gmail.com>
>    [danpb, pm215]
>  - Don't reverse the existing order of the list of CPU models [pm215]
>  - Use rST "definition lists" consistently throughout the document.
>  - Consistently capitalize the phrase: "The QEMU Project Developers"
>  - Update the year of copyright to 2020 in docs/conf.py
>  - Fix two minor rST-related things [pbonzini]

Thanks, I queued this series.  I'm not sure when it will be applied, as
that depends on how the rest of the rST conversion will be done.

Paolo