| Message ID | 20201007194526.1778-1-luoyonggang@gmail.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [v8] scripts: Convert qemu-version.sh to qemu-version.py | expand |
Patchew URL: https://patchew.org/QEMU/20201007194526.1778-1-luoyonggang@gmail.com/ Hi, This series seems to have some coding style problems. See output below for more information: Type: series Message-id: 20201007194526.1778-1-luoyonggang@gmail.com Subject: [PATCH v8] scripts: Convert qemu-version.sh to qemu-version.py === TEST SCRIPT BEGIN === #!/bin/bash git rev-parse base > /dev/null || exit 0 git config --local diff.renamelimit 0 git config --local diff.renames True git config --local diff.algorithm histogram ./scripts/checkpatch.pl --mailback base.. === TEST SCRIPT END === Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384 From https://github.com/patchew-project/qemu * [new tag] patchew/20201007194526.1778-1-luoyonggang@gmail.com -> patchew/20201007194526.1778-1-luoyonggang@gmail.com Switched to a new branch 'test' f42b98d scripts: Convert qemu-version.sh to qemu-version.py === OUTPUT BEGIN === WARNING: added, moved or deleted file(s), does MAINTAINERS need updating? #34: new file mode 100644 ERROR: line over 90 characters #59: FILE: scripts/qemu-version.py:21: + match_expression = '--match=v\\*' if platform.system() == 'Windows' else '--match=v*' ERROR: line over 90 characters #61: FILE: scripts/qemu-version.py:23: + stdout=subprocess.PIPE, stderr=subprocess.DEVNULL, encoding='utf8', shell=False) total: 2 errors, 1 warnings, 43 lines checked Commit f42b98df7ca0 (scripts: Convert qemu-version.sh to qemu-version.py) has style problems, please review. If any of these errors are false positives report them to the maintainer, see CHECKPATCH in MAINTAINERS. === OUTPUT END === Test command exited with code: 1 The full log is available at http://patchew.org/logs/20201007194526.1778-1-luoyonggang@gmail.com/testing.checkpatch/?type=message. --- Email generated automatically by Patchew [https://patchew.org/]. Please send your feedback to patchew-devel@redhat.com
Il mer 7 ott 2020, 21:46 Yonggang Luo <luoyonggang@gmail.com> ha scritto: > The sh script are harder to maintain for compatible different > xsh environment so convert it to python script > Also incorporate the fixes in > > https://patchew.org/QEMU/20200929143654.518157-1-marcandre.lureau@redhat.com/ > Using --match=v* instead of --match 'v*' for speed up the git version > And using --match=v\\* to resolve wildcard problem on windows. > Tested under Ubuntu/msys2/mingw. > Sorry but no, this is hideous. We need to keep in mind the maintainability and this is the opposite of a maintainable solution. It seems that subprocess (with shell=false, which I agree would be the right setting for this task) is not always an appropriate implementation when cross platform compatibility is required. Paolo > Signed-off-by: Yonggang Luo <luoyonggang@gmail.com> > Message-Id: <20201006112139.700-1-luoyonggang@gmail.com> > Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> > --- > meson.build | 2 +- > scripts/qemu-version.py | 35 +++++++++++++++++++++++++++++++++++ > scripts/qemu-version.sh | 25 ------------------------- > 3 files changed, 36 insertions(+), 26 deletions(-) > create mode 100644 scripts/qemu-version.py > delete mode 100755 scripts/qemu-version.sh > > diff --git a/meson.build b/meson.build > index 26230614ba..1d3bb25bc6 100644 > --- a/meson.build > +++ b/meson.build > @@ -1132,7 +1132,7 @@ tracetool = [ > '--backend=' + config_host['TRACE_BACKENDS'] > ] > > -qemu_version_cmd = [find_program('scripts/qemu-version.sh'), > +qemu_version_cmd = [find_program('scripts/qemu-version.py'), > meson.current_source_dir(), > config_host['PKGVERSION'], meson.project_version()] > qemu_version = custom_target('qemu-version.h', > diff --git a/scripts/qemu-version.py b/scripts/qemu-version.py > new file mode 100644 > index 0000000000..3f24c44e8a > --- /dev/null > +++ b/scripts/qemu-version.py > @@ -0,0 +1,35 @@ > +#!/usr/bin/env python3 > + > +# > +# Script for retrieve qemu git version information > +# > +# Authors: > +# Yonggang Luo <luoyonggang@gmail.com> > +# > +# This work is licensed under the terms of the GNU GPL, version 2 > +# or, at your option, any later version. See the COPYING file in > +# the top-level directory. > + > +import sys > +import subprocess > +import os, os.path > +import platform > + > +def main(_program, dir, pkgversion, version, *unused): > + os.chdir(dir) > + if not pkgversion and os.path.exists('.git'): > + match_expression = '--match=v\\*' if platform.system() == > 'Windows' else '--match=v*' > + pc = subprocess.run(['git', 'describe', match_expression, > '--always'], > + stdout=subprocess.PIPE, > stderr=subprocess.DEVNULL, encoding='utf8', shell=False) > + if pc.returncode == 0: > + pkgversion = pc.stdout.strip() > + > + fullversion = version > + if pkgversion: > + fullversion = "{} ({})".format(version, pkgversion) > + > + print('#define QEMU_PKGVERSION "%s"' % pkgversion) > + print('#define QEMU_FULL_VERSION "%s"' % fullversion) > + > +if __name__ == "__main__": > + main(*sys.argv) > diff --git a/scripts/qemu-version.sh b/scripts/qemu-version.sh > deleted file mode 100755 > index 03128c56a2..0000000000 > --- a/scripts/qemu-version.sh > +++ /dev/null > @@ -1,25 +0,0 @@ > -#!/bin/sh > - > -set -eu > - > -dir="$1" > -pkgversion="$2" > -version="$3" > - > -if [ -z "$pkgversion" ]; then > - cd "$dir" > - if [ -e .git ]; then > - pkgversion=$(git describe --match 'v*' --dirty | echo "") > - fi > -fi > - > -if [ -n "$pkgversion" ]; then > - fullversion="$version ($pkgversion)" > -else > - fullversion="$version" > -fi > - > -cat <<EOF > -#define QEMU_PKGVERSION "$pkgversion" > -#define QEMU_FULL_VERSION "$fullversion" > -EOF > -- > 2.28.0.windows.1 > > <div dir="auto"><div><div class="gmail_quote"><div dir="ltr" class="gmail_attr">Il mer 7 ott 2020, 21:46 Yonggang Luo <<a href="mailto:luoyonggang@gmail.com">luoyonggang@gmail.com</a>> ha scritto:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">The sh script are harder to maintain for compatible different<br> xsh environment so convert it to python script<br> Also incorporate the fixes in<br> <a href="https://patchew.org/QEMU/20200929143654.518157-1-marcandre.lureau@redhat.com/" rel="noreferrer noreferrer" target="_blank">https://patchew.org/QEMU/20200929143654.518157-1-marcandre.lureau@redhat.com/</a><br> Using --match=v* instead of --match 'v*' for speed up the git version<br> And using --match=v\\* to resolve wildcard problem on windows.<br> Tested under Ubuntu/msys2/mingw.<br></blockquote></div></div><div dir="auto"><br></div><div dir="auto">Sorry but no, this is hideous.</div><div dir="auto"><br></div><div dir="auto">We need to keep in mind the maintainability and this is the opposite of a maintainable solution. It seems that subprocess (with shell=false, which I agree would be the right setting for this task) is not always an appropriate implementation when cross platform compatibility is required.</div><div dir="auto"><br></div><div dir="auto">Paolo</div><div dir="auto"><br></div><div dir="auto"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"> <br> Signed-off-by: Yonggang Luo <<a href="mailto:luoyonggang@gmail.com" target="_blank" rel="noreferrer">luoyonggang@gmail.com</a>><br> Message-Id: <<a href="mailto:20201006112139.700-1-luoyonggang@gmail.com" target="_blank" rel="noreferrer">20201006112139.700-1-luoyonggang@gmail.com</a>><br> Signed-off-by: Paolo Bonzini <<a href="mailto:pbonzini@redhat.com" target="_blank" rel="noreferrer">pbonzini@redhat.com</a>><br> ---<br> meson.build | 2 +-<br> scripts/qemu-version.py | 35 +++++++++++++++++++++++++++++++++++<br> scripts/qemu-version.sh | 25 -------------------------<br> 3 files changed, 36 insertions(+), 26 deletions(-)<br> create mode 100644 scripts/qemu-version.py<br> delete mode 100755 scripts/qemu-version.sh<br> <br> diff --git a/meson.build b/meson.build<br> index 26230614ba..1d3bb25bc6 100644<br> --- a/meson.build<br> +++ b/meson.build<br> @@ -1132,7 +1132,7 @@ tracetool = [<br> '--backend=' + config_host['TRACE_BACKENDS']<br> ]<br> <br> -qemu_version_cmd = [find_program('scripts/qemu-version.sh'),<br> +qemu_version_cmd = [find_program('scripts/qemu-version.py'),<br> meson.current_source_dir(),<br> config_host['PKGVERSION'], meson.project_version()]<br> qemu_version = custom_target('qemu-version.h',<br> diff --git a/scripts/qemu-version.py b/scripts/qemu-version.py<br> new file mode 100644<br> index 0000000000..3f24c44e8a<br> --- /dev/null<br> +++ b/scripts/qemu-version.py<br> @@ -0,0 +1,35 @@<br> +#!/usr/bin/env python3<br> +<br> +#<br> +# Script for retrieve qemu git version information<br> +#<br> +# Authors:<br> +# Yonggang Luo <<a href="mailto:luoyonggang@gmail.com" target="_blank" rel="noreferrer">luoyonggang@gmail.com</a>><br> +#<br> +# This work is licensed under the terms of the GNU GPL, version 2<br> +# or, at your option, any later version. See the COPYING file in<br> +# the top-level directory.<br> +<br> +import sys<br> +import subprocess<br> +import os, os.path<br> +import platform<br> +<br> +def main(_program, dir, pkgversion, version, *unused):<br> + os.chdir(dir)<br> + if not pkgversion and os.path.exists('.git'):<br> + match_expression = '--match=v\\*' if platform.system() == 'Windows' else '--match=v*'<br> + pc = subprocess.run(['git', 'describe', match_expression, '--always'],<br> + stdout=subprocess.PIPE, stderr=subprocess.DEVNULL, encoding='utf8', shell=False)<br> + if pc.returncode == 0:<br> + pkgversion = pc.stdout.strip()<br> +<br> + fullversion = version<br> + if pkgversion:<br> + fullversion = "{} ({})".format(version, pkgversion)<br> +<br> + print('#define QEMU_PKGVERSION "%s"' % pkgversion)<br> + print('#define QEMU_FULL_VERSION "%s"' % fullversion)<br> +<br> +if __name__ == "__main__":<br> + main(*sys.argv)<br> diff --git a/scripts/qemu-version.sh b/scripts/qemu-version.sh<br> deleted file mode 100755<br> index 03128c56a2..0000000000<br> --- a/scripts/qemu-version.sh<br> +++ /dev/null<br> @@ -1,25 +0,0 @@<br> -#!/bin/sh<br> -<br> -set -eu<br> -<br> -dir="$1"<br> -pkgversion="$2"<br> -version="$3"<br> -<br> -if [ -z "$pkgversion" ]; then<br> - cd "$dir"<br> - if [ -e .git ]; then<br> - pkgversion=$(git describe --match 'v*' --dirty | echo "")<br> - fi<br> -fi<br> -<br> -if [ -n "$pkgversion" ]; then<br> - fullversion="$version ($pkgversion)"<br> -else<br> - fullversion="$version"<br> -fi<br> -<br> -cat <<EOF<br> -#define QEMU_PKGVERSION "$pkgversion"<br> -#define QEMU_FULL_VERSION "$fullversion"<br> -EOF<br> -- <br> 2.28.0.windows.1<br> <br> </blockquote></div></div></div>
diff --git a/meson.build b/meson.build index 26230614ba..1d3bb25bc6 100644 --- a/meson.build +++ b/meson.build @@ -1132,7 +1132,7 @@ tracetool = [ '--backend=' + config_host['TRACE_BACKENDS'] ] -qemu_version_cmd = [find_program('scripts/qemu-version.sh'), +qemu_version_cmd = [find_program('scripts/qemu-version.py'), meson.current_source_dir(), config_host['PKGVERSION'], meson.project_version()] qemu_version = custom_target('qemu-version.h', diff --git a/scripts/qemu-version.py b/scripts/qemu-version.py new file mode 100644 index 0000000000..3f24c44e8a --- /dev/null +++ b/scripts/qemu-version.py @@ -0,0 +1,35 @@ +#!/usr/bin/env python3 + +# +# Script for retrieve qemu git version information +# +# Authors: +# Yonggang Luo <luoyonggang@gmail.com> +# +# This work is licensed under the terms of the GNU GPL, version 2 +# or, at your option, any later version. See the COPYING file in +# the top-level directory. + +import sys +import subprocess +import os, os.path +import platform + +def main(_program, dir, pkgversion, version, *unused): + os.chdir(dir) + if not pkgversion and os.path.exists('.git'): + match_expression = '--match=v\\*' if platform.system() == 'Windows' else '--match=v*' + pc = subprocess.run(['git', 'describe', match_expression, '--always'], + stdout=subprocess.PIPE, stderr=subprocess.DEVNULL, encoding='utf8', shell=False) + if pc.returncode == 0: + pkgversion = pc.stdout.strip() + + fullversion = version + if pkgversion: + fullversion = "{} ({})".format(version, pkgversion) + + print('#define QEMU_PKGVERSION "%s"' % pkgversion) + print('#define QEMU_FULL_VERSION "%s"' % fullversion) + +if __name__ == "__main__": + main(*sys.argv) diff --git a/scripts/qemu-version.sh b/scripts/qemu-version.sh deleted file mode 100755 index 03128c56a2..0000000000 --- a/scripts/qemu-version.sh +++ /dev/null @@ -1,25 +0,0 @@ -#!/bin/sh - -set -eu - -dir="$1" -pkgversion="$2" -version="$3" - -if [ -z "$pkgversion" ]; then - cd "$dir" - if [ -e .git ]; then - pkgversion=$(git describe --match 'v*' --dirty | echo "") - fi -fi - -if [ -n "$pkgversion" ]; then - fullversion="$version ($pkgversion)" -else - fullversion="$version" -fi - -cat <<EOF -#define QEMU_PKGVERSION "$pkgversion" -#define QEMU_FULL_VERSION "$fullversion" -EOF