Skip to contentSkip to conversation

scripts/sphinx-pre-install: fix out-of-tree build

PATCH Applied Mike Rapoport 3 participants 3 messages Jun 24, 2019 – Jun 26, 2019 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 scripts/sphinx-pre-install: fix out-of-tree build

Build of htmldocs fails for out-of-tree builds:

$ make V=1 O=~/build/kernel/ htmldocs
make -C /home/rppt/build/kernel -f /home/rppt/git/linux-docs/Makefile htmldocs
make[1]: Entering directory '/home/rppt/build/kernel'
make -f /home/rppt/git/linux-docs/scripts/Makefile.build obj=scripts/basic
rm -f .tmp_quiet_recordmcount
make -f /home/rppt/git/linux-docs/scripts/Makefile.build obj=Documentation htmldocs
Can't open Documentation/conf.py at /home/rppt/git/linux-docs/scripts/sphinx-pre-install line 230.
/home/rppt/git/linux-docs/Documentation/Makefile:80: recipe for target 'htmldocs' failed
make[2]: *** [htmldocs] Error 2

The scripts/sphinx-pre-install is trying to open files in the current directory which is $KBUILD_OUTPUT rather than in $srctree.

Fix it.

---
v2: use "./" as default prefix as Mauro suggested

 scripts/sphinx-pre-install | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
scripts/sphinx-pre-install +5 -2
index 0b44d51..f230e65 100755
@@ -5,8 +5,11 @@ use strict;
 # Copyright (c) 2017-2019 Mauro Carvalho Chehab <[email protected]>
 #
 
-my $conf = "Documentation/conf.py";
-my $requirement_file = "Documentation/sphinx/requirements.txt";
+my $prefix = "./";
+$prefix = "$ENV{'srctree'}/" if ($ENV{'srctree'});
+
+my $conf = $prefix . "Documentation/conf.py";
+my $requirement_file = $prefix . "Documentation/sphinx/requirements.txt";
 my $virtenv_prefix = "sphinx_";
 
 #
Signature · 1 line
2.7.4
Reviewed-by on v2 1/1
#1 lore raw

Em Mon, 24 Jun 2019 08:25:07 +0300
Mike Rapoport <[email protected]> escreveu:

Quoted 12 lines

Build of htmldocs fails for out-of-tree builds:

$ make V=1 O=~/build/kernel/ htmldocs
make -C /home/rppt/build/kernel -f /home/rppt/git/linux-docs/Makefile htmldocs
make[1]: Entering directory '/home/rppt/build/kernel'
make -f /home/rppt/git/linux-docs/scripts/Makefile.build obj=scripts/basic
rm -f .tmp_quiet_recordmcount
make -f /home/rppt/git/linux-docs/scripts/Makefile.build obj=Documentation htmldocs
Can't open Documentation/conf.py at /home/rppt/git/linux-docs/scripts/sphinx-pre-install line 230.
/home/rppt/git/linux-docs/Documentation/Makefile:80: recipe for target 'htmldocs' failed
make[2]: *** [htmldocs] Error 2
Quoted 6 lines

The scripts/sphinx-pre-install is trying to open files in the current directory which is $KBUILD_OUTPUT rather than in $srctree.

Fix it.

Quoted 14 lines

---
v2: use "./" as default prefix as Mauro suggested

 scripts/sphinx-pre-install | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
scripts/sphinx-pre-install +0 -0
index 0b44d51..f230e65 100755
@@ -5,8 +5,11 @@ use strict;
 # Copyright (c) 2017-2019 Mauro Carvalho Chehab <[email protected]>
 #
 

scripts/sphinx-pre-install use strict; · line 15

Quoted 10 lines
scripts/sphinx-pre-install +5 -2
-my $conf = "Documentation/conf.py";
-my $requirement_file = "Documentation/sphinx/requirements.txt";
+my $prefix = "./";
+$prefix = "$ENV{'srctree'}/" if ($ENV{'srctree'});
+
+my $conf = $prefix . "Documentation/conf.py";
+my $requirement_file = $prefix . "Documentation/sphinx/requirements.txt";
 my $virtenv_prefix = "sphinx_";
 
 #

Thanks,
Mauro

maintainer Applied
#2 lore raw
In reply to Mike Rapoport
Quoted 12 lines · On Mon, 24 Jun 2019 08:25:07 +0300 Mike Rapoport <[email protected]> wrote:

Build of htmldocs fails for out-of-tree builds:

$ make V=1 O=~/build/kernel/ htmldocs
make -C /home/rppt/build/kernel -f /home/rppt/git/linux-docs/Makefile htmldocs
make[1]: Entering directory '/home/rppt/build/kernel'
make -f /home/rppt/git/linux-docs/scripts/Makefile.build obj=scripts/basic
rm -f .tmp_quiet_recordmcount
make -f /home/rppt/git/linux-docs/scripts/Makefile.build obj=Documentation htmldocs
Can't open Documentation/conf.py at /home/rppt/git/linux-docs/scripts/sphinx-pre-install line 230.
/home/rppt/git/linux-docs/Documentation/Makefile:80: recipe for target 'htmldocs' failed
make[2]: *** [htmldocs] Error 2
Quoted 6 lines

The scripts/sphinx-pre-install is trying to open files in the current directory which is $KBUILD_OUTPUT rather than in $srctree.

Fix it.

Applied, thanks.

jon