1. Patchew
  2. QEMU
  3. View series

[PATCH v2] configure: warn if not using a separate build directory

Daniel P. Berrangé posted 1 patch 4 years ago
Test docker-quick@centos7 passed
Test docker-mingw@fedora passed
Test FreeBSD passed
Test checkpatch passed
Test asan passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20200331155158.381585-1-berrange@redhat.com
There is a newer version of this series
configure | 27 +++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
[PATCH v2] configure: warn if not using a separate build directory
Posted by Daniel P. Berrangé 4 years ago 
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é <berrange@redhat.com>
---

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(+)

diff --git a/configure b/configure
index e225a1e3ff..5991e0e6e5 100755
--- a/configure
+++ b/configure
@@ -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 qemu-devel@nongnu.org."
 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
-- 
2.24.1
Re: [PATCH v2] configure: warn if not using a separate build directory
Posted by Eric Blake 4 years ago 
On 3/31/20 10:51 AM, Daniel P. Berrangé wrote:
> 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é <berrange@redhat.com>
> ---
> 
> Changed in v2:
> 
>   - Use existing $source_path variable (Eric)

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

>   - 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(+)
> 
> diff --git a/configure b/configure
> index e225a1e3ff..5991e0e6e5 100755
> --- a/configure
> +++ b/configure
> @@ -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

This part is good.

> +
> +
>   # default parameters
>   cpu=""
>   iasl="iasl"
> @@ -6799,6 +6809,23 @@ if test "$supported_os" = "no"; then
>       echo "us upstream at qemu-devel@nongnu.org."
>   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:"

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:

> +    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,
Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org
Re: [PATCH v2] configure: warn if not using a separate build directory
Posted by Peter Maydell 4 years ago 
On Tue, 31 Mar 2020 at 17:05, Eric Blake <eblake@redhat.com> wrote:
>
> On 3/31/20 10:51 AM, Daniel P. Berrangé wrote:
> > +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:

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
Re: [PATCH v2] configure: warn if not using a separate build directory
Posted by Daniel P. Berrangé 4 years ago 
On Tue, Mar 31, 2020 at 05:12:35PM +0100, Peter Maydell wrote:
> On Tue, 31 Mar 2020 at 17:05, Eric Blake <eblake@redhat.com> wrote:
> >
> > On 3/31/20 10:51 AM, Daniel P. Berrangé wrote:
> > > +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:
> 
> 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
-- 
|: 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 :|
Re: [PATCH v2] configure: warn if not using a separate build directory
Posted by Markus Armbruster 4 years ago 
Daniel P. Berrangé <berrange@redhat.com> writes:

> 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é <berrange@redhat.com>
> ---
>
> 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(+)
>
> diff --git a/configure b/configure
> index e225a1e3ff..5991e0e6e5 100755
> --- a/configure
> +++ b/configure
> @@ -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 qemu-devel@nongnu.org."
>  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.

> +    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

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.

Reviewed-by: Markus Armbruster <armbru@redhat.com>
Re: [PATCH v2] configure: warn if not using a separate build directory
Posted by Eric Blake 4 years ago 
On 3/31/20 11:16 AM, Markus Armbruster wrote:
> Daniel P. Berrangé <berrange@redhat.com> writes:
> 
>> 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é <berrange@redhat.com>
>> ---
>>

>> +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

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

Patchew 2.1-devel-0870f84

© 2016 - 2024 Red Hat, Inc.