sphinx queue | Patchew

[Qemu-devel] [PULL 00/12] sphinx queue

Posted by Peter Maydell 5 years, 8 months ago

The only difference from the v3 patchset is that I've
changed a -d to -e in patch 10 as suggested by RTH.

thanks
-- PMM

The following changes since commit 32694e98b8d7a246345448a8f707d2e11d6c65e2:

  Merge remote-tracking branch 'remotes/ehabkost/tags/machine-next-pull-request' into staging (2019-03-06 18:52:19 +0000)

are available in the Git repository at:

  https://git.linaro.org/people/pmaydell/qemu-arm.git tags/pull-sphinx-20190307

for you to fetch changes up to c10e01b996df09f6cb4eceb2b7a9754bece927c9:

  MAINTAINERS: Add entry for Sphinx documentation infrastructure (2019-03-07 14:26:47 +0000)

----------------------------------------------------------------
Enable building and installing rST docs with Sphinx

----------------------------------------------------------------
Peter Maydell (12):
      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
      docs: Provide 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
      MAINTAINERS: Add entry for Sphinx documentation infrastructure

 configure                             |  15 ++-
 Makefile                              |  78 ++++++++----
 .gitignore                            |   1 +
 MAINTAINERS                           |   6 +
 docs/conf.py                          | 216 ++++++++++++++++++++++++++++++++++
 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 +++
 12 files changed, 449 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] [PULL 00/12] sphinx queue

Posted by Peter Maydell 5 years, 8 months ago

On Thu, 7 Mar 2019 at 15:24, Peter Maydell <peter.maydell@linaro.org> wrote:
>
> The only difference from the v3 patchset is that I've
> changed a -d to -e in patch 10 as suggested by RTH.
>
> thanks
> -- PMM
>
> The following changes since commit 32694e98b8d7a246345448a8f707d2e11d6c65e2:
>
>   Merge remote-tracking branch 'remotes/ehabkost/tags/machine-next-pull-request' into staging (2019-03-06 18:52:19 +0000)
>
> are available in the Git repository at:
>
>   https://git.linaro.org/people/pmaydell/qemu-arm.git tags/pull-sphinx-20190307
>
> for you to fetch changes up to c10e01b996df09f6cb4eceb2b7a9754bece927c9:
>
>   MAINTAINERS: Add entry for Sphinx documentation infrastructure (2019-03-07 14:26:47 +0000)
>
> ----------------------------------------------------------------
> Enable building and installing rST docs with Sphinx
>
> ---------------------------------------------------------------

Applied, thanks.

Please update the changelog at https://wiki.qemu.org/ChangeLog/4.0
for any user-visible changes.

-- PMM

Re: [Qemu-devel] [PULL 00/12] sphinx queue

Posted by Philippe Mathieu-Daudé 5 years, 8 months ago

Hi Peter,

On 3/7/19 5:12 PM, Peter Maydell wrote:
> On Thu, 7 Mar 2019 at 15:24, Peter Maydell <peter.maydell@linaro.org> wrote:
>>
>> The only difference from the v3 patchset is that I've
>> changed a -d to -e in patch 10 as suggested by RTH.
>>
>> thanks
>> -- PMM
>>
>> The following changes since commit 32694e98b8d7a246345448a8f707d2e11d6c65e2:
>>
>>   Merge remote-tracking branch 'remotes/ehabkost/tags/machine-next-pull-request' into staging (2019-03-06 18:52:19 +0000)
>>
>> are available in the Git repository at:
>>
>>   https://git.linaro.org/people/pmaydell/qemu-arm.git tags/pull-sphinx-20190307
>>
>> for you to fetch changes up to c10e01b996df09f6cb4eceb2b7a9754bece927c9:
>>
>>   MAINTAINERS: Add entry for Sphinx documentation infrastructure (2019-03-07 14:26:47 +0000)
>>
>> ----------------------------------------------------------------
>> Enable building and installing rST docs with Sphinx
>>
>> ---------------------------------------------------------------
> 
> Applied, thanks.

