[Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs

Peter Maydell posted 11 patches 5 years, 1 month ago
Test asan failed
Test docker-mingw@fedora failed
Test docker-clang@ubuntu failed
Test checkpatch failed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20190201145035.22739-1-peter.maydell@linaro.org
There is a newer version of this series
configure                             |   4 +-
Makefile                              |  78 +++++++---
docs/conf.py                          | 215 ++++++++++++++++++++++++++
docs/cpu-hotplug.rst                  |   2 +-
docs/devel/conf.py                    |  15 ++
docs/devel/index.rst                  |  21 +++
docs/devel/{memory.txt => memory.rst} | 128 ++++++++-------
docs/index.rst                        |  15 ++
docs/interop/conf.py                  |  15 ++
docs/interop/index.rst                |  18 +++
10 files changed, 430 insertions(+), 81 deletions(-)
create mode 100644 docs/conf.py
create mode 100644 docs/devel/conf.py
create mode 100644 docs/devel/index.rst
rename docs/devel/{memory.txt => memory.rst} (85%)
create mode 100644 docs/index.rst
create mode 100644 docs/interop/conf.py
create mode 100644 docs/interop/index.rst
[Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by Peter Maydell 5 years, 1 month ago
This patchset enables building and installing the various rST
docs we have started to accumulate in our docs/ directory.
It does this using Sphinx (which is the docs tooling that the
Linux kernel uses). The series is not trying to take us in one
giant leap to a brave new Sphinx-powered world -- it is simply
setting up a framework so that we are at least building and
shipping these documents and can gradually migrate other parts
of our documentation to it.

The approach I've used here is that we will have multiple "manuals",
as proposed by Paolo here:
  https://wiki.qemu.org/Features/Documentation
For the moment I've only created 'interop' and 'devel' as we don't
yet have any rST files for 'user', 'system' or 'specs'.

One slightly awkward mismatch between how Sphinx naturally wants
to work and our requirements is that when Sphinx generates a
documentation set all in one go it creates hyperlinks between
all the docs, they all appear in a single top level table of
contents, and so on. But for QEMU's docs we don't want to
ship the "devel" manual to end-users. I've taken an approach
suggested to me on sphinx-users
(https://www.mail-archive.com/sphinx-users@googlegroups.com/msg03224.html)
where we run Sphinx once per manual, and treat them as
entirely separate documents. The config/tooling in this patchset
also supports building everything in a single run, for compatibility
with third-party docs sites like readthedocs.org.

To see the results:

What you get in the docs/ subdir of your build directory
when you do a local build:
 http://people.linaro.org/~peter.maydell/build-dir-docs/
(follow the links to 'devel' and 'interop' for the two manuals)

What we'll ship in 'make install' in /usr/local/share/doc/qemu/
http://people.linaro.org/~peter.maydell/installed-docs/
(should be same as the build dir except we don't ship 'devel')

What you get with a standalone single-run docs build:
 http://people.linaro.org/~peter.maydell/standalone-docs/index.html

These use the default 'alabaster' theme from Sphinx. I
also experimented with the 'read_the_docs' theme, which I
do think looks nicer. Unfortunately it also requires the
docs we install to include about 3MB of TrueType font files
per manual, which is awkward licensing-wise as the TTFs are
under the Open Font License and it's not completely clear to
me that it's OK to ship those to use with a doc file that is
GPLed. Alabaster doesn't ship fonts, which sidesteps both
those problems.

Other notes:
 * this does not build the two .rst files that are directly
   in docs/ (cpu-hotplug.rst and pr-manager.rst) -- we should
   move these to whichever of the five manuals is the best place
 * I do have some prototype patches which integrate the kernel's
   kerneldoc Sphinx extension to parse doc comments in source
   code. I haven't included them here because I think the 'devel'
   manual is the lowest priority of the five. They might be
   useful if we want to try things like building documentation
   of supported machine models from in-code comments/etc, though.
 * as noted in a previous email thread, the configure changes
   now mean that building docs depends on build-sphinx being
   available, so this is a new build-dep for --enable-docs.

thanks
-- PMM

Peter Maydell (11):
  docs/cpu-hotplug.rst: Fix rST markup issues
  docs: Convert memory.txt to rst format
  docs: Commit initial files from sphinx-quickstart
  docs/conf.py: Disable unused _static directory
  docs/conf.py: Configure the 'alabaster' theme
  docs/conf.py: Don't include rST sources in HTML build
  docs/conf.py: Disable option warnings
  Separate conf.py for each manual we want
  Makefile, configure: Support building rST documentation
  Makefile: Abstract out "identify the pkgversion" code
  docs/conf.py: Don't hard-code QEMU version

 configure                             |   4 +-
 Makefile                              |  78 +++++++---
 docs/conf.py                          | 215 ++++++++++++++++++++++++++
 docs/cpu-hotplug.rst                  |   2 +-
 docs/devel/conf.py                    |  15 ++
 docs/devel/index.rst                  |  21 +++
 docs/devel/{memory.txt => memory.rst} | 128 ++++++++-------
 docs/index.rst                        |  15 ++
 docs/interop/conf.py                  |  15 ++
 docs/interop/index.rst                |  18 +++
 10 files changed, 430 insertions(+), 81 deletions(-)
 create mode 100644 docs/conf.py
 create mode 100644 docs/devel/conf.py
 create mode 100644 docs/devel/index.rst
 rename docs/devel/{memory.txt => memory.rst} (85%)
 create mode 100644 docs/index.rst
 create mode 100644 docs/interop/conf.py
 create mode 100644 docs/interop/index.rst

-- 
2.20.1


Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Message-id: 20190201145035.22739-1-peter.maydell@linaro.org
Type: series

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
 - [tag update]      patchew/20190201145035.22739-1-peter.maydell@linaro.org -> patchew/20190201145035.22739-1-peter.maydell@linaro.org
Submodule 'capstone' (https://git.qemu.org/git/capstone.git) registered for path 'capstone'
Submodule 'dtc' (https://git.qemu.org/git/dtc.git) registered for path 'dtc'
Submodule 'roms/QemuMacDrivers' (https://git.qemu.org/git/QemuMacDrivers.git) registered for path 'roms/QemuMacDrivers'
Submodule 'roms/SLOF' (https://git.qemu.org/git/SLOF.git) registered for path 'roms/SLOF'
Submodule 'roms/ipxe' (https://git.qemu.org/git/ipxe.git) registered for path 'roms/ipxe'
Submodule 'roms/openbios' (https://git.qemu.org/git/openbios.git) registered for path 'roms/openbios'
Submodule 'roms/openhackware' (https://git.qemu.org/git/openhackware.git) registered for path 'roms/openhackware'
Submodule 'roms/qemu-palcode' (https://git.qemu.org/git/qemu-palcode.git) registered for path 'roms/qemu-palcode'
Submodule 'roms/seabios' (https://git.qemu.org/git/seabios.git/) registered for path 'roms/seabios'
Submodule 'roms/seabios-hppa' (https://github.com/hdeller/seabios-hppa.git) registered for path 'roms/seabios-hppa'
Submodule 'roms/sgabios' (https://git.qemu.org/git/sgabios.git) registered for path 'roms/sgabios'
Submodule 'roms/skiboot' (https://git.qemu.org/git/skiboot.git) registered for path 'roms/skiboot'
Submodule 'roms/u-boot' (https://git.qemu.org/git/u-boot.git) registered for path 'roms/u-boot'
Submodule 'roms/u-boot-sam460ex' (https://git.qemu.org/git/u-boot-sam460ex.git) registered for path 'roms/u-boot-sam460ex'
Submodule 'tests/fp/berkeley-softfloat-3' (https://github.com/cota/berkeley-softfloat-3) registered for path 'tests/fp/berkeley-softfloat-3'
Submodule 'tests/fp/berkeley-testfloat-3' (https://github.com/cota/berkeley-testfloat-3) registered for path 'tests/fp/berkeley-testfloat-3'
Submodule 'ui/keycodemapdb' (https://git.qemu.org/git/keycodemapdb.git) registered for path 'ui/keycodemapdb'
Cloning into 'capstone'...
Submodule path 'capstone': checked out '22ead3e0bfdb87516656453336160e0a37b066bf'
Cloning into 'dtc'...
Submodule path 'dtc': checked out '88f18909db731a627456f26d779445f84e449536'
Cloning into 'roms/QemuMacDrivers'...
Submodule path 'roms/QemuMacDrivers': checked out 'd4e7d7ac663fcb55f1b93575445fcbca372f17a7'
Cloning into 'roms/SLOF'...
Submodule path 'roms/SLOF': checked out '9b7ab2fa020341dee8bf9df6c9cf40003e0136df'
Cloning into 'roms/ipxe'...
Submodule path 'roms/ipxe': checked out 'de4565cbe76ea9f7913a01f331be3ee901bb6e17'
Cloning into 'roms/openbios'...
Submodule path 'roms/openbios': checked out '441a84d3a642a10b948369c63f32367e8ff6395b'
Cloning into 'roms/openhackware'...
Submodule path 'roms/openhackware': checked out 'c559da7c8eec5e45ef1f67978827af6f0b9546f5'
Cloning into 'roms/qemu-palcode'...
Submodule path 'roms/qemu-palcode': checked out '51c237d7e20d05100eacadee2f61abc17e6bc097'
Cloning into 'roms/seabios'...
Submodule path 'roms/seabios': checked out 'a698c8995ffb2838296ec284fe3c4ad33dfca307'
Cloning into 'roms/seabios-hppa'...
Submodule path 'roms/seabios-hppa': checked out '1ef99a01572c2581c30e16e6fe69e9ea2ef92ce0'
Cloning into 'roms/sgabios'...
Submodule path 'roms/sgabios': checked out 'cbaee52287e5f32373181cff50a00b6c4ac9015a'
Cloning into 'roms/skiboot'...
Submodule path 'roms/skiboot': checked out 'e0ee24c27a172bcf482f6f2bc905e6211c134bcc'
Cloning into 'roms/u-boot'...
Submodule path 'roms/u-boot': checked out 'd85ca029f257b53a96da6c2fb421e78a003a9943'
Cloning into 'roms/u-boot-sam460ex'...
Submodule path 'roms/u-boot-sam460ex': checked out '60b3916f33e617a815973c5a6df77055b2e3a588'
Cloning into 'tests/fp/berkeley-softfloat-3'...
Submodule path 'tests/fp/berkeley-softfloat-3': checked out 'b64af41c3276f97f0e181920400ee056b9c88037'
Cloning into 'tests/fp/berkeley-testfloat-3'...
Submodule path 'tests/fp/berkeley-testfloat-3': checked out '5a59dcec19327396a011a17fd924aed4fec416b3'
Cloning into 'ui/keycodemapdb'...
Submodule path 'ui/keycodemapdb': checked out '6b3d716e2b6472eb7189d3220552280ef3d832ce'
Switched to a new branch 'test'
50a0f0d docs/conf.py: Don't hard-code QEMU version
7b5fa8d Makefile: Abstract out "identify the pkgversion" code
e9566ec Makefile, configure: Support building rST documentation
08de861 Separate conf.py for each manual we want
42806c5 docs/conf.py: Disable option warnings
e50a106 docs/conf.py: Don't include rST sources in HTML build
2e1a650 docs/conf.py: Configure the 'alabaster' theme
14b7b18 docs/conf.py: Disable unused _static directory
d991b45 docs: Commit initial files from sphinx-quickstart
4f429cd docs: Convert memory.txt to rst format
56f8e4a docs/cpu-hotplug.rst: Fix rST markup issues

=== OUTPUT BEGIN ===
1/11 Checking commit 56f8e4a6c708 (docs/cpu-hotplug.rst: Fix rST markup issues)
2/11 Checking commit 4f429cddf421 (docs: Convert memory.txt to rst format)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#22: 
rename from docs/devel/memory.txt

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/11 Checking commit d991b4506b86 (docs: Commit initial files from sphinx-quickstart)
ERROR: Missing Signed-off-by: line(s)

total: 1 errors, 0 warnings, 188 lines checked

Patch 3/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

4/11 Checking commit 14b7b18b70c3 (docs/conf.py: Disable unused _static directory)
5/11 Checking commit 2e1a65022bc1 (docs/conf.py: Configure the 'alabaster' theme)
6/11 Checking commit e50a106d7dc5 (docs/conf.py: Don't include rST sources in HTML build)
7/11 Checking commit 42806c50e248 (docs/conf.py: Disable option warnings)
8/11 Checking commit 08de86173b2e (Separate conf.py for each manual we want)
ERROR: line over 90 characters
#160: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

ERROR: Missing Signed-off-by: line(s)

total: 2 errors, 0 warnings, 133 lines checked

Patch 8/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

9/11 Checking commit e9566ecba8ed (Makefile, configure: Support building rST documentation)
10/11 Checking commit 7b5fa8d95384 (Makefile: Abstract out "identify the pkgversion" code)
11/11 Checking commit 50a0f0d5ce2d (docs/conf.py: Don't hard-code QEMU version)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Type: series
Message-id: 20190201145035.22739-1-peter.maydell@linaro.org

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
 t [tag update]            patchew/20190201145035.22739-1-peter.maydell@linaro.org -> patchew/20190201145035.22739-1-peter.maydell@linaro.org
Switched to a new branch 'test'
ea679f0a91 docs/conf.py: Don't hard-code QEMU version
9c6cbba2e1 Makefile: Abstract out "identify the pkgversion" code
526f97104a Makefile, configure: Support building rST documentation
665a9ff147 Separate conf.py for each manual we want
4a0ad1654a docs/conf.py: Disable option warnings
daffe99f6b docs/conf.py: Don't include rST sources in HTML build
7f2b1c3878 docs/conf.py: Configure the 'alabaster' theme
0edad2daa3 docs/conf.py: Disable unused _static directory
d698375a4c docs: Commit initial files from sphinx-quickstart
bca5202bdd docs: Convert memory.txt to rst format
0e9ffb13db docs/cpu-hotplug.rst: Fix rST markup issues

=== OUTPUT BEGIN ===
1/11 Checking commit 0e9ffb13dbaa (docs/cpu-hotplug.rst: Fix rST markup issues)
2/11 Checking commit bca5202bddee (docs: Convert memory.txt to rst format)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#22: 
rename from docs/devel/memory.txt

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/11 Checking commit d698375a4c62 (docs: Commit initial files from sphinx-quickstart)
ERROR: Missing Signed-off-by: line(s)

total: 1 errors, 0 warnings, 188 lines checked

Patch 3/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

4/11 Checking commit 0edad2daa354 (docs/conf.py: Disable unused _static directory)
5/11 Checking commit 7f2b1c387830 (docs/conf.py: Configure the 'alabaster' theme)
6/11 Checking commit daffe99f6be5 (docs/conf.py: Don't include rST sources in HTML build)
7/11 Checking commit 4a0ad1654af4 (docs/conf.py: Disable option warnings)
8/11 Checking commit 665a9ff14735 (Separate conf.py for each manual we want)
ERROR: line over 90 characters
#161: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

ERROR: Missing Signed-off-by: line(s)

total: 2 errors, 0 warnings, 133 lines checked

Patch 8/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

9/11 Checking commit 526f97104aac (Makefile, configure: Support building rST documentation)
10/11 Checking commit 9c6cbba2e17b (Makefile: Abstract out "identify the pkgversion" code)
11/11 Checking commit ea679f0a91a6 (docs/conf.py: Don't hard-code QEMU version)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by Peter Maydell 5 years, 1 month ago
Ping! Thanks to Alex for doing low-level review of this patchset.
I'm particularly interested in high-level review:
 * is this the right way to be going?
 * if we committed this and then did a release with the
   docs as they are like this, would that be ok?
 * what's the most important next step after this?

thanks
-- PMM

On Fri, 1 Feb 2019 at 14:50, Peter Maydell <peter.maydell@linaro.org> wrote:
>
> This patchset enables building and installing the various rST
> docs we have started to accumulate in our docs/ directory.
> It does this using Sphinx (which is the docs tooling that the
> Linux kernel uses). The series is not trying to take us in one
> giant leap to a brave new Sphinx-powered world -- it is simply
> setting up a framework so that we are at least building and
> shipping these documents and can gradually migrate other parts
> of our documentation to it.
>
> The approach I've used here is that we will have multiple "manuals",
> as proposed by Paolo here:
>   https://wiki.qemu.org/Features/Documentation
> For the moment I've only created 'interop' and 'devel' as we don't
> yet have any rST files for 'user', 'system' or 'specs'.
>
> One slightly awkward mismatch between how Sphinx naturally wants
> to work and our requirements is that when Sphinx generates a
> documentation set all in one go it creates hyperlinks between
> all the docs, they all appear in a single top level table of
> contents, and so on. But for QEMU's docs we don't want to
> ship the "devel" manual to end-users. I've taken an approach
> suggested to me on sphinx-users
> (https://www.mail-archive.com/sphinx-users@googlegroups.com/msg03224.html)
> where we run Sphinx once per manual, and treat them as
> entirely separate documents. The config/tooling in this patchset
> also supports building everything in a single run, for compatibility
> with third-party docs sites like readthedocs.org.
>
> To see the results:
>
> What you get in the docs/ subdir of your build directory
> when you do a local build:
>  http://people.linaro.org/~peter.maydell/build-dir-docs/
> (follow the links to 'devel' and 'interop' for the two manuals)
>
> What we'll ship in 'make install' in /usr/local/share/doc/qemu/
> http://people.linaro.org/~peter.maydell/installed-docs/
> (should be same as the build dir except we don't ship 'devel')
>
> What you get with a standalone single-run docs build:
>  http://people.linaro.org/~peter.maydell/standalone-docs/index.html
>
> These use the default 'alabaster' theme from Sphinx. I
> also experimented with the 'read_the_docs' theme, which I
> do think looks nicer. Unfortunately it also requires the
> docs we install to include about 3MB of TrueType font files
> per manual, which is awkward licensing-wise as the TTFs are
> under the Open Font License and it's not completely clear to
> me that it's OK to ship those to use with a doc file that is
> GPLed. Alabaster doesn't ship fonts, which sidesteps both
> those problems.
>
> Other notes:
>  * this does not build the two .rst files that are directly
>    in docs/ (cpu-hotplug.rst and pr-manager.rst) -- we should
>    move these to whichever of the five manuals is the best place
>  * I do have some prototype patches which integrate the kernel's
>    kerneldoc Sphinx extension to parse doc comments in source
>    code. I haven't included them here because I think the 'devel'
>    manual is the lowest priority of the five. They might be
>    useful if we want to try things like building documentation
>    of supported machine models from in-code comments/etc, though.
>  * as noted in a previous email thread, the configure changes
>    now mean that building docs depends on build-sphinx being
>    available, so this is a new build-dep for --enable-docs.
>
> thanks
> -- PMM
>
> Peter Maydell (11):
>   docs/cpu-hotplug.rst: Fix rST markup issues
>   docs: Convert memory.txt to rst format
>   docs: Commit initial files from sphinx-quickstart
>   docs/conf.py: Disable unused _static directory
>   docs/conf.py: Configure the 'alabaster' theme
>   docs/conf.py: Don't include rST sources in HTML build
>   docs/conf.py: Disable option warnings
>   Separate conf.py for each manual we want
>   Makefile, configure: Support building rST documentation
>   Makefile: Abstract out "identify the pkgversion" code
>   docs/conf.py: Don't hard-code QEMU version
>
>  configure                             |   4 +-
>  Makefile                              |  78 +++++++---
>  docs/conf.py                          | 215 ++++++++++++++++++++++++++
>  docs/cpu-hotplug.rst                  |   2 +-
>  docs/devel/conf.py                    |  15 ++
>  docs/devel/index.rst                  |  21 +++
>  docs/devel/{memory.txt => memory.rst} | 128 ++++++++-------
>  docs/index.rst                        |  15 ++
>  docs/interop/conf.py                  |  15 ++
>  docs/interop/index.rst                |  18 +++
>  10 files changed, 430 insertions(+), 81 deletions(-)
>  create mode 100644 docs/conf.py
>  create mode 100644 docs/devel/conf.py
>  create mode 100644 docs/devel/index.rst
>  rename docs/devel/{memory.txt => memory.rst} (85%)
>  create mode 100644 docs/index.rst
>  create mode 100644 docs/interop/conf.py
>  create mode 100644 docs/interop/index.rst

Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by Marc-André Lureau 5 years, 1 month ago
Hi

On Thu, Feb 14, 2019 at 12:30 PM Peter Maydell <peter.maydell@linaro.org> wrote:
>
> Ping! Thanks to Alex for doing low-level review of this patchset.

Overall, looks good to me too.

Minor nit: configure doesn't check presence of sphinx-build, and on my
fc29, it's sphinx-build-3 :)

CI files will probably need to be updated.

> I'm particularly interested in high-level review:
>  * is this the right way to be going?
>  * if we committed this and then did a release with the
>    docs as they are like this, would that be ok?

Certainly, it can improve over time imho.

>  * what's the most important next step after this?
>

For me the next steps are:

- merge your series! :)

- integrate the texi doc somehow (apparently Paolo had some solution),
or convert the texi doc to rst (modiy texi2any to do that?)

- have the docs hosted on www.qemu.org, with some stability (ideally,
we could share links to a specific doc, say a QMP command or an
internal API, that would remain stable).

  I wonder why Daniel qemu-web patches aren't yet merged. I remember
some questions regarding doc import and automation. There will be a
similar problem with sphinx doc.

  (gitlab makes this fairly easy with CI artifcats, fwiw ;-)

- convert more of our doc to rst

- add kerneldoc

- improve the style, for consistency with qemu.org style



> thanks
> -- PMM
>
> On Fri, 1 Feb 2019 at 14:50, Peter Maydell <peter.maydell@linaro.org> wrote:
> >
> > This patchset enables building and installing the various rST
> > docs we have started to accumulate in our docs/ directory.
> > It does this using Sphinx (which is the docs tooling that the
> > Linux kernel uses). The series is not trying to take us in one
> > giant leap to a brave new Sphinx-powered world -- it is simply
> > setting up a framework so that we are at least building and
> > shipping these documents and can gradually migrate other parts
> > of our documentation to it.
> >
> > The approach I've used here is that we will have multiple "manuals",
> > as proposed by Paolo here:
> >   https://wiki.qemu.org/Features/Documentation
> > For the moment I've only created 'interop' and 'devel' as we don't
> > yet have any rST files for 'user', 'system' or 'specs'.
> >
> > One slightly awkward mismatch between how Sphinx naturally wants
> > to work and our requirements is that when Sphinx generates a
> > documentation set all in one go it creates hyperlinks between
> > all the docs, they all appear in a single top level table of
> > contents, and so on. But for QEMU's docs we don't want to
> > ship the "devel" manual to end-users. I've taken an approach
> > suggested to me on sphinx-users
> > (https://www.mail-archive.com/sphinx-users@googlegroups.com/msg03224.html)
> > where we run Sphinx once per manual, and treat them as
> > entirely separate documents. The config/tooling in this patchset
> > also supports building everything in a single run, for compatibility
> > with third-party docs sites like readthedocs.org.
> >
> > To see the results:
> >
> > What you get in the docs/ subdir of your build directory
> > when you do a local build:
> >  http://people.linaro.org/~peter.maydell/build-dir-docs/
> > (follow the links to 'devel' and 'interop' for the two manuals)
> >
> > What we'll ship in 'make install' in /usr/local/share/doc/qemu/
> > http://people.linaro.org/~peter.maydell/installed-docs/
> > (should be same as the build dir except we don't ship 'devel')
> >
> > What you get with a standalone single-run docs build:
> >  http://people.linaro.org/~peter.maydell/standalone-docs/index.html
> >
> > These use the default 'alabaster' theme from Sphinx. I
> > also experimented with the 'read_the_docs' theme, which I
> > do think looks nicer. Unfortunately it also requires the
> > docs we install to include about 3MB of TrueType font files
> > per manual, which is awkward licensing-wise as the TTFs are
> > under the Open Font License and it's not completely clear to
> > me that it's OK to ship those to use with a doc file that is
> > GPLed. Alabaster doesn't ship fonts, which sidesteps both
> > those problems.
> >
> > Other notes:
> >  * this does not build the two .rst files that are directly
> >    in docs/ (cpu-hotplug.rst and pr-manager.rst) -- we should
> >    move these to whichever of the five manuals is the best place
> >  * I do have some prototype patches which integrate the kernel's
> >    kerneldoc Sphinx extension to parse doc comments in source
> >    code. I haven't included them here because I think the 'devel'
> >    manual is the lowest priority of the five. They might be
> >    useful if we want to try things like building documentation
> >    of supported machine models from in-code comments/etc, though.
> >  * as noted in a previous email thread, the configure changes
> >    now mean that building docs depends on build-sphinx being
> >    available, so this is a new build-dep for --enable-docs.
> >
> > thanks
> > -- PMM
> >
> > Peter Maydell (11):
> >   docs/cpu-hotplug.rst: Fix rST markup issues
> >   docs: Convert memory.txt to rst format
> >   docs: Commit initial files from sphinx-quickstart
> >   docs/conf.py: Disable unused _static directory
> >   docs/conf.py: Configure the 'alabaster' theme
> >   docs/conf.py: Don't include rST sources in HTML build
> >   docs/conf.py: Disable option warnings
> >   Separate conf.py for each manual we want
> >   Makefile, configure: Support building rST documentation
> >   Makefile: Abstract out "identify the pkgversion" code
> >   docs/conf.py: Don't hard-code QEMU version
> >
> >  configure                             |   4 +-
> >  Makefile                              |  78 +++++++---
> >  docs/conf.py                          | 215 ++++++++++++++++++++++++++
> >  docs/cpu-hotplug.rst                  |   2 +-
> >  docs/devel/conf.py                    |  15 ++
> >  docs/devel/index.rst                  |  21 +++
> >  docs/devel/{memory.txt => memory.rst} | 128 ++++++++-------
> >  docs/index.rst                        |  15 ++
> >  docs/interop/conf.py                  |  15 ++
> >  docs/interop/index.rst                |  18 +++
> >  10 files changed, 430 insertions(+), 81 deletions(-)
> >  create mode 100644 docs/conf.py
> >  create mode 100644 docs/devel/conf.py
> >  create mode 100644 docs/devel/index.rst
> >  rename docs/devel/{memory.txt => memory.rst} (85%)
> >  create mode 100644 docs/index.rst
> >  create mode 100644 docs/interop/conf.py
> >  create mode 100644 docs/interop/index.rst

Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by Peter Maydell 5 years, 1 month ago
On Thu, 14 Feb 2019 at 14:56, Marc-André Lureau
<marcandre.lureau@redhat.com> wrote:
>
> Hi
>
> On Thu, Feb 14, 2019 at 12:30 PM Peter Maydell <peter.maydell@linaro.org> wrote:
> >
> > Ping! Thanks to Alex for doing low-level review of this patchset.
>
> Overall, looks good to me too.
>
> Minor nit: configure doesn't check presence of sphinx-build, and on my
> fc29, it's sphinx-build-3 :)

It does check, but I forgot to make the makefiles pay attention
to the check.

That's very irritating that Fedora is using a weird filename for
the tool -- what is their justification for doing that?
I suppose we'll have to make configure cope :-(

>
> CI files will probably need to be updated.
>
> > I'm particularly interested in high-level review:
> >  * is this the right way to be going?
> >  * if we committed this and then did a release with the
> >    docs as they are like this, would that be ok?
>
> Certainly, it can improve over time imho.
>
> >  * what's the most important next step after this?
> >
>
> For me the next steps are:
>
> - merge your series! :)
>
> - integrate the texi doc somehow (apparently Paolo had some solution),
> or convert the texi doc to rst (modiy texi2any to do that?)
>
> - have the docs hosted on www.qemu.org, with some stability (ideally,
> we could share links to a specific doc, say a QMP command or an
> internal API, that would remain stable).
>
>   I wonder why Daniel qemu-web patches aren't yet merged. I remember
> some questions regarding doc import and automation. There will be a
> similar problem with sphinx doc.
>
>   (gitlab makes this fairly easy with CI artifcats, fwiw ;-)
>
> - convert more of our doc to rst
>
> - add kerneldoc
>
> - improve the style, for consistency with qemu.org style

Thanks for the suggestions.

-- PMM

Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by Paolo Bonzini 5 years, 1 month ago
On 14/02/19 16:24, Peter Maydell wrote:
> It does check, but I forgot to make the makefiles pay attention
> to the check.
> 
> That's very irritating that Fedora is using a weird filename for
> the tool -- what is their justification for doing that?
> I suppose we'll have to make configure cope :-(

They do have sphinx-build but it uses Python 2.  If you only install the
Python 3 version, you get sphinx-build-3.

I think it will be switched in Fedora 30, but I'm not sure.

Paolo

Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by Peter Maydell 5 years, 1 month ago
On Thu, 14 Feb 2019 at 18:46, Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> On 14/02/19 16:24, Peter Maydell wrote:
> > It does check, but I forgot to make the makefiles pay attention
> > to the check.
> >
> > That's very irritating that Fedora is using a weird filename for
> > the tool -- what is their justification for doing that?
> > I suppose we'll have to make configure cope :-(
>
> They do have sphinx-build but it uses Python 2.  If you only install the
> Python 3 version, you get sphinx-build-3

OK, so we could just make configure require "sphinx-build"
and fall back to "no docs if you don't have the tool";
that's not so bad.

thanks
-- PMM

Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series failed the docker-mingw@fedora build test. Please find the testing commands and
their output below. If you have Docker installed, you can probably reproduce it
locally.

=== TEST SCRIPT BEGIN ===
#!/bin/bash
time make docker-test-mingw@fedora SHOW_ENV=1 J=14
=== TEST SCRIPT END ===


Configure options:
--enable-werror --target-list=x86_64-softmmu,aarch64-softmmu --prefix=/tmp/qemu-test/install --python=/usr/bin/python3 --cross-prefix=x86_64-w64-mingw32- --enable-trace-backends=simple --enable-gnutls --enable-nettle --enable-curl --enable-vnc --enable-bzip2 --enable-guest-agent --with-sdlabi=2.0
ERROR: unknown option --with-sdlabi=2.0
Try '/tmp/qemu-test/src/configure --help' for more information
# QEMU configure log Sun Feb  3 15:14:45 UTC 2019
# Configured with: '/tmp/qemu-test/src/configure' '--enable-werror' '--target-list=x86_64-softmmu,aarch64-softmmu' '--prefix=/tmp/qemu-test/install' '--python=/usr/bin/python3' '--cross-prefix=x86_64-w64-mingw32-' '--enable-trace-backends=simple' '--enable-gnutls' '--enable-nettle' '--enable-curl' '--enable-vnc' '--enable-bzip2' '--enable-guest-agent' '--with-sdlabi=2.0'
---
funcs: do_compiler do_cc compile_object check_define main
lines: 92 122 617 634 0
x86_64-w64-mingw32-gcc -D_GNU_SOURCE -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE -Wstrict-prototypes -Wredundant-decls -Wall -Wundef -Wwrite-strings -Wmissing-prototypes -fno-strict-aliasing -fno-common -fwrapv -std=gnu99 -c -o config-temp/qemu-conf.o config-temp/qemu-conf.c
config-temp/qemu-conf.c:2:2: error: #error __linux__ not defined
 #error __linux__ not defined
  ^~~~~

---
funcs: do_compiler do_cc compile_object check_define main
lines: 92 122 617 686 0
x86_64-w64-mingw32-gcc -D_GNU_SOURCE -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE -Wstrict-prototypes -Wredundant-decls -Wall -Wundef -Wwrite-strings -Wmissing-prototypes -fno-strict-aliasing -fno-common -fwrapv -std=gnu99 -c -o config-temp/qemu-conf.o config-temp/qemu-conf.c
config-temp/qemu-conf.c:2:2: error: #error __i386__ not defined
 #error __i386__ not defined
  ^~~~~

---
funcs: do_compiler do_cc compile_object check_define main
lines: 92 122 617 689 0
x86_64-w64-mingw32-gcc -D_GNU_SOURCE -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE -Wstrict-prototypes -Wredundant-decls -Wall -Wundef -Wwrite-strings -Wmissing-prototypes -fno-strict-aliasing -fno-common -fwrapv -std=gnu99 -c -o config-temp/qemu-conf.o config-temp/qemu-conf.c
config-temp/qemu-conf.c:2:2: error: #error __ILP32__ not defined
 #error __ILP32__ not defined
  ^~~~~

---
lines: 92 128 920 0
x86_64-w64-mingw32-gcc -mthreads -D_GNU_SOURCE -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE -Wstrict-prototypes -Wredundant-decls -Wall -Wundef -Wwrite-strings -Wmissing-prototypes -fno-strict-aliasing -fno-common -fwrapv -std=gnu99 -o config-temp/qemu-conf.exe config-temp/qemu-conf.c -g -liberty
/usr/lib/gcc/x86_64-w64-mingw32/8.2.0/../../../../x86_64-w64-mingw32/bin/ld: cannot find -liberty
collect2: error: ld returned 1 exit status
Failed to run 'configure'
Traceback (most recent call last):
  File "./tests/docker/docker.py", line 563, in <module>


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.docker-mingw@fedora/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Type: series
Message-id: 20190201145035.22739-1-peter.maydell@linaro.org
Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
 - [tag update]      patchew/20190201145035.22739-1-peter.maydell@linaro.org -> patchew/20190201145035.22739-1-peter.maydell@linaro.org
Switched to a new branch 'test'
429e245 docs/conf.py: Don't hard-code QEMU version
d1d73e3 Makefile: Abstract out "identify the pkgversion" code
999c09b Makefile, configure: Support building rST documentation
34bd2da Separate conf.py for each manual we want
9a6c5a4 docs/conf.py: Disable option warnings
c466233 docs/conf.py: Don't include rST sources in HTML build
0af2097 docs/conf.py: Configure the 'alabaster' theme
dd1b449 docs/conf.py: Disable unused _static directory
76f4d9d docs: Commit initial files from sphinx-quickstart
191561b docs: Convert memory.txt to rst format
f72de6c docs/cpu-hotplug.rst: Fix rST markup issues

=== OUTPUT BEGIN ===
1/11 Checking commit f72de6c70ee6 (docs/cpu-hotplug.rst: Fix rST markup issues)
2/11 Checking commit 191561bcbdc6 (docs: Convert memory.txt to rst format)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#22: 
rename from docs/devel/memory.txt

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/11 Checking commit 76f4d9d42833 (docs: Commit initial files from sphinx-quickstart)
ERROR: Missing Signed-off-by: line(s)

total: 1 errors, 0 warnings, 188 lines checked

Patch 3/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

4/11 Checking commit dd1b44918905 (docs/conf.py: Disable unused _static directory)
5/11 Checking commit 0af20971b269 (docs/conf.py: Configure the 'alabaster' theme)
6/11 Checking commit c46623391238 (docs/conf.py: Don't include rST sources in HTML build)
7/11 Checking commit 9a6c5a4a34fd (docs/conf.py: Disable option warnings)
8/11 Checking commit 34bd2dab5fb9 (Separate conf.py for each manual we want)
ERROR: line over 90 characters
#161: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

ERROR: Missing Signed-off-by: line(s)

total: 2 errors, 0 warnings, 133 lines checked

Patch 8/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

9/11 Checking commit 999c09b2bb2b (Makefile, configure: Support building rST documentation)
10/11 Checking commit d1d73e341bf5 (Makefile: Abstract out "identify the pkgversion" code)
11/11 Checking commit 429e245a7c5f (docs/conf.py: Don't hard-code QEMU version)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Message-id: 20190201145035.22739-1-peter.maydell@linaro.org
Type: series

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
 - [tag update]      patchew/20190201145035.22739-1-peter.maydell@linaro.org -> patchew/20190201145035.22739-1-peter.maydell@linaro.org
Submodule 'capstone' (https://git.qemu.org/git/capstone.git) registered for path 'capstone'
Submodule 'dtc' (https://git.qemu.org/git/dtc.git) registered for path 'dtc'
Submodule 'roms/QemuMacDrivers' (https://git.qemu.org/git/QemuMacDrivers.git) registered for path 'roms/QemuMacDrivers'
Submodule 'roms/SLOF' (https://git.qemu.org/git/SLOF.git) registered for path 'roms/SLOF'
Submodule 'roms/ipxe' (https://git.qemu.org/git/ipxe.git) registered for path 'roms/ipxe'
Submodule 'roms/openbios' (https://git.qemu.org/git/openbios.git) registered for path 'roms/openbios'
Submodule 'roms/openhackware' (https://git.qemu.org/git/openhackware.git) registered for path 'roms/openhackware'
Submodule 'roms/qemu-palcode' (https://git.qemu.org/git/qemu-palcode.git) registered for path 'roms/qemu-palcode'
Submodule 'roms/seabios' (https://git.qemu.org/git/seabios.git/) registered for path 'roms/seabios'
Submodule 'roms/seabios-hppa' (https://github.com/hdeller/seabios-hppa.git) registered for path 'roms/seabios-hppa'
Submodule 'roms/sgabios' (https://git.qemu.org/git/sgabios.git) registered for path 'roms/sgabios'
Submodule 'roms/skiboot' (https://git.qemu.org/git/skiboot.git) registered for path 'roms/skiboot'
Submodule 'roms/u-boot' (https://git.qemu.org/git/u-boot.git) registered for path 'roms/u-boot'
Submodule 'roms/u-boot-sam460ex' (https://git.qemu.org/git/u-boot-sam460ex.git) registered for path 'roms/u-boot-sam460ex'
Submodule 'tests/fp/berkeley-softfloat-3' (https://github.com/cota/berkeley-softfloat-3) registered for path 'tests/fp/berkeley-softfloat-3'
Submodule 'tests/fp/berkeley-testfloat-3' (https://github.com/cota/berkeley-testfloat-3) registered for path 'tests/fp/berkeley-testfloat-3'
Submodule 'ui/keycodemapdb' (https://git.qemu.org/git/keycodemapdb.git) registered for path 'ui/keycodemapdb'
Cloning into 'capstone'...
Submodule path 'capstone': checked out '22ead3e0bfdb87516656453336160e0a37b066bf'
Cloning into 'dtc'...
Submodule path 'dtc': checked out '88f18909db731a627456f26d779445f84e449536'
Cloning into 'roms/QemuMacDrivers'...
Submodule path 'roms/QemuMacDrivers': checked out 'd4e7d7ac663fcb55f1b93575445fcbca372f17a7'
Cloning into 'roms/SLOF'...
Submodule path 'roms/SLOF': checked out '9b7ab2fa020341dee8bf9df6c9cf40003e0136df'
Cloning into 'roms/ipxe'...
Submodule path 'roms/ipxe': checked out 'de4565cbe76ea9f7913a01f331be3ee901bb6e17'
Cloning into 'roms/openbios'...
Submodule path 'roms/openbios': checked out '441a84d3a642a10b948369c63f32367e8ff6395b'
Cloning into 'roms/openhackware'...
Submodule path 'roms/openhackware': checked out 'c559da7c8eec5e45ef1f67978827af6f0b9546f5'
Cloning into 'roms/qemu-palcode'...
Submodule path 'roms/qemu-palcode': checked out '51c237d7e20d05100eacadee2f61abc17e6bc097'
Cloning into 'roms/seabios'...
Submodule path 'roms/seabios': checked out 'a698c8995ffb2838296ec284fe3c4ad33dfca307'
Cloning into 'roms/seabios-hppa'...
Submodule path 'roms/seabios-hppa': checked out '1ef99a01572c2581c30e16e6fe69e9ea2ef92ce0'
Cloning into 'roms/sgabios'...
Submodule path 'roms/sgabios': checked out 'cbaee52287e5f32373181cff50a00b6c4ac9015a'
Cloning into 'roms/skiboot'...
Submodule path 'roms/skiboot': checked out 'e0ee24c27a172bcf482f6f2bc905e6211c134bcc'
Cloning into 'roms/u-boot'...
Submodule path 'roms/u-boot': checked out 'd85ca029f257b53a96da6c2fb421e78a003a9943'
Cloning into 'roms/u-boot-sam460ex'...
Submodule path 'roms/u-boot-sam460ex': checked out '60b3916f33e617a815973c5a6df77055b2e3a588'
Cloning into 'tests/fp/berkeley-softfloat-3'...
Submodule path 'tests/fp/berkeley-softfloat-3': checked out 'b64af41c3276f97f0e181920400ee056b9c88037'
Cloning into 'tests/fp/berkeley-testfloat-3'...
Submodule path 'tests/fp/berkeley-testfloat-3': checked out '5a59dcec19327396a011a17fd924aed4fec416b3'
Cloning into 'ui/keycodemapdb'...
Submodule path 'ui/keycodemapdb': checked out '6b3d716e2b6472eb7189d3220552280ef3d832ce'
Switched to a new branch 'test'
ea679f0 docs/conf.py: Don't hard-code QEMU version
9c6cbba Makefile: Abstract out "identify the pkgversion" code
526f971 Makefile, configure: Support building rST documentation
665a9ff Separate conf.py for each manual we want
4a0ad16 docs/conf.py: Disable option warnings
daffe99 docs/conf.py: Don't include rST sources in HTML build
7f2b1c3 docs/conf.py: Configure the 'alabaster' theme
0edad2d docs/conf.py: Disable unused _static directory
d698375 docs: Commit initial files from sphinx-quickstart
bca5202 docs: Convert memory.txt to rst format
0e9ffb1 docs/cpu-hotplug.rst: Fix rST markup issues

=== OUTPUT BEGIN ===
1/11 Checking commit 0e9ffb13dbaa (docs/cpu-hotplug.rst: Fix rST markup issues)
2/11 Checking commit bca5202bddee (docs: Convert memory.txt to rst format)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#22: 
rename from docs/devel/memory.txt

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/11 Checking commit d698375a4c62 (docs: Commit initial files from sphinx-quickstart)
ERROR: Missing Signed-off-by: line(s)

total: 1 errors, 0 warnings, 188 lines checked

Patch 3/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

4/11 Checking commit 0edad2daa354 (docs/conf.py: Disable unused _static directory)
5/11 Checking commit 7f2b1c387830 (docs/conf.py: Configure the 'alabaster' theme)
6/11 Checking commit daffe99f6be5 (docs/conf.py: Don't include rST sources in HTML build)
7/11 Checking commit 4a0ad1654af4 (docs/conf.py: Disable option warnings)
8/11 Checking commit 665a9ff14735 (Separate conf.py for each manual we want)
ERROR: line over 90 characters
#161: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

ERROR: Missing Signed-off-by: line(s)

total: 2 errors, 0 warnings, 133 lines checked

Patch 8/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

9/11 Checking commit 526f97104aac (Makefile, configure: Support building rST documentation)
10/11 Checking commit 9c6cbba2e17b (Makefile: Abstract out "identify the pkgversion" code)
11/11 Checking commit ea679f0a91a6 (docs/conf.py: Don't hard-code QEMU version)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Type: series
Message-id: 20190201145035.22739-1-peter.maydell@linaro.org
Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
 - [tag update]      patchew/20190201145035.22739-1-peter.maydell@linaro.org -> patchew/20190201145035.22739-1-peter.maydell@linaro.org
Switched to a new branch 'test'
ea679f0 docs/conf.py: Don't hard-code QEMU version
9c6cbba Makefile: Abstract out "identify the pkgversion" code
526f971 Makefile, configure: Support building rST documentation
665a9ff Separate conf.py for each manual we want
4a0ad16 docs/conf.py: Disable option warnings
daffe99 docs/conf.py: Don't include rST sources in HTML build
7f2b1c3 docs/conf.py: Configure the 'alabaster' theme
0edad2d docs/conf.py: Disable unused _static directory
d698375 docs: Commit initial files from sphinx-quickstart
bca5202 docs: Convert memory.txt to rst format
0e9ffb1 docs/cpu-hotplug.rst: Fix rST markup issues

=== OUTPUT BEGIN ===
1/11 Checking commit 0e9ffb13dbaa (docs/cpu-hotplug.rst: Fix rST markup issues)
2/11 Checking commit bca5202bddee (docs: Convert memory.txt to rst format)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#22: 
rename from docs/devel/memory.txt

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/11 Checking commit d698375a4c62 (docs: Commit initial files from sphinx-quickstart)
ERROR: Missing Signed-off-by: line(s)

total: 1 errors, 0 warnings, 188 lines checked

Patch 3/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

4/11 Checking commit 0edad2daa354 (docs/conf.py: Disable unused _static directory)
5/11 Checking commit 7f2b1c387830 (docs/conf.py: Configure the 'alabaster' theme)
6/11 Checking commit daffe99f6be5 (docs/conf.py: Don't include rST sources in HTML build)
7/11 Checking commit 4a0ad1654af4 (docs/conf.py: Disable option warnings)
8/11 Checking commit 665a9ff14735 (Separate conf.py for each manual we want)
ERROR: line over 90 characters
#161: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

ERROR: Missing Signed-off-by: line(s)

total: 2 errors, 0 warnings, 133 lines checked

Patch 8/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

9/11 Checking commit 526f97104aac (Makefile, configure: Support building rST documentation)
10/11 Checking commit 9c6cbba2e17b (Makefile: Abstract out "identify the pkgversion" code)
11/11 Checking commit ea679f0a91a6 (docs/conf.py: Don't hard-code QEMU version)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Type: series
Message-id: 20190201145035.22739-1-peter.maydell@linaro.org

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
 t [tag update]            patchew/20190201145035.22739-1-peter.maydell@linaro.org -> patchew/20190201145035.22739-1-peter.maydell@linaro.org
Switched to a new branch 'test'
aed193d221 docs/conf.py: Don't hard-code QEMU version
40d4015362 Makefile: Abstract out "identify the pkgversion" code
728e072ddf Makefile, configure: Support building rST documentation
faf59c0dcd Separate conf.py for each manual we want
52b3db4b96 docs/conf.py: Disable option warnings
9f35db088a docs/conf.py: Don't include rST sources in HTML build
baf81fd590 docs/conf.py: Configure the 'alabaster' theme
1dc23cbf0f docs/conf.py: Disable unused _static directory
0adbe3fb61 docs: Commit initial files from sphinx-quickstart
6396cd9ed3 docs: Convert memory.txt to rst format
2aa8287d54 docs/cpu-hotplug.rst: Fix rST markup issues

=== OUTPUT BEGIN ===
1/11 Checking commit 2aa8287d54ab (docs/cpu-hotplug.rst: Fix rST markup issues)
2/11 Checking commit 6396cd9ed34f (docs: Convert memory.txt to rst format)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#22: 
rename from docs/devel/memory.txt

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/11 Checking commit 0adbe3fb6111 (docs: Commit initial files from sphinx-quickstart)
ERROR: Missing Signed-off-by: line(s)

total: 1 errors, 0 warnings, 188 lines checked

Patch 3/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

4/11 Checking commit 1dc23cbf0fc2 (docs/conf.py: Disable unused _static directory)
5/11 Checking commit baf81fd590b5 (docs/conf.py: Configure the 'alabaster' theme)
6/11 Checking commit 9f35db088a8f (docs/conf.py: Don't include rST sources in HTML build)
7/11 Checking commit 52b3db4b9683 (docs/conf.py: Disable option warnings)
8/11 Checking commit faf59c0dcdfc (Separate conf.py for each manual we want)
ERROR: line over 90 characters
#160: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

ERROR: Missing Signed-off-by: line(s)

total: 2 errors, 0 warnings, 133 lines checked

Patch 8/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

9/11 Checking commit 728e072ddf36 (Makefile, configure: Support building rST documentation)
10/11 Checking commit 40d401536240 (Makefile: Abstract out "identify the pkgversion" code)
11/11 Checking commit aed193d22116 (docs/conf.py: Don't hard-code QEMU version)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Type: series
Message-id: 20190201145035.22739-1-peter.maydell@linaro.org

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
Switched to a new branch 'test'
b696ee8efa docs/conf.py: Don't hard-code QEMU version
24606d9e76 Makefile: Abstract out "identify the pkgversion" code
ef460d14bb Makefile, configure: Support building rST documentation
eecbbbcc67 Separate conf.py for each manual we want
b6ddfd9964 docs/conf.py: Disable option warnings
b6174039e6 docs/conf.py: Don't include rST sources in HTML build
e8bff0e834 docs/conf.py: Configure the 'alabaster' theme
68de0536e9 docs/conf.py: Disable unused _static directory
93b5d1dbd8 docs: Commit initial files from sphinx-quickstart
73ad63cf3d docs: Convert memory.txt to rst format
cf0a8364f6 docs/cpu-hotplug.rst: Fix rST markup issues

=== OUTPUT BEGIN ===
1/11 Checking commit cf0a8364f6ea (docs/cpu-hotplug.rst: Fix rST markup issues)
2/11 Checking commit 73ad63cf3d96 (docs: Convert memory.txt to rst format)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#22: 
rename from docs/devel/memory.txt

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/11 Checking commit 93b5d1dbd85f (docs: Commit initial files from sphinx-quickstart)
ERROR: Missing Signed-off-by: line(s)

total: 1 errors, 0 warnings, 188 lines checked

Patch 3/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

4/11 Checking commit 68de0536e9c7 (docs/conf.py: Disable unused _static directory)
5/11 Checking commit e8bff0e834ec (docs/conf.py: Configure the 'alabaster' theme)
6/11 Checking commit b6174039e688 (docs/conf.py: Don't include rST sources in HTML build)
7/11 Checking commit b6ddfd9964ab (docs/conf.py: Disable option warnings)
8/11 Checking commit eecbbbcc6737 (Separate conf.py for each manual we want)
ERROR: line over 90 characters
#160: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

ERROR: Missing Signed-off-by: line(s)

total: 2 errors, 0 warnings, 133 lines checked

Patch 8/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

9/11 Checking commit ef460d14bb09 (Makefile, configure: Support building rST documentation)
10/11 Checking commit 24606d9e76ca (Makefile: Abstract out "identify the pkgversion" code)
11/11 Checking commit b696ee8efa34 (docs/conf.py: Don't hard-code QEMU version)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Type: series
Message-id: 20190201145035.22739-1-peter.maydell@linaro.org
Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
 - [tag update]      patchew/20190201145035.22739-1-peter.maydell@linaro.org -> patchew/20190201145035.22739-1-peter.maydell@linaro.org
Switched to a new branch 'test'
b01607c docs/conf.py: Don't hard-code QEMU version
d2709f5 Makefile: Abstract out "identify the pkgversion" code
495f73c Makefile, configure: Support building rST documentation
6e97894 Separate conf.py for each manual we want
e44ad7e docs/conf.py: Disable option warnings
fadd9f4 docs/conf.py: Don't include rST sources in HTML build
6e438de docs/conf.py: Configure the 'alabaster' theme
e208e08 docs/conf.py: Disable unused _static directory
abaf4de docs: Commit initial files from sphinx-quickstart
fba4ad9 docs: Convert memory.txt to rst format
eb6998f docs/cpu-hotplug.rst: Fix rST markup issues

=== OUTPUT BEGIN ===
1/11 Checking commit eb6998fbf3b5 (docs/cpu-hotplug.rst: Fix rST markup issues)
2/11 Checking commit fba4ad903b15 (docs: Convert memory.txt to rst format)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#22: 
rename from docs/devel/memory.txt

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/11 Checking commit abaf4deb75a9 (docs: Commit initial files from sphinx-quickstart)
ERROR: Missing Signed-off-by: line(s)

total: 1 errors, 0 warnings, 188 lines checked

Patch 3/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

4/11 Checking commit e208e0896ff1 (docs/conf.py: Disable unused _static directory)
5/11 Checking commit 6e438de47811 (docs/conf.py: Configure the 'alabaster' theme)
6/11 Checking commit fadd9f417dc4 (docs/conf.py: Don't include rST sources in HTML build)
7/11 Checking commit e44ad7e07445 (docs/conf.py: Disable option warnings)
8/11 Checking commit 6e97894f5831 (Separate conf.py for each manual we want)
ERROR: line over 90 characters
#160: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

ERROR: Missing Signed-off-by: line(s)

total: 2 errors, 0 warnings, 133 lines checked

Patch 8/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

9/11 Checking commit 495f73c795c2 (Makefile, configure: Support building rST documentation)
10/11 Checking commit d2709f595efd (Makefile: Abstract out "identify the pkgversion" code)
11/11 Checking commit b01607c6e1d9 (docs/conf.py: Don't hard-code QEMU version)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Type: series
Message-id: 20190201145035.22739-1-peter.maydell@linaro.org

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
 * [new tag]               patchew/20190201145035.22739-1-peter.maydell@linaro.org -> patchew/20190201145035.22739-1-peter.maydell@linaro.org
Switched to a new branch 'test'
fdcde82e94 docs/conf.py: Don't hard-code QEMU version
95ff495343 Makefile: Abstract out "identify the pkgversion" code
ea4e36f66f Makefile, configure: Support building rST documentation
20761006f1 Separate conf.py for each manual we want
ab8cacd266 docs/conf.py: Disable option warnings
a58591c443 docs/conf.py: Don't include rST sources in HTML build
a5e1fff319 docs/conf.py: Configure the 'alabaster' theme
b9917d0a1b docs/conf.py: Disable unused _static directory
fd769099b3 docs: Commit initial files from sphinx-quickstart
9888afe4ce docs: Convert memory.txt to rst format
7c59983957 docs/cpu-hotplug.rst: Fix rST markup issues

=== OUTPUT BEGIN ===
1/11 Checking commit 7c59983957ec (docs/cpu-hotplug.rst: Fix rST markup issues)
2/11 Checking commit 9888afe4cedd (docs: Convert memory.txt to rst format)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#21: 
rename from docs/devel/memory.txt

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/11 Checking commit fd769099b38b (docs: Commit initial files from sphinx-quickstart)
ERROR: Missing Signed-off-by: line(s)

total: 1 errors, 0 warnings, 188 lines checked

Patch 3/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

4/11 Checking commit b9917d0a1bce (docs/conf.py: Disable unused _static directory)
5/11 Checking commit a5e1fff319a6 (docs/conf.py: Configure the 'alabaster' theme)
6/11 Checking commit a58591c44317 (docs/conf.py: Don't include rST sources in HTML build)
7/11 Checking commit ab8cacd26625 (docs/conf.py: Disable option warnings)
8/11 Checking commit 20761006f1ff (Separate conf.py for each manual we want)
ERROR: line over 90 characters
#160: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

ERROR: Missing Signed-off-by: line(s)

total: 2 errors, 0 warnings, 133 lines checked

Patch 8/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

9/11 Checking commit ea4e36f66f9b (Makefile, configure: Support building rST documentation)
10/11 Checking commit 95ff495343ba (Makefile: Abstract out "identify the pkgversion" code)
11/11 Checking commit fdcde82e9438 (docs/conf.py: Don't hard-code QEMU version)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by Peter Maydell 5 years, 1 month ago
On Fri, 1 Feb 2019 at 15:06, <no-reply@patchew.org> wrote:
>
> Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/
>
>
>
> Hi,
>
> This series seems to have some coding style problems. See output below for
> more information:
>
> Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
> Type: series
> Message-id: 20190201145035.22739-1-peter.maydell@linaro.org

Hi Fam -- do you know why Patchew has sent a dozen emails for the
checkpatch issues in this patch series? It seems a bit excessive
when one would suffice...

thanks
-- PMM

Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Message-id: 20190201145035.22739-1-peter.maydell@linaro.org
Type: series

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
 * [new tag]         patchew/20190201145035.22739-1-peter.maydell@linaro.org -> patchew/20190201145035.22739-1-peter.maydell@linaro.org
Submodule 'capstone' (https://git.qemu.org/git/capstone.git) registered for path 'capstone'
Submodule 'dtc' (https://git.qemu.org/git/dtc.git) registered for path 'dtc'
Submodule 'roms/QemuMacDrivers' (https://git.qemu.org/git/QemuMacDrivers.git) registered for path 'roms/QemuMacDrivers'
Submodule 'roms/SLOF' (https://git.qemu.org/git/SLOF.git) registered for path 'roms/SLOF'
Submodule 'roms/ipxe' (https://git.qemu.org/git/ipxe.git) registered for path 'roms/ipxe'
Submodule 'roms/openbios' (https://git.qemu.org/git/openbios.git) registered for path 'roms/openbios'
Submodule 'roms/openhackware' (https://git.qemu.org/git/openhackware.git) registered for path 'roms/openhackware'
Submodule 'roms/qemu-palcode' (https://git.qemu.org/git/qemu-palcode.git) registered for path 'roms/qemu-palcode'
Submodule 'roms/seabios' (https://git.qemu.org/git/seabios.git/) registered for path 'roms/seabios'
Submodule 'roms/seabios-hppa' (https://github.com/hdeller/seabios-hppa.git) registered for path 'roms/seabios-hppa'
Submodule 'roms/sgabios' (https://git.qemu.org/git/sgabios.git) registered for path 'roms/sgabios'
Submodule 'roms/skiboot' (https://git.qemu.org/git/skiboot.git) registered for path 'roms/skiboot'
Submodule 'roms/u-boot' (https://git.qemu.org/git/u-boot.git) registered for path 'roms/u-boot'
Submodule 'roms/u-boot-sam460ex' (https://git.qemu.org/git/u-boot-sam460ex.git) registered for path 'roms/u-boot-sam460ex'
Submodule 'tests/fp/berkeley-softfloat-3' (https://github.com/cota/berkeley-softfloat-3) registered for path 'tests/fp/berkeley-softfloat-3'
Submodule 'tests/fp/berkeley-testfloat-3' (https://github.com/cota/berkeley-testfloat-3) registered for path 'tests/fp/berkeley-testfloat-3'
Submodule 'ui/keycodemapdb' (https://git.qemu.org/git/keycodemapdb.git) registered for path 'ui/keycodemapdb'
Cloning into 'capstone'...
Submodule path 'capstone': checked out '22ead3e0bfdb87516656453336160e0a37b066bf'
Cloning into 'dtc'...
Submodule path 'dtc': checked out '88f18909db731a627456f26d779445f84e449536'
Cloning into 'roms/QemuMacDrivers'...
Submodule path 'roms/QemuMacDrivers': checked out 'd4e7d7ac663fcb55f1b93575445fcbca372f17a7'
Cloning into 'roms/SLOF'...
Submodule path 'roms/SLOF': checked out '9b7ab2fa020341dee8bf9df6c9cf40003e0136df'
Cloning into 'roms/ipxe'...
Submodule path 'roms/ipxe': checked out 'de4565cbe76ea9f7913a01f331be3ee901bb6e17'
Cloning into 'roms/openbios'...
Submodule path 'roms/openbios': checked out '441a84d3a642a10b948369c63f32367e8ff6395b'
Cloning into 'roms/openhackware'...
Submodule path 'roms/openhackware': checked out 'c559da7c8eec5e45ef1f67978827af6f0b9546f5'
Cloning into 'roms/qemu-palcode'...
Submodule path 'roms/qemu-palcode': checked out '51c237d7e20d05100eacadee2f61abc17e6bc097'
Cloning into 'roms/seabios'...
Submodule path 'roms/seabios': checked out 'a698c8995ffb2838296ec284fe3c4ad33dfca307'
Cloning into 'roms/seabios-hppa'...
Submodule path 'roms/seabios-hppa': checked out '1ef99a01572c2581c30e16e6fe69e9ea2ef92ce0'
Cloning into 'roms/sgabios'...
Submodule path 'roms/sgabios': checked out 'cbaee52287e5f32373181cff50a00b6c4ac9015a'
Cloning into 'roms/skiboot'...
Submodule path 'roms/skiboot': checked out 'e0ee24c27a172bcf482f6f2bc905e6211c134bcc'
Cloning into 'roms/u-boot'...
Submodule path 'roms/u-boot': checked out 'd85ca029f257b53a96da6c2fb421e78a003a9943'
Cloning into 'roms/u-boot-sam460ex'...
Submodule path 'roms/u-boot-sam460ex': checked out '60b3916f33e617a815973c5a6df77055b2e3a588'
Cloning into 'tests/fp/berkeley-softfloat-3'...
Submodule path 'tests/fp/berkeley-softfloat-3': checked out 'b64af41c3276f97f0e181920400ee056b9c88037'
Cloning into 'tests/fp/berkeley-testfloat-3'...
Submodule path 'tests/fp/berkeley-testfloat-3': checked out '5a59dcec19327396a011a17fd924aed4fec416b3'
Cloning into 'ui/keycodemapdb'...
Submodule path 'ui/keycodemapdb': checked out '6b3d716e2b6472eb7189d3220552280ef3d832ce'
Switched to a new branch 'test'
fdcde82 docs/conf.py: Don't hard-code QEMU version
95ff495 Makefile: Abstract out "identify the pkgversion" code
ea4e36f Makefile, configure: Support building rST documentation
2076100 Separate conf.py for each manual we want
ab8cacd docs/conf.py: Disable option warnings
a58591c docs/conf.py: Don't include rST sources in HTML build
a5e1fff docs/conf.py: Configure the 'alabaster' theme
b9917d0 docs/conf.py: Disable unused _static directory
fd76909 docs: Commit initial files from sphinx-quickstart
9888afe docs: Convert memory.txt to rst format
7c59983 docs/cpu-hotplug.rst: Fix rST markup issues

=== OUTPUT BEGIN ===
1/11 Checking commit 7c59983957ec (docs/cpu-hotplug.rst: Fix rST markup issues)
2/11 Checking commit 9888afe4cedd (docs: Convert memory.txt to rst format)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#21: 
rename from docs/devel/memory.txt

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/11 Checking commit fd769099b38b (docs: Commit initial files from sphinx-quickstart)
ERROR: Missing Signed-off-by: line(s)

total: 1 errors, 0 warnings, 188 lines checked

Patch 3/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

4/11 Checking commit b9917d0a1bce (docs/conf.py: Disable unused _static directory)
5/11 Checking commit a5e1fff319a6 (docs/conf.py: Configure the 'alabaster' theme)
6/11 Checking commit a58591c44317 (docs/conf.py: Don't include rST sources in HTML build)
7/11 Checking commit ab8cacd26625 (docs/conf.py: Disable option warnings)
8/11 Checking commit 20761006f1ff (Separate conf.py for each manual we want)
ERROR: line over 90 characters
#160: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

ERROR: Missing Signed-off-by: line(s)

total: 2 errors, 0 warnings, 133 lines checked

Patch 8/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

9/11 Checking commit ea4e36f66f9b (Makefile, configure: Support building rST documentation)
10/11 Checking commit 95ff495343ba (Makefile: Abstract out "identify the pkgversion" code)
11/11 Checking commit fdcde82e9438 (docs/conf.py: Don't hard-code QEMU version)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Type: series
Message-id: 20190201145035.22739-1-peter.maydell@linaro.org
Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
   cfe6c54..a1bc3e7  master     -> master
 - [tag update]      patchew/20190201124543.5945-1-cohuck@redhat.com -> patchew/20190201124543.5945-1-cohuck@redhat.com
 - [tag update]      patchew/20190201145035.22739-1-peter.maydell@linaro.org -> patchew/20190201145035.22739-1-peter.maydell@linaro.org
 * [new tag]         patchew/20190201160653.13829-1-peter.maydell@linaro.org -> patchew/20190201160653.13829-1-peter.maydell@linaro.org
Switched to a new branch 'test'
566e309 docs/conf.py: Don't hard-code QEMU version
09887df Makefile: Abstract out "identify the pkgversion" code
cfc53bc Makefile, configure: Support building rST documentation
8dd4464 Separate conf.py for each manual we want
a08fc31 docs/conf.py: Disable option warnings
2d22b98 docs/conf.py: Don't include rST sources in HTML build
0e0c1c2 docs/conf.py: Configure the 'alabaster' theme
fa1935b docs/conf.py: Disable unused _static directory
a384f83 docs: Commit initial files from sphinx-quickstart
9d2a8ce docs: Convert memory.txt to rst format
858573e docs/cpu-hotplug.rst: Fix rST markup issues

=== OUTPUT BEGIN ===
1/11 Checking commit 858573e43e10 (docs/cpu-hotplug.rst: Fix rST markup issues)
2/11 Checking commit 9d2a8ce2ea3c (docs: Convert memory.txt to rst format)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#22: 
rename from docs/devel/memory.txt

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/11 Checking commit a384f83c875c (docs: Commit initial files from sphinx-quickstart)
ERROR: Missing Signed-off-by: line(s)

total: 1 errors, 0 warnings, 188 lines checked

Patch 3/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

4/11 Checking commit fa1935bfae6c (docs/conf.py: Disable unused _static directory)
5/11 Checking commit 0e0c1c2bdb53 (docs/conf.py: Configure the 'alabaster' theme)
6/11 Checking commit 2d22b981a12b (docs/conf.py: Don't include rST sources in HTML build)
7/11 Checking commit a08fc31392c9 (docs/conf.py: Disable option warnings)
8/11 Checking commit 8dd44649383f (Separate conf.py for each manual we want)
ERROR: line over 90 characters
#160: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

ERROR: Missing Signed-off-by: line(s)

total: 2 errors, 0 warnings, 133 lines checked

Patch 8/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

9/11 Checking commit cfc53bc5d2d1 (Makefile, configure: Support building rST documentation)
10/11 Checking commit 09887dfd22f9 (Makefile: Abstract out "identify the pkgversion" code)
11/11 Checking commit 566e309a211a (docs/conf.py: Don't hard-code QEMU version)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Type: series
Message-id: 20190201145035.22739-1-peter.maydell@linaro.org

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
 t [tag update]            patchew/20190201145035.22739-1-peter.maydell@linaro.org -> patchew/20190201145035.22739-1-peter.maydell@linaro.org
Switched to a new branch 'test'
50a0f0d5ce docs/conf.py: Don't hard-code QEMU version
7b5fa8d953 Makefile: Abstract out "identify the pkgversion" code
e9566ecba8 Makefile, configure: Support building rST documentation
08de86173b Separate conf.py for each manual we want
42806c50e2 docs/conf.py: Disable option warnings
e50a106d7d docs/conf.py: Don't include rST sources in HTML build
2e1a65022b docs/conf.py: Configure the 'alabaster' theme
14b7b18b70 docs/conf.py: Disable unused _static directory
d991b4506b docs: Commit initial files from sphinx-quickstart
4f429cddf4 docs: Convert memory.txt to rst format
56f8e4a6c7 docs/cpu-hotplug.rst: Fix rST markup issues

=== OUTPUT BEGIN ===
1/11 Checking commit 56f8e4a6c708 (docs/cpu-hotplug.rst: Fix rST markup issues)
2/11 Checking commit 4f429cddf421 (docs: Convert memory.txt to rst format)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#22: 
rename from docs/devel/memory.txt

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/11 Checking commit d991b4506b86 (docs: Commit initial files from sphinx-quickstart)
ERROR: Missing Signed-off-by: line(s)

total: 1 errors, 0 warnings, 188 lines checked

Patch 3/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

4/11 Checking commit 14b7b18b70c3 (docs/conf.py: Disable unused _static directory)
5/11 Checking commit 2e1a65022bc1 (docs/conf.py: Configure the 'alabaster' theme)
6/11 Checking commit e50a106d7dc5 (docs/conf.py: Don't include rST sources in HTML build)
7/11 Checking commit 42806c50e248 (docs/conf.py: Disable option warnings)
8/11 Checking commit 08de86173b2e (Separate conf.py for each manual we want)
ERROR: line over 90 characters
#160: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

ERROR: Missing Signed-off-by: line(s)

total: 2 errors, 0 warnings, 133 lines checked

Patch 8/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

9/11 Checking commit e9566ecba8ed (Makefile, configure: Support building rST documentation)
10/11 Checking commit 7b5fa8d95384 (Makefile: Abstract out "identify the pkgversion" code)
11/11 Checking commit 50a0f0d5ce2d (docs/conf.py: Don't hard-code QEMU version)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Type: series
Message-id: 20190201145035.22739-1-peter.maydell@linaro.org
Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
 - [tag update]      patchew/20190201145035.22739-1-peter.maydell@linaro.org -> patchew/20190201145035.22739-1-peter.maydell@linaro.org
Switched to a new branch 'test'
50a0f0d docs/conf.py: Don't hard-code QEMU version
7b5fa8d Makefile: Abstract out "identify the pkgversion" code
e9566ec Makefile, configure: Support building rST documentation
08de861 Separate conf.py for each manual we want
42806c5 docs/conf.py: Disable option warnings
e50a106 docs/conf.py: Don't include rST sources in HTML build
2e1a650 docs/conf.py: Configure the 'alabaster' theme
14b7b18 docs/conf.py: Disable unused _static directory
d991b45 docs: Commit initial files from sphinx-quickstart
4f429cd docs: Convert memory.txt to rst format
56f8e4a docs/cpu-hotplug.rst: Fix rST markup issues

=== OUTPUT BEGIN ===
1/11 Checking commit 56f8e4a6c708 (docs/cpu-hotplug.rst: Fix rST markup issues)
2/11 Checking commit 4f429cddf421 (docs: Convert memory.txt to rst format)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#22: 
rename from docs/devel/memory.txt

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/11 Checking commit d991b4506b86 (docs: Commit initial files from sphinx-quickstart)
ERROR: Missing Signed-off-by: line(s)

total: 1 errors, 0 warnings, 188 lines checked

Patch 3/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

4/11 Checking commit 14b7b18b70c3 (docs/conf.py: Disable unused _static directory)
5/11 Checking commit 2e1a65022bc1 (docs/conf.py: Configure the 'alabaster' theme)
6/11 Checking commit e50a106d7dc5 (docs/conf.py: Don't include rST sources in HTML build)
7/11 Checking commit 42806c50e248 (docs/conf.py: Disable option warnings)
8/11 Checking commit 08de86173b2e (Separate conf.py for each manual we want)
ERROR: line over 90 characters
#160: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

ERROR: Missing Signed-off-by: line(s)

total: 2 errors, 0 warnings, 133 lines checked

Patch 8/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

9/11 Checking commit e9566ecba8ed (Makefile, configure: Support building rST documentation)
10/11 Checking commit 7b5fa8d95384 (Makefile: Abstract out "identify the pkgversion" code)
11/11 Checking commit 50a0f0d5ce2d (docs/conf.py: Don't hard-code QEMU version)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
Re: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Posted by no-reply@patchew.org 5 years, 1 month ago
Patchew URL: https://patchew.org/QEMU/20190201145035.22739-1-peter.maydell@linaro.org/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Subject: [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs
Type: series
Message-id: 20190201145035.22739-1-peter.maydell@linaro.org

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
 t [tag update]            patchew/20190201145035.22739-1-peter.maydell@linaro.org -> patchew/20190201145035.22739-1-peter.maydell@linaro.org
Switched to a new branch 'test'
22f2dcd906 docs/conf.py: Don't hard-code QEMU version
975039b71d Makefile: Abstract out "identify the pkgversion" code
eb6658e521 Makefile, configure: Support building rST documentation
dca673cf2e Separate conf.py for each manual we want
2e60fa614a docs/conf.py: Disable option warnings
ccb59ac3b5 docs/conf.py: Don't include rST sources in HTML build
cebfc8b424 docs/conf.py: Configure the 'alabaster' theme
619b69ea8e docs/conf.py: Disable unused _static directory
4ce6a5d59f docs: Commit initial files from sphinx-quickstart
0e08f4f139 docs: Convert memory.txt to rst format
2c6df0cfed docs/cpu-hotplug.rst: Fix rST markup issues

=== OUTPUT BEGIN ===
1/11 Checking commit 2c6df0cfed8f (docs/cpu-hotplug.rst: Fix rST markup issues)
2/11 Checking commit 0e08f4f13950 (docs: Convert memory.txt to rst format)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#22: 
rename from docs/devel/memory.txt

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/11 Checking commit 4ce6a5d59f41 (docs: Commit initial files from sphinx-quickstart)
ERROR: Missing Signed-off-by: line(s)

total: 1 errors, 0 warnings, 188 lines checked

Patch 3/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

4/11 Checking commit 619b69ea8ee3 (docs/conf.py: Disable unused _static directory)
5/11 Checking commit cebfc8b42425 (docs/conf.py: Configure the 'alabaster' theme)
6/11 Checking commit ccb59ac3b537 (docs/conf.py: Don't include rST sources in HTML build)
7/11 Checking commit 2e60fa614a20 (docs/conf.py: Disable option warnings)
8/11 Checking commit dca673cf2ea3 (Separate conf.py for each manual we want)
ERROR: line over 90 characters
#160: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

ERROR: Missing Signed-off-by: line(s)

total: 2 errors, 0 warnings, 133 lines checked

Patch 8/11 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

9/11 Checking commit eb6658e52120 (Makefile, configure: Support building rST documentation)
10/11 Checking commit 975039b71d40 (Makefile: Abstract out "identify the pkgversion" code)
11/11 Checking commit 22f2dcd90680 (docs/conf.py: Don't hard-code QEMU version)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190201145035.22739-1-peter.maydell@linaro.org/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [http://patchew.org/].
Please send your feedback to patchew-devel@redhat.com