Patchwork Makefile: Forbid out-of-tree build from a source tree that has been built in

login
register
mail settings
Submitter Peter Maydell
Date Oct. 19, 2012, 1:54 p.m.
Message ID <1350654863-26048-1-git-send-email-peter.maydell@linaro.org>
Download mbox | patch
Permalink /patch/192706/
State New
Headers show

Comments

Peter Maydell - Oct. 19, 2012, 1:54 p.m.
If we try to do an out-of-tree build but the source tree we're building from
has been used in the past for an in-tree build then things will go
confusingly wrong. Specifically, some parts of the build process will pull
in generated files from the old in-tree build (because SRC_PATH is on
the vpath). Diagnose this situation so we can produce a useful error
message and tell the user how to fix it (run distclean in the source tree).

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
I got bitten by this again the other day so I figured it was worth
adding a molly-guard. The check is not perfect (it won't notice if
you did a distclean but didn't delete the *-softmmu &c directories,
for instance) but it should catch most cases of this user error.

 Makefile |   11 +++++++++++
 1 file changed, 11 insertions(+)
Blue Swirl - Oct. 19, 2012, 5:57 p.m.
On Fri, Oct 19, 2012 at 1:54 PM, Peter Maydell <peter.maydell@linaro.org> wrote:
> If we try to do an out-of-tree build but the source tree we're building from
> has been used in the past for an in-tree build then things will go
> confusingly wrong. Specifically, some parts of the build process will pull
> in generated files from the old in-tree build (because SRC_PATH is on
> the vpath). Diagnose this situation so we can produce a useful error
> message and tell the user how to fix it (run distclean in the source tree).
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

OK, but maybe we should deprecate in-tree build and warn if it is detected.

> ---
> I got bitten by this again the other day so I figured it was worth
> adding a molly-guard. The check is not perfect (it won't notice if
> you did a distclean but didn't delete the *-softmmu &c directories,
> for instance) but it should catch most cases of this user error.
>
>  Makefile |   11 +++++++++++
>  1 file changed, 11 insertions(+)
>
> diff --git a/Makefile b/Makefile
> index a9c22bf..5094a08 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -8,6 +8,17 @@ ifneq ($(wildcard config-host.mak),)
>  # Put the all: rule here so that config-host.mak can contain dependencies.
>  all:
>  include config-host.mak
> +
> +# Check that we're not trying to do an out-of-tree build from
> +# a tree that's been used for an in-tree build.
> +ifneq ($(realpath $(SRC_PATH)),$(realpath .))
> +ifneq ($(wildcard $(SRC_PATH)/config-host.mak),)
> +$(error This is an out of tree build but your source tree ($(SRC_PATH)) \
> +seems to have been used for an in-tree build. You can fix this by running \
> +"make distclean && rm -rf *-linux-user *-softmmu" in your source tree)
> +endif
> +endif
> +
>  include $(SRC_PATH)/rules.mak
>  config-host.mak: $(SRC_PATH)/configure
>         @echo $@ is out-of-date, running configure
> --
> 1.7.9.5
>
>
Blue Swirl - Oct. 27, 2012, 4:54 p.m.
Thanks, applied.

On Fri, Oct 19, 2012 at 1:54 PM, Peter Maydell <peter.maydell@linaro.org> wrote:
> If we try to do an out-of-tree build but the source tree we're building from
> has been used in the past for an in-tree build then things will go
> confusingly wrong. Specifically, some parts of the build process will pull
> in generated files from the old in-tree build (because SRC_PATH is on
> the vpath). Diagnose this situation so we can produce a useful error
> message and tell the user how to fix it (run distclean in the source tree).
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> I got bitten by this again the other day so I figured it was worth
> adding a molly-guard. The check is not perfect (it won't notice if
> you did a distclean but didn't delete the *-softmmu &c directories,
> for instance) but it should catch most cases of this user error.
>
>  Makefile |   11 +++++++++++
>  1 file changed, 11 insertions(+)
>
> diff --git a/Makefile b/Makefile
> index a9c22bf..5094a08 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -8,6 +8,17 @@ ifneq ($(wildcard config-host.mak),)
>  # Put the all: rule here so that config-host.mak can contain dependencies.
>  all:
>  include config-host.mak
> +
> +# Check that we're not trying to do an out-of-tree build from
> +# a tree that's been used for an in-tree build.
> +ifneq ($(realpath $(SRC_PATH)),$(realpath .))
> +ifneq ($(wildcard $(SRC_PATH)/config-host.mak),)
> +$(error This is an out of tree build but your source tree ($(SRC_PATH)) \
> +seems to have been used for an in-tree build. You can fix this by running \
> +"make distclean && rm -rf *-linux-user *-softmmu" in your source tree)
> +endif
> +endif
> +
>  include $(SRC_PATH)/rules.mak
>  config-host.mak: $(SRC_PATH)/configure
>         @echo $@ is out-of-date, running configure
> --
> 1.7.9.5
>
>

Patch

diff --git a/Makefile b/Makefile
index a9c22bf..5094a08 100644
--- a/Makefile
+++ b/Makefile
@@ -8,6 +8,17 @@  ifneq ($(wildcard config-host.mak),)
 # Put the all: rule here so that config-host.mak can contain dependencies.
 all:
 include config-host.mak
+
+# Check that we're not trying to do an out-of-tree build from
+# a tree that's been used for an in-tree build.
+ifneq ($(realpath $(SRC_PATH)),$(realpath .))
+ifneq ($(wildcard $(SRC_PATH)/config-host.mak),)
+$(error This is an out of tree build but your source tree ($(SRC_PATH)) \
+seems to have been used for an in-tree build. You can fix this by running \
+"make distclean && rm -rf *-linux-user *-softmmu" in your source tree)
+endif
+endif
+
 include $(SRC_PATH)/rules.mak
 config-host.mak: $(SRC_PATH)/configure
 	@echo $@ is out-of-date, running configure