[PATCH] docs: Fix installation of man pages with Sphinx 4.x

[PATCH] docs: Fix installation of man pages with Sphinx 4.x

[Damien Goutte-Gattat via]

The 4.x branch of Sphinx introduces a breaking change, as generated man
pages are now written to subdirectories corresponding to the manual
section they belong to. This results in `make install` erroring out when
attempting to install the man pages, because they are not where it
expects to find them.

This patch restores the behavior of Sphinx 3.x regarding man pages.

Signed-off-by: Damien Goutte-Gattat <dgouttegattat@incenp.org>
---
 docs/conf.py | 1 +
 1 file changed, 1 insertion(+)

FYI: For more information about this behavior change of Sphinx, see the 
relevant issue: <https://github.com/sphinx-doc/sphinx/issues/7996>.

diff --git a/docs/conf.py b/docs/conf.py
index 2ee6111872..4bc7298ca8 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -269,6 +269,7 @@
      ['Stefan Hajnoczi <stefanha@redhat.com>',
       'Masayoshi Mizuma <m.mizuma@jp.fujitsu.com>'], 1),
 ]
+man_make_section_directory = False
 
 # -- Options for Texinfo output -------------------------------------------
 
-- 
2.27.0

Re: [PATCH] docs: Fix installation of man pages with Sphinx 4.x

[no-reply]

Patchew URL: https://patchew.org/QEMU/20210503161422.15028-1-dgouttegattat@incenp.org/



Hi,

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

Type: series
Message-id: 20210503161422.15028-1-dgouttegattat@incenp.org
Subject: [PATCH] docs: Fix installation of man pages with Sphinx 4.x

=== 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/20210503161422.15028-1-dgouttegattat@incenp.org -> patchew/20210503161422.15028-1-dgouttegattat@incenp.org
 - [tag update]      patchew/20210503171303.822501-1-f4bug@amsat.org -> patchew/20210503171303.822501-1-f4bug@amsat.org
Switched to a new branch 'test'
fe34fb0 docs: Fix installation of man pages with Sphinx 4.x

=== OUTPUT BEGIN ===
ERROR: Author email address is mangled by the mailing list
#2: 
Author: Damien Goutte-Gattat via <qemu-devel@nongnu.org>

total: 1 errors, 0 warnings, 7 lines checked

Commit fe34fb0f5546 (docs: Fix installation of man pages with Sphinx 4.x) has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
=== OUTPUT END ===

Test command exited with code: 1


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

Re: [PATCH] docs: Fix installation of man pages with Sphinx 4.x

[Peter Maydell]

On Mon, 3 May 2021 at 17:14, Damien Goutte-Gattat
<dgouttegattat@incenp.org> wrote:
>
> The 4.x branch of Sphinx introduces a breaking change, as generated man
> pages are now written to subdirectories corresponding to the manual
> section they belong to. This results in `make install` erroring out when
> attempting to install the man pages, because they are not where it
> expects to find them.
>
> This patch restores the behavior of Sphinx 3.x regarding man pages.
>
> Signed-off-by: Damien Goutte-Gattat <dgouttegattat@incenp.org>
> ---
>  docs/conf.py | 1 +
>  1 file changed, 1 insertion(+)
>
> FYI: For more information about this behavior change of Sphinx, see the
> relevant issue: <https://github.com/sphinx-doc/sphinx/issues/7996>.

Thanks for this fix; sorry we didn't pick the patch up earlier.
I'm going to take it via my target-arm tree.

-- PMM