I'm getting:

./configure --enable-tools --enable-doc
[...]
  GEN     qga/qapi-generated/qapi-gen
  GEN     docs/qemu-block-drivers.7
  GEN     docs/qemu-cpu-models.7
  SPHINX  docs/devel
  SPHINX  docs/interop
  CC      qapi/qapi-visit-core.o
Error: source directory and destination directory are same.
Error: source directory and destination directory are same.
Makefile:880: recipe for target 'docs/interop/index.html' failed
make: *** [docs/interop/index.html] Error 1
make: *** Waiting for unfinished jobs....
Makefile:877: recipe for target 'docs/devel/index.html' failed
make: *** [docs/devel/index.html] Error 1
The command "make -j3 && ${TEST_CMD}" exited with 2.

Is it due to the '-j3'?

See: https://travis-ci.org/philmd/qemu/jobs/503343244

Re: [Qemu-devel] [PULL 00/12] sphinx queue

Posted by Peter Maydell 5 years, 8 months ago

On Fri, 8 Mar 2019 at 00:42, Philippe Mathieu-Daudé <philmd@redhat.com> wrote:
> I'm getting:
>
> ./configure --enable-tools --enable-doc
> [...]
>   GEN     qga/qapi-generated/qapi-gen
>   GEN     docs/qemu-block-drivers.7
>   GEN     docs/qemu-cpu-models.7
>   SPHINX  docs/devel
>   SPHINX  docs/interop
>   CC      qapi/qapi-visit-core.o
> Error: source directory and destination directory are same.
> Error: source directory and destination directory are same.
> Makefile:880: recipe for target 'docs/interop/index.html' failed
> make: *** [docs/interop/index.html] Error 1
> make: *** Waiting for unfinished jobs....
> Makefile:877: recipe for target 'docs/devel/index.html' failed
> make: *** [docs/devel/index.html] Error 1
> The command "make -j3 && ${TEST_CMD}" exited with 2.

