[Qemu-devel] [PATCH v2] configure: add sanity check to catch builds from "git archive"

[Qemu-devel] [PATCH v2] configure: add sanity check to catch builds from "git archive"

[Daniel P. Berrangé]

The "git archive" feature creates tarballs which are missing all
submodule content. GitHub unhelpfully provides users with "Download"
links that claim to give them valid source release tarballs. These
GitHub archives will not be buildable as they are created by the
"git archive" feature and so are missing content. The user gets
unhelpful messages from make such as:

  fatal error: ui/input-keymap-atset1-to-qcode.c: No such file or directory

By adding a sanity check we can give users an informative message about
what they've done wrong.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 configure | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/configure b/configure
index 0a19b033bc..089b00068c 100755
--- a/configure
+++ b/configure
@@ -296,6 +296,24 @@ then
 else
     git_update=no
     git_submodules=""
+
+    if ! test -f "$source_path/ui/keycodemapdb/README"
+    then
+        echo
+        echo "ERROR: missing file $source_path/ui/keycodemapdb/README"
+        echo
+        echo "This is not a GIT checkout but module content appears to"
+        echo "be missing. Do not use 'git archive' or GitHub download links"
+        echo "to acquire QEMU source archives. Non-GIT builds are only"
+        echo "supported with source archives linked from:"
+        echo
+        echo "  https://www.qemu.org/download/"
+        echo
+        echo "Developers working with GIT can use scripts/archive-source.sh"
+        echo "if they need to create valid source archives."
+        echo
+        exit 1
+    fi
 fi
 git="git"
 
-- 
2.14.3

Re: [Qemu-devel] [PATCH v2] configure: add sanity check to catch builds from "git archive"

[Cornelia Huck]

On Wed, 18 Apr 2018 18:11:51 +0100
Daniel P. Berrangé <berrange@redhat.com> wrote:

> The "git archive" feature creates tarballs which are missing all
> submodule content. GitHub unhelpfully provides users with "Download"
> links that claim to give them valid source release tarballs. These
> GitHub archives will not be buildable as they are created by the
> "git archive" feature and so are missing content. The user gets
> unhelpful messages from make such as:
> 
>   fatal error: ui/input-keymap-atset1-to-qcode.c: No such file or directory
> 
> By adding a sanity check we can give users an informative message about
> what they've done wrong.
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>  configure | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
> 
> diff --git a/configure b/configure
> index 0a19b033bc..089b00068c 100755
> --- a/configure
> +++ b/configure
> @@ -296,6 +296,24 @@ then
>  else
>      git_update=no
>      git_submodules=""
> +
> +    if ! test -f "$source_path/ui/keycodemapdb/README"
> +    then
> +        echo
> +        echo "ERROR: missing file $source_path/ui/keycodemapdb/README"
> +        echo
> +        echo "This is not a GIT checkout but module content appears to"
> +        echo "be missing. Do not use 'git archive' or GitHub download links"
> +        echo "to acquire QEMU source archives. Non-GIT builds are only"
> +        echo "supported with source archives linked from:"
> +        echo
> +        echo "  https://www.qemu.org/download/"
> +        echo
> +        echo "Developers working with GIT can use scripts/archive-source.sh"
> +        echo "if they need to create valid source archives."
> +        echo
> +        exit 1
> +    fi
>  fi
>  git="git"
>  

Reviewed-by: Cornelia Huck <cohuck@redhat.com>

Re: [Qemu-devel] [PATCH v2] configure: add sanity check to catch builds from "git archive"

[Philippe Mathieu-Daudé]

On 04/18/2018 02:11 PM, Daniel P. Berrangé wrote:
> The "git archive" feature creates tarballs which are missing all
> submodule content. GitHub unhelpfully provides users with "Download"
> links that claim to give them valid source release tarballs. These
> GitHub archives will not be buildable as they are created by the
> "git archive" feature and so are missing content. The user gets
> unhelpful messages from make such as:
> 
>   fatal error: ui/input-keymap-atset1-to-qcode.c: No such file or directory
> 
> By adding a sanity check we can give users an informative message about
> what they've done wrong.

tested with https://github.com/philmd/qemu/archive/github_notag.tar.gz

    github_notag$ ./configure

    ERROR: missing file ./ui/keycodemapdb/README

    This is not a GIT checkout but module content appears to
    be missing. Do not use 'git archive' or GitHub download links
    to acquire QEMU source archives. Non-GIT builds are only
    supported with source archives linked from:

     https://www.qemu.org/download/

    Developers working with GIT can use scripts/archive-source.sh
    if they need to create valid source archives.

> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>

Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Tested-by: Philippe Mathieu-Daudé <f4bug@amsat.org>

> ---
>  configure | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
> 
> diff --git a/configure b/configure
> index 0a19b033bc..089b00068c 100755
> --- a/configure
> +++ b/configure
> @@ -296,6 +296,24 @@ then
>  else
>      git_update=no
>      git_submodules=""
> +
> +    if ! test -f "$source_path/ui/keycodemapdb/README"
> +    then
> +        echo
> +        echo "ERROR: missing file $source_path/ui/keycodemapdb/README"
> +        echo
> +        echo "This is not a GIT checkout but module content appears to"
> +        echo "be missing. Do not use 'git archive' or GitHub download links"
> +        echo "to acquire QEMU source archives. Non-GIT builds are only"
> +        echo "supported with source archives linked from:"
> +        echo
> +        echo "  https://www.qemu.org/download/"
> +        echo
> +        echo "Developers working with GIT can use scripts/archive-source.sh"
> +        echo "if they need to create valid source archives."
> +        echo
> +        exit 1
> +    fi
>  fi
>  git="git"
>  
> 

Re: [Qemu-devel] [PATCH v2] configure: add sanity check to catch builds from "git archive"

[Daniel P. Berrangé]

Opps, forgot to CC Paolo on this patch for the "misc" queue.

On Wed, Apr 18, 2018 at 06:11:51PM +0100, Daniel P. Berrangé wrote:
> The "git archive" feature creates tarballs which are missing all
> submodule content. GitHub unhelpfully provides users with "Download"
> links that claim to give them valid source release tarballs. These
> GitHub archives will not be buildable as they are created by the
> "git archive" feature and so are missing content. The user gets
> unhelpful messages from make such as:
> 
>   fatal error: ui/input-keymap-atset1-to-qcode.c: No such file or directory
> 
> By adding a sanity check we can give users an informative message about
> what they've done wrong.
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>  configure | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
> 
> diff --git a/configure b/configure
> index 0a19b033bc..089b00068c 100755
> --- a/configure
> +++ b/configure
> @@ -296,6 +296,24 @@ then
>  else
>      git_update=no
>      git_submodules=""
> +
> +    if ! test -f "$source_path/ui/keycodemapdb/README"
> +    then
> +        echo
> +        echo "ERROR: missing file $source_path/ui/keycodemapdb/README"
> +        echo
> +        echo "This is not a GIT checkout but module content appears to"
> +        echo "be missing. Do not use 'git archive' or GitHub download links"
> +        echo "to acquire QEMU source archives. Non-GIT builds are only"
> +        echo "supported with source archives linked from:"
> +        echo
> +        echo "  https://www.qemu.org/download/"
> +        echo
> +        echo "Developers working with GIT can use scripts/archive-source.sh"
> +        echo "if they need to create valid source archives."
> +        echo
> +        exit 1
> +    fi
>  fi
>  git="git"
>  
> -- 
> 2.14.3
> 

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: [Qemu-devel] [PATCH v2] configure: add sanity check to catch builds from "git archive"

[Paolo Bonzini]

On 18/04/2018 19:11, Daniel P. Berrangé wrote:
> The "git archive" feature creates tarballs which are missing all
> submodule content. GitHub unhelpfully provides users with "Download"
> links that claim to give them valid source release tarballs. These
> GitHub archives will not be buildable as they are created by the
> "git archive" feature and so are missing content. The user gets
> unhelpful messages from make such as:
> 
>   fatal error: ui/input-keymap-atset1-to-qcode.c: No such file or directory
> 
> By adding a sanity check we can give users an informative message about
> what they've done wrong.
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>  configure | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
> 
> diff --git a/configure b/configure
> index 0a19b033bc..089b00068c 100755
> --- a/configure
> +++ b/configure
> @@ -296,6 +296,24 @@ then
>  else
>      git_update=no
>      git_submodules=""
> +
> +    if ! test -f "$source_path/ui/keycodemapdb/README"
> +    then
> +        echo
> +        echo "ERROR: missing file $source_path/ui/keycodemapdb/README"
> +        echo
> +        echo "This is not a GIT checkout but module content appears to"
> +        echo "be missing. Do not use 'git archive' or GitHub download links"
> +        echo "to acquire QEMU source archives. Non-GIT builds are only"
> +        echo "supported with source archives linked from:"
> +        echo
> +        echo "  https://www.qemu.org/download/"
> +        echo
> +        echo "Developers working with GIT can use scripts/archive-source.sh"
> +        echo "if they need to create valid source archives."
> +        echo
> +        exit 1
> +    fi
>  fi
>  git="git"
>  
> 

Queued, thanks.

Paolo