Skip to contentSkip to conversation

configure: warn if not using a separate build directory

PATCH Superseded Daniel P. Berrangé 4 participants 6 messages Mar 31, 2020

v2 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 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.

---

Changed in v2:

- Use existing $source_path variable (Eric)
- Remove bash-ism in comparison (Eric)
- Safe quoting of directory paths (Eric)
- Rename variables to reflect that we're applying canonicalization (Eric)

 configure | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
configure +27 -0
index e225a1e3ff..5991e0e6e5 100755
@@ -285,6 +285,16 @@ then
   error_exit "main directory cannot contain spaces nor colons"
 fi
 
+canon_build_path=$(realpath -- "$PWD")
+canon_source_path=$(realpath -- "$source_path")
+
+in_srcdir=no
+if [ "$canon_build_path" = "$canon_source_path" ]
+then
+    in_srcdir=yes
+fi
+
+
 # default parameters
 cpu=""
 iasl="iasl"
@@ -6799,6 +6809,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
Reviewed-by on v2 1/1
#1 lore raw
Quoted 6 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.

Quoted 6 lines

---

Changed in v2:

- Use existing $source_path variable (Eric)

Phillipe, actually - but this line isn't permanent.

Quoted 13 lines

- Remove bash-ism in comparison (Eric)
- Safe quoting of directory paths (Eric)
- Rename variables to reflect that we're applying canonicalization (Eric)

  configure | 27 +++++++++++++++++++++++++++
  1 file changed, 27 insertions(+)
configure +0 -0
index e225a1e3ff..5991e0e6e5 100755
@@ -285,6 +285,16 @@ then
    error_exit "main directory cannot contain spaces nor colons"

configure then · line 295

Quoted 10 lines
configure +8 -0
  fi
 
+canon_build_path=$(realpath -- "$PWD")
+canon_source_path=$(realpath -- "$source_path")
+
+in_srcdir=no
+if [ "$canon_build_path" = "$canon_source_path" ]
+then
+    in_srcdir=yes
+fi

This part is good.

Quoted 8 lines
configure +2 -0
+
+
  # default parameters
  cpu=""
  iasl="iasl"
@@ -6799,6 +6809,23 @@ if test "$supported_os" = "no"; then
      echo "us upstream at [email protected]."
  fi

configure if test "$supported_os" = "no"; then · line 6820

Quoted 10 lines
configure +9 -0
 
+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:"

Per Kevin's response, we may want to tweak this wording slightly; maybe:

Support for running the 'configure' script directly from the source directory is deprecated. In-tree builds are not covered by automated testing and are liable to break without warning. Future releases may change the default location of built executables for an in-tree build, or drop in-tree build support altogether. Users are strongly recommended to switch to a separate build directory:

configure if test "$supported_os" = "no"; then · line 6831

Quoted 12 lines
configure +8 -0
+    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

Whether we keep your wording or switch to somthing based on mine,

Signature · 3 lines
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org
#2 lore raw
Quoted 12 lines · Eric Blake

configure if test "$supported_os" = "no"; then · line 6820

Quoted 9 lines · Daniel P. Berrangé
configure +9 -0
+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:"
Quoted 8 lines

Per Kevin's response, we may want to tweak this wording slightly; maybe:

Support for running the 'configure' script directly from the source directory is deprecated. In-tree builds are not covered by automated testing and are liable to break without warning. Future releases may change the default location of built executables for an in-tree build, or drop in-tree build support altogether. Users are strongly recommended to switch to a separate build directory:

I now feel that, given that we've had various people say they want to retain at least the basic in-tree build commands and are willing to put in a wrapper to make it keep working, that this deprecation wording is a bit strong. I don't think that it much serves our users to say "this will go away" and then implement the compatibility wrapper -- we've caused them to unnecessarily change what they're doing, and then reduced the value of the compat-wrapper work we do. A more gently phrased note that we recommend use of out-of-tree builds would be sufficient I think.

(That is, the idea of notes in the release notes and configure is to signpost to our users the direction we think the project is going in, so they are not unpleasantly surprised in future. For this to work the signpost should be pointing reasonably in the direction we plan to head, rather than somewhat askew from it :-))

thanks
-- PMM

Reviewed-by on v2 1/1
#4 lore raw
In reply to Daniel P. Berrangé
Quoted 41 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.

---

Changed in v2:

- Use existing $source_path variable (Eric)
- Remove bash-ism in comparison (Eric)
- Safe quoting of directory paths (Eric)
- Rename variables to reflect that we're applying canonicalization (Eric)

 configure | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
configure +10 -0
index e225a1e3ff..5991e0e6e5 100755
@@ -285,6 +285,16 @@ then
   error_exit "main directory cannot contain spaces nor colons"
 fi
 
+canon_build_path=$(realpath -- "$PWD")
+canon_source_path=$(realpath -- "$source_path")
+
+in_srcdir=no
+if [ "$canon_build_path" = "$canon_source_path" ]
+then
+    in_srcdir=yes
+fi
+
+
 # default parameters
 cpu=""
 iasl="iasl"

configure if test "$supported_os" = "no"; then · line 6814

Quoted 6 lines
configure +3 -0
@@ -6799,6 +6809,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"

I don't like shouted warnings, but it's consistent with what we have.

Quoted 7 lines
configure +7 -0
+    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

configure if test "$supported_os" = "no"; then · line 6831

Quoted 10 lines
configure +7 -0
+    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

Output is suboptimal because we run $source_path/tests/tcg/configure.sh after emitting warnings, and it's chatty:

[...]
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 podman

NOTE: guest cross-compilers enabled: cc cc

Not this patch's fault.

#3 lore raw
In reply to Peter Maydell
Quoted 22 lines · Peter Maydell
Quoted 12 lines · Eric Blake

configure if test "$supported_os" = "no"; then · line 6820

Quoted 9 lines · Daniel P. Berrangé
configure +9 -0
+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:"
Quoted 8 lines

Per Kevin's response, we may want to tweak this wording slightly; maybe:

Support for running the 'configure' script directly from the source directory is deprecated. In-tree builds are not covered by automated testing and are liable to break without warning. Future releases may change the default location of built executables for an in-tree build, or drop in-tree build support altogether. Users are strongly recommended to switch to a separate build directory:

Quoted 10 lines

I now feel that, given that we've had various people say they want to retain at least the basic in-tree build commands and are willing to put in a wrapper to make it keep working, that this deprecation wording is a bit strong. I don't think that it much serves our users to say "this will go away" and then implement the compatibility wrapper -- we've caused them to unnecessarily change what they're doing, and then reduced the value of the compat-wrapper work we do. A more gently phrased note that we recommend use of out-of-tree builds would be sufficient I think.

Ok, i'll resend with a simpler warning message which tries to avoid fortelling the future and just focuses on today.

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 :|
#5 lore raw
In reply to Markus Armbruster
Quoted 12 lines · Markus Armbruster
Quoted 9 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.

---

Quoted 5 lines

configure if test "$supported_os" = "no"; then · line 6814

Quoted 3 lines
configure +3 -0
+if test "$in_srcdir" = "yes"; then
+    echo
+    echo "WARNING: SUPPORT FOR IN SOURCE DIR BUILDS IS DEPRECATED"

I don't like shouted warnings, but it's consistent with what we have.

The grammar is also a bit awkward to parse; maybe:

support for building in the source directory is deprecated

Signature · 3 lines
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org