configure: warn if not using a separate build directory
PATCH 1/1 configure: warn if not using a separate build directory
Running configure directly from the source directory is a build configuration that will go away in future. It is also not currently covered by any automated testing. Display a deprecation warning if the user attempts to use an in-srcdir build setup, so that they are aware that they're building QEMU in an undesirable manner.
--- configure | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+)
configure +30 -0
@@ -3,6 +3,19 @@ # qemu configure script (c) 2003 Fabrice Bellard # +BUILDDIR=$(pwd) +SRCDIR=$(dirname "$0") + +ABS_BUILDDIR=$(realpath $BUILDDIR) +ABS_SRCDIR=$(realpath $SRCDIR) + +in_srcdir=no +if [ "$ABS_SRCDIR" == "$ABS_BUILDDIR" ] +then + in_srcdir=yes +fi + + # Unset some variables known to interfere with behavior of common tools, # just as autoconf does. CLICOLOR_FORCE= GREP_OPTIONS=
@@ -6799,6 +6812,23 @@ if test "$supported_os" = "no"; then echo "us upstream at [email protected]." fi +if test "$in_srcdir" = "yes"; then + echo + echo "WARNING: SUPPORT FOR IN SOURCE DIR BUILDS IS DEPRECATED" + echo + echo "Support for running the 'configure' script directly from the" + echo "source directory is deprecated and will go away in a future" + echo "release. In source dir builds are not covered by automated" + echo "testing and are liable to break without warning. Users are" + echo "strongly recommended to switch to a separate build directory:" + echo + echo " $ mkdir build" + echo " $ cd build" + echo " $ ../configure" + echo " $ make" + echo +fi + config_host_mak="config-host.mak" echo "# Automatically generated by configure - do not modify" >config-all-disas.mak
Signature · 1 line
2.24.1
Quoted 16 lines · Daniel P. Berrangé
Running configure directly from the source directory is a build configuration that will go away in future. It is also not currently covered by any automated testing. Display a deprecation warning if the user attempts to use an in-srcdir build setup, so that they are aware that they're building QEMU in an undesirable manner.
Signed-off-by Daniel P. Berrangé <[email protected]>--- configure | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+)configure +0
-0
configure line 7
Quoted 5 lines
configure +2
-0@@ -3,6 +3,19 @@ # qemu configure script (c) 2003 Fabrice Bellard # +BUILDDIR=$(pwd) +SRCDIR=$(dirname "$0")
This duplicates $source_path.
Maybe you can rename it $source_path and remove the $source_path assignment later.
Quoted 24 lines
configure +17
-0+ +ABS_BUILDDIR=$(realpath $BUILDDIR) +ABS_SRCDIR=$(realpath $SRCDIR) + +in_srcdir=no +if [ "$ABS_SRCDIR" == "$ABS_BUILDDIR" ] +then + in_srcdir=yes +fi + + # Unset some variables known to interfere with behavior of common tools, # just as autoconf does. CLICOLOR_FORCE= GREP_OPTIONS=@@ -6799,6 +6812,23 @@ if test "$supported_os" = "no"; then echo "us upstream at [email protected]." fi +if test "$in_srcdir" = "yes"; then + echo + echo "WARNING: SUPPORT FOR IN SOURCE DIR BUILDS IS DEPRECATED" + echo + echo "Support for running the 'configure' script directly from the" + echo "source directory is deprecated and will go away in a future"
configure if test "$supported_os" = "no"; then · line 6830
Quoted 10 lines
configure +10
-0+ echo "release. In source dir builds are not covered by automated" + echo "testing and are liable to break without warning. Users are" + echo "strongly recommended to switch to a separate build directory:" + echo + echo " $ mkdir build" + echo " $ cd build" + echo " $ ../configure" + echo " $ make" + echo +fi
I'd move it at the very end of the file, to be the last thing displayed.
Quoted 5 lines
configure +1
-0+ config_host_mak="config-host.mak" echo "# Automatically generated by configure - do not modify" >config-all-disas.mak
Quoted 12 lines · Philippe Mathieu-Daudé
Quoted 11 lines · Daniel P. Berrangé
Running configure directly from the source directory is a build configuration that will go away in future. It is also not currently covered by any automated testing. Display a deprecation warning if the user attempts to use an in-srcdir build setup, so that they are aware that they're building QEMU in an undesirable manner.
Signed-off-by Daniel P. Berrangé <[email protected]>--- configure | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+)
Quoted 13 lines
configure line 6
Quoted 9 lines
configure +2
-0@@ -3,6 +3,19 @@ # qemu configure script (c) 2003 Fabrice Bellard # +BUILDDIR=$(pwd) +SRCDIR=$(dirname "$0")This duplicates $source_path.
Maybe you can rename it $source_path and remove the $source_path assignment later.
Sure, could do that..
Quoted 28 lines
Quoted 28 lines
configure +21
-0+ +ABS_BUILDDIR=$(realpath $BUILDDIR) +ABS_SRCDIR=$(realpath $SRCDIR) + +in_srcdir=no +if [ "$ABS_SRCDIR" == "$ABS_BUILDDIR" ] +then + in_srcdir=yes +fi + + # Unset some variables known to interfere with behavior of common tools, # just as autoconf does. CLICOLOR_FORCE= GREP_OPTIONS=@@ -6799,6 +6812,23 @@ if test "$supported_os" = "no"; then echo "us upstream at [email protected]." fi +if test "$in_srcdir" = "yes"; then + echo + echo "WARNING: SUPPORT FOR IN SOURCE DIR BUILDS IS DEPRECATED" + echo + echo "Support for running the 'configure' script directly from the" + echo "source directory is deprecated and will go away in a future" + echo "release. In source dir builds are not covered by automated" + echo "testing and are liable to break without warning. Users are" + echo "strongly recommended to switch to a separate build directory:" + echo
Quoted 8 lines
configure if test "$supported_os" = "no"; then · line 6830
Quoted 6 lines
configure +6
-0+ echo " $ mkdir build" + echo " $ cd build" + echo " $ ../configure" + echo " $ make" + echo +fiI'd move it at the very end of the file, to be the last thing displayed.
You can't see it from the diff, but immediately before here are a bunch of other big warnings for users, so I figured it was a good idea to keep them all together.
Quoted 8 lines
Reviewed-by Philippe Mathieu-Daudé <[email protected]>Quoted 4 lines
configure +1
-0+ config_host_mak="config-host.mak" echo "# Automatically generated by configure - do not modify" >config-all-disas.mak
Regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
Quoted 66 lines · Daniel P. Berrangé
Quoted 12 lines · Philippe Mathieu-Daudé
Quoted 11 lines · Daniel P. Berrangé
Running configure directly from the source directory is a build configuration that will go away in future. It is also not currently covered by any automated testing. Display a deprecation warning if the user attempts to use an in-srcdir build setup, so that they are aware that they're building QEMU in an undesirable manner.
Signed-off-by Daniel P. Berrangé <[email protected]>--- configure | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+)Quoted 13 lines
configure line 6
Quoted 9 lines
configure +2
-0@@ -3,6 +3,19 @@ # qemu configure script (c) 2003 Fabrice Bellard # +BUILDDIR=$(pwd) +SRCDIR=$(dirname "$0")This duplicates $source_path.
Maybe you can rename it $source_path and remove the $source_path assignment later.Sure, could do that..
Quoted 28 lines
Quoted 28 lines
configure +21
-0+ +ABS_BUILDDIR=$(realpath $BUILDDIR) +ABS_SRCDIR=$(realpath $SRCDIR) + +in_srcdir=no +if [ "$ABS_SRCDIR" == "$ABS_BUILDDIR" ] +then + in_srcdir=yes +fi + + # Unset some variables known to interfere with behavior of common tools, # just as autoconf does. CLICOLOR_FORCE= GREP_OPTIONS=@@ -6799,6 +6812,23 @@ if test "$supported_os" = "no"; then echo "us upstream at [email protected]." fi +if test "$in_srcdir" = "yes"; then + echo + echo "WARNING: SUPPORT FOR IN SOURCE DIR BUILDS IS DEPRECATED" + echo + echo "Support for running the 'configure' script directly from the" + echo "source directory is deprecated and will go away in a future" + echo "release. In source dir builds are not covered by automated" + echo "testing and are liable to break without warning. Users are" + echo "strongly recommended to switch to a separate build directory:" + echoQuoted 8 lines
configure if test "$supported_os" = "no"; then · line 6830
Quoted 6 lines
configure +6
-0+ echo " $ mkdir build" + echo " $ cd build" + echo " $ ../configure" + echo " $ make" + echo +fiI'd move it at the very end of the file, to be the last thing displayed.
Quoted 3 lines
You can't see it from the diff, but immediately before here are a bunch of other big warnings for users, so I figured it was a good idea to keep them all together.
IMO we should move them to the end too.
I'm getting this output:
$ ./configure [...] plugin support no fuzzing support no gdb /usr/bin/gdb
WARNING: SUPPORT FOR IN SOURCE DIR BUILDS IS DEPRECATED
Support for running the 'configure' script directly from the source directory is deprecated and will go away in a future release. In source dir builds are not covered by automated testing and are liable to break without warning. Users are strongly recommended to switch to a separate build directory:
$ mkdir build $ cd build $ ../configure $ make
cross containers docker
NOTE: guest cross-compilers enabled: cc cc
$
We might also move the cross-x messages earlier.
Anyway all my comments can be postponed to 5.1, so if other agree with your patch, let's KISS for 5.1-rc1.
Quoted 13 lines
Quoted 9 lines
Reviewed-by Philippe Mathieu-Daudé <[email protected]>Quoted 4 lines
configure +1
-0+ config_host_mak="config-host.mak" echo "# Automatically generated by configure - do not modify" >config-all-disas.makRegards,
Daniel
Quoted 11 lines · Daniel P. Berrangé
Running configure directly from the source directory is a build configuration that will go away in future. It is also not currently covered by any automated testing. Display a deprecation warning if the user attempts to use an in-srcdir build setup, so that they are aware that they're building QEMU in an undesirable manner.
Signed-off-by Daniel P. Berrangé <[email protected]>--- configure | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+)
It sounds like you already have a v2 coming up to address Phillipe's comments, but I'd be happy to see this concept make it into v5.0.
configure line 6
Quoted 9 lines
configure +1
-0@@ -3,6 +3,19 @@ # qemu configure script (c) 2003 Fabrice Bellard # +BUILDDIR=$(pwd)
Why fork out to 'pwd', when we can rely on $PWD for the same answer? Note that both $(pwd) and $PWD $BUILDDIR always give an absolute (but no necessarily canonical) path, which means...
configure line 9
Quoted 3 lines
configure +3
-0+SRCDIR=$(dirname "$0") + +ABS_BUILDDIR=$(realpath $BUILDDIR)
...calling this ABS_BUILDDIR is a misnomer (it was already absolute). What it is really doing is chasing through symlinks to result in a canonical name, particularly since unless you have absolute names, using only string comparison to see if two filenames are equivalent will have false negatives (/tmp vs. /tmp/., for example).
configure line 10
Quoted 1 line
configure +1
-0+ABS_SRCDIR=$(realpath $SRCDIR)
Not robust if there are spaces in the directory names. Safer would be ABS_BUILDDIR=$(realpath -- "$BUILDDIR")
and similarly for ABS_SRCDIR.
configure line 13
Quoted 3 lines
configure +3
-0+ +in_srcdir=no +if [ "$ABS_SRCDIR" == "$ABS_BUILDDIR" ]
Bashism. You MUST spell this '=', not '==', since configure is run under /bin/sh which might be dash which does not understand ==.
Quoted 18 lines
configure +11
-0+then + in_srcdir=yes +fi + + # Unset some variables known to interfere with behavior of common tools, # just as autoconf does. CLICOLOR_FORCE= GREP_OPTIONS=@@ -6799,6 +6812,23 @@ if test "$supported_os" = "no"; then echo "us upstream at [email protected]." fi +if test "$in_srcdir" = "yes"; then + echo + echo "WARNING: SUPPORT FOR IN SOURCE DIR BUILDS IS DEPRECATED" + echo + echo "Support for running the 'configure' script directly from the" + echo "source directory is deprecated and will go away in a future"
configure if test "$supported_os" = "no"; then · line 6830
Quoted 10 lines
configure +10
-0+ echo "release. In source dir builds are not covered by automated" + echo "testing and are liable to break without warning. Users are" + echo "strongly recommended to switch to a separate build directory:" + echo + echo " $ mkdir build" + echo " $ cd build" + echo " $ ../configure" + echo " $ make" + echo +fi
You know, it WOULD be possible to further enhance this to actually create 'build' as well as a shim GNUmakefile that would auto-forward on to building directly in build, so that you maintain the illusion of an in-place build (other than all the build artifacts now living in a different location), and muscle memory for in-tree 'make' still works; I've posted elsewhere and will repeat here the contents of my GNUmakefile:
# Hack for redirecting while reminding myself to use distinct builddir ifeq ($(MAKECMDGOALS),)
recurse: all
endif
%: force
@echo 'changing directory to build...' @sleep 2 @$(MAKE) -C build -f Makefile $(MAKECMDGOALS)
force: ;
.PHONY: force
GNUmakefile: ;
But we could do that as a patch on top of yours.
Signature · 3 lines
Eric Blake, Principal Software Engineer Red Hat, Inc. +1-919-301-3226 Virtualization: qemu.org | libvirt.org
Quoted 45 lines · Eric Blake
Quoted 11 lines · Daniel P. Berrangé
Running configure directly from the source directory is a build configuration that will go away in future. It is also not currently covered by any automated testing. Display a deprecation warning if the user attempts to use an in-srcdir build setup, so that they are aware that they're building QEMU in an undesirable manner.
Signed-off-by Daniel P. Berrangé <[email protected]>--- configure | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+)It sounds like you already have a v2 coming up to address Phillipe's comments, but I'd be happy to see this concept make it into v5.0.
configure line 5
Quoted 8 lines
configure +1
-0@@ -3,6 +3,19 @@ # qemu configure script (c) 2003 Fabrice Bellard # +BUILDDIR=$(pwd)Why fork out to 'pwd', when we can rely on $PWD for the same answer? Note that both $(pwd) and $PWD $BUILDDIR always give an absolute (but no necessarily canonical) path, which means...
configure line 9
Quoted 3 lines
configure +3
-0+SRCDIR=$(dirname "$0") + +ABS_BUILDDIR=$(realpath $BUILDDIR)...calling this
ABS_BUILDDIRis a misnomer (it was already absolute). What it is really doing is chasing through symlinks to result in a canonical name, particularly since unless you have absolute names, using only string comparison to see if two filenames are equivalent will have false negatives (/tmp vs./tmp/., for example).configure line 10
Quoted 1 line
configure +1
-0+ABS_SRCDIR=$(realpath $SRCDIR)Not robust if there are spaces in the directory names. Safer would be ABS_BUILDDIR=$(realpath -- "$BUILDDIR")
and similarly forABS_SRCDIR.
Quoted 6 lines
configure line 13
Quoted 3 lines
configure +3
-0+ +in_srcdir=no +if [ "$ABS_SRCDIR" == "$ABS_BUILDDIR" ]Bashism. You MUST spell this '=', not '==', since configure is run under
/bin/shwhich might be dash which does not understand ==.
Ok, will address all of the above.
Quoted 18 lines
Quoted 18 lines
configure +15
-0@@ -6799,6 +6812,23 @@ if test "$supported_os" = "no"; then echo "us upstream at [email protected]." fi +if test "$in_srcdir" = "yes"; then + echo + echo "WARNING: SUPPORT FOR IN SOURCE DIR BUILDS IS DEPRECATED" + echo + echo "Support for running the 'configure' script directly from the" + echo "source directory is deprecated and will go away in a future" + echo "release. In source dir builds are not covered by automated" + echo "testing and are liable to break without warning. Users are" + echo "strongly recommended to switch to a separate build directory:" + echo + echo " $ mkdir build" + echo " $ cd build" + echo " $ ../configure" + echo " $ make" + echo
Quoted 8 lines
configure if test "$supported_os" = "no"; then · line 6829
Quoted 1 line
configure +1
-0+fiYou know, it WOULD be possible to further enhance this to actually create 'build' as well as a shim GNUmakefile that would auto-forward on to building directly in build, so that you maintain the illusion of an in-place build (other than all the build artifacts now living in a different location), and muscle memory for in-tree 'make' still works; I've posted elsewhere and will repeat here the contents of my GNUmakefile:
I wanted to focus strictly on the part that we have agreement on, namely the deprecation. Any functional changes should be completely separate to avoid holding up the merge of the warning message patch.
Regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
Quoted 74 lines · Eric Blake
Quoted 11 lines · Daniel P. Berrangé
Running configure directly from the source directory is a build configuration that will go away in future. It is also not currently covered by any automated testing. Display a deprecation warning if the user attempts to use an in-srcdir build setup, so that they are aware that they're building QEMU in an undesirable manner.
Signed-off-by Daniel P. Berrangé <[email protected]>--- configure | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+)It sounds like you already have a v2 coming up to address Phillipe's comments, but I'd be happy to see this concept make it into v5.0.
configure line 5
Quoted 8 lines
configure +0
-0@@ -3,6 +3,19 @@ # qemu configure script (c) 2003 Fabrice Bellard # +BUILDDIR=$(pwd)Why fork out to 'pwd', when we can rely on $PWD for the same answer? Note that both $(pwd) and $PWD $BUILDDIR always give an absolute (but no necessarily canonical) path, which means...
configure line 9
Quoted 3 lines
configure +3
-0+SRCDIR=$(dirname "$0") + +ABS_BUILDDIR=$(realpath $BUILDDIR)...calling this
ABS_BUILDDIRis a misnomer (it was already absolute). What it is really doing is chasing through symlinks to result in a canonical name, particularly since unless you have absolute names, using only string comparison to see if two filenames are equivalent will have false negatives (/tmp vs./tmp/., for example).configure line 10
Quoted 1 line
configure +1
-0+ABS_SRCDIR=$(realpath $SRCDIR)Not robust if there are spaces in the directory names. Safer would be ABS_BUILDDIR=$(realpath -- "$BUILDDIR")
and similarly forABS_SRCDIR.configure line 13
Quoted 3 lines
configure +3
-0+ +in_srcdir=no +if [ "$ABS_SRCDIR" == "$ABS_BUILDDIR" ]Bashism. You MUST spell this '=', not '==', since configure is run under
/bin/shwhich might be dash which does not understand ==.Quoted 17 lines
configure +10
-0+then + in_srcdir=yes +fi + + # Unset some variables known to interfere with behavior of common tools, # just as autoconf does. CLICOLOR_FORCE= GREP_OPTIONS=@@ -6799,6 +6812,23 @@ if test "$supported_os" = "no"; then echo "us upstream at [email protected]." fi +if test "$in_srcdir" = "yes"; then + echo + echo "WARNING: SUPPORT FOR IN SOURCE DIR BUILDS IS DEPRECATED" + echo + echo "Support for running the 'configure' script directly from the" + echo "source directory is deprecated and will go away in a future"configure if test "$supported_os" = "no"; then · line 6829
Quoted 10 lines
configure +10
-0+ echo "release. In source dir builds are not covered by automated" + echo "testing and are liable to break without warning. Users are" + echo "strongly recommended to switch to a separate build directory:" + echo + echo " $ mkdir build" + echo " $ cd build" + echo " $ ../configure" + echo " $ make" + echo +fiYou know, it WOULD be possible to further enhance this to actually create 'build' as well as a shim GNUmakefile that would auto-forward on to building directly in build, so that you maintain the illusion of an in-place build (other than all the build artifacts now living in a different location), and muscle memory for in-tree 'make' still works; I've posted elsewhere and will repeat here the contents of my GNUmakefile:
Quoted 7 lines
# Hack for redirecting while reminding myself to use distinct builddir ifeq ($(MAKECMDGOALS),)
recurse: all
endif
%: force
@echo 'changing directory to build...'
@sleep 2
Right, just drop all the 14 line warning above, this one line here should be enough to remind people (maybe reworded to say that build results are found there and move it after the $(MAKE) so it's printed last and drop the sleep 2 and this should work.
Regards,
BALATON Zoltan
Quoted 9 lines
@$(MAKE) -C build -f Makefile $(MAKECMDGOALS)force: ;
.PHONY: force
GNUmakefile: ;But we could do that as a patch on top of yours.
Am 31.03.2020 um 16:56 hat Daniel P. Berrangé geschrieben:
Quoted 37 lines · Eric Blake
Quoted 27 lines · Daniel P. Berrangé
Quoted 26 lines
Running configure directly from the source directory is a build configuration that will go away in future. It is also not currently covered by any automated testing. Display a deprecation warning if the user attempts to use an in-srcdir build setup, so that they are aware that they're building QEMU in an undesirable manner.
Signed-off-by Daniel P. Berrangé <[email protected]>configure +15
-0@@ -6799,6 +6812,23 @@ if test "$supported_os" = "no"; then echo "us upstream at [email protected]." fi +if test "$in_srcdir" = "yes"; then + echo + echo "WARNING: SUPPORT FOR IN SOURCE DIR BUILDS IS DEPRECATED" + echo + echo "Support for running the 'configure' script directly from the" + echo "source directory is deprecated and will go away in a future" + echo "release. In source dir builds are not covered by automated" + echo "testing and are liable to break without warning. Users are" + echo "strongly recommended to switch to a separate build directory:" + echo + echo " $ mkdir build" + echo " $ cd build" + echo " $ ../configure" + echo " $ make" + echoQuoted 8 lines
Review if test "$supported_os" = "no"; then · line 6829
Quoted 1 line
(quoted diff) +1
-0+fiYou know, it WOULD be possible to further enhance this to actually create 'build' as well as a shim GNUmakefile that would auto-forward on to building directly in build, so that you maintain the illusion of an in-place build (other than all the build artifacts now living in a different location), and muscle memory for in-tree 'make' still works; I've posted elsewhere and will repeat here the contents of my GNUmakefile:
Quoted 3 lines
I wanted to focus strictly on the part that we have agreement on, namely the deprecation. Any functional changes should be completely separate to avoid holding up the merge of the warning message patch.
We don't have agreement on the type of deprecation suggested by your message, that is, that ./configure from the source directory will stop working.
If we can agree on using Eric's approach, then the message should rather tell users that the resulting binaries will move to a different place in future versions.
Kevin
Quoted 3 lines · Daniel P. Berrangé
Running configure directly from the source directory is a build configuration that will go away in future. It is also not currently
s/in future/in the future/g
Carlo