It's probably due to your doing an in-source-tree build
rather than an out-of-tree one :-(

thanks
-- PMM

Re: [Qemu-devel] [PULL 00/12] sphinx queue

Posted by no-reply@patchew.org 5 years, 8 months ago

Patchew URL: https://patchew.org/QEMU/20190307152450.20340-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: 20190307152450.20340-1-peter.maydell@linaro.org
Subject: [Qemu-devel] [PULL 00/12] sphinx queue

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git rev-parse base > /dev/null || exit 0
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/20190307152450.20340-1-peter.maydell@linaro.org -> patchew/20190307152450.20340-1-peter.maydell@linaro.org
Switched to a new branch 'test'
ce86f39d86 MAINTAINERS: Add entry for Sphinx documentation infrastructure
8386a51cbc docs/conf.py: Don't hard-code QEMU version
1bf3cccfcc Makefile: Abstract out "identify the pkgversion" code
2a5a77529d Makefile, configure: Support building rST documentation
3b93226296 docs: Provide separate conf.py for each manual we want
162ad919a4 docs/conf.py: Disable option warnings
e6e223c900 docs/conf.py: Don't include rST sources in HTML build
94647f825b docs/conf.py: Configure the 'alabaster' theme
9411e7ffcd docs/conf.py: Disable unused _static directory
8ca79b864c docs: Commit initial files from sphinx-quickstart
a7754aa13e docs: Convert memory.txt to rst format
89a2ccdee7 docs/cpu-hotplug.rst: Fix rST markup issues

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

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/12 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/12 Checking commit 8ca79b864c00 (docs: Commit initial files from sphinx-quickstart)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#19: 
new file mode 100644

total: 0 errors, 1 warnings, 188 lines checked

Patch 3/12 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
4/12 Checking commit 9411e7ffcdfa (docs/conf.py: Disable unused _static directory)
5/12 Checking commit 94647f825b62 (docs/conf.py: Configure the 'alabaster' theme)
6/12 Checking commit e6e223c90054 (docs/conf.py: Don't include rST sources in HTML build)
7/12 Checking commit 162ad919a4ea (docs/conf.py: Disable option warnings)
8/12 Checking commit 3b9322629671 (docs: Provide separate conf.py for each manual we want)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#103: 
new file mode 100644

ERROR: line over 90 characters
#188: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

total: 1 errors, 1 warnings, 133 lines checked

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

9/12 Checking commit 2a5a77529dc6 (Makefile, configure: Support building rST documentation)
10/12 Checking commit 1bf3cccfcc6d (Makefile: Abstract out "identify the pkgversion" code)
11/12 Checking commit 8386a51cbcde (docs/conf.py: Don't hard-code QEMU version)
12/12 Checking commit ce86f39d861d (MAINTAINERS: Add entry for Sphinx documentation infrastructure)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190307152450.20340-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] [PULL 00/12] sphinx queue

Posted by no-reply@patchew.org 5 years, 8 months ago

Patchew URL: https://patchew.org/QEMU/20190307152450.20340-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: 20190307152450.20340-1-peter.maydell@linaro.org
Subject: [Qemu-devel] [PULL 00/12] sphinx queue

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git rev-parse base > /dev/null || exit 0
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
   3a75ef6a0f..21afe115a4  master     -> master
 t [tag update]            patchew/20190307152450.20340-1-peter.maydell@linaro.org -> patchew/20190307152450.20340-1-peter.maydell@linaro.org
Switched to a new branch 'test'
0c5960c22b MAINTAINERS: Add entry for Sphinx documentation infrastructure
7d56553341 docs/conf.py: Don't hard-code QEMU version
81694a176c Makefile: Abstract out "identify the pkgversion" code
3bb6a33fe2 Makefile, configure: Support building rST documentation
ec602b9aa9 docs: Provide separate conf.py for each manual we want
71008428e4 docs/conf.py: Disable option warnings
e1e5726b6a docs/conf.py: Don't include rST sources in HTML build
249cbf4624 docs/conf.py: Configure the 'alabaster' theme
9efa34cb92 docs/conf.py: Disable unused _static directory
463815c673 docs: Commit initial files from sphinx-quickstart
960b28ec15 docs: Convert memory.txt to rst format
ce6323a39d docs/cpu-hotplug.rst: Fix rST markup issues

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

total: 0 errors, 1 warnings, 195 lines checked

Patch 2/12 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
3/12 Checking commit 463815c6733a (docs: Commit initial files from sphinx-quickstart)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#19: 
new file mode 100644

total: 0 errors, 1 warnings, 188 lines checked

Patch 3/12 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
4/12 Checking commit 9efa34cb9230 (docs/conf.py: Disable unused _static directory)
5/12 Checking commit 249cbf46245c (docs/conf.py: Configure the 'alabaster' theme)
6/12 Checking commit e1e5726b6a40 (docs/conf.py: Don't include rST sources in HTML build)
7/12 Checking commit 71008428e4d0 (docs/conf.py: Disable option warnings)
8/12 Checking commit ec602b9aa9e1 (docs: Provide separate conf.py for each manual we want)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#103: 
new file mode 100644

ERROR: line over 90 characters
#188: FILE: docs/interop/conf.py:15:
+html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'

total: 1 errors, 1 warnings, 133 lines checked

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

9/12 Checking commit 3bb6a33fe252 (Makefile, configure: Support building rST documentation)
10/12 Checking commit 81694a176c81 (Makefile: Abstract out "identify the pkgversion" code)
11/12 Checking commit 7d5655334199 (docs/conf.py: Don't hard-code QEMU version)
12/12 Checking commit 0c5960c22bba (MAINTAINERS: Add entry for Sphinx documentation infrastructure)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/20190307152450.20340-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