| Message ID | 2967c8ebb460934eb4aaaaebe5941bff643d4a94.1699609940.git.ps@pks.im (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Replace use of `test <expr> -o/a <expr>` | expand |
On Fri, Nov 10, 2023 at 11:01:15AM +0100, Patrick Steinhardt wrote: > diff --git a/t/valgrind/valgrind.sh b/t/valgrind/valgrind.sh > index 669ebaf68be..9fbf90cee7c 100755 > --- a/t/valgrind/valgrind.sh > +++ b/t/valgrind/valgrind.sh > @@ -23,7 +23,7 @@ memcheck) > VALGRIND_MAJOR=$(expr "$VALGRIND_VERSION" : '[^0-9]*\([0-9]*\)') > VALGRIND_MINOR=$(expr "$VALGRIND_VERSION" : '[^0-9]*[0-9]*\.\([0-9]*\)') > test 3 -gt "$VALGRIND_MAJOR" || > - test 3 -eq "$VALGRIND_MAJOR" -a 4 -gt "$VALGRIND_MINOR" || > + ( test 3 -eq "$VALGRIND_MAJOR" && test 4 -gt "$VALGRIND_MINOR" ) || > TOOL_OPTIONS="$TOOL_OPTIONS --track-origins=yes" I was surprised to see this one as a subshell after you adjusted the other. It probably isn't that big a deal either way, though (as a style thing I generally try to use braces unless I am relying on the separate environment provided by the subshell, but it's certainly not wrong in this case). -Peff
Patrick Steinhardt <ps@pks.im> writes: > Our coding guidelines say to not use `test` with `-a` and `-o` because > it can easily lead to bugs. Convert trivial cases where we still use > these to instead instead concatenate multiple invocations of `test` via > `&&` and `||`, respectively. > > While not all of the converted instances can cause ambiguity, it is > worth getting rid of all of them regardless: > > - It becomes easier to reason about the code as we do not have to > argue why one use of `-a`/`-o` is okay while another one isn't. > > - We don't encourage people to use these expressions. Thanks for these additional notes. Nicely done.
Jeff King <peff@peff.net> writes: > On Fri, Nov 10, 2023 at 11:01:15AM +0100, Patrick Steinhardt wrote: > >> diff --git a/t/valgrind/valgrind.sh b/t/valgrind/valgrind.sh >> index 669ebaf68be..9fbf90cee7c 100755 >> --- a/t/valgrind/valgrind.sh >> +++ b/t/valgrind/valgrind.sh >> @@ -23,7 +23,7 @@ memcheck) >> VALGRIND_MAJOR=$(expr "$VALGRIND_VERSION" : '[^0-9]*\([0-9]*\)') >> VALGRIND_MINOR=$(expr "$VALGRIND_VERSION" : '[^0-9]*[0-9]*\.\([0-9]*\)') >> test 3 -gt "$VALGRIND_MAJOR" || >> - test 3 -eq "$VALGRIND_MAJOR" -a 4 -gt "$VALGRIND_MINOR" || >> + ( test 3 -eq "$VALGRIND_MAJOR" && test 4 -gt "$VALGRIND_MINOR" ) || >> TOOL_OPTIONS="$TOOL_OPTIONS --track-origins=yes" > > I was surprised to see this one as a subshell after you adjusted the > other. ;-) I am not so surprised that this one was missed, though. I didn't point this one out during my review of the previous round, either, and not everybody is as careful as you are. Thanks, both.
Junio C Hamano <gitster@pobox.com> writes: > I am not so surprised that this one was missed, though. I didn't > point this one out during my review of the previous round, either, > and not everybody is as careful as you are. Ah, sorry, thist came out in a way I did not mean to. I didn't mean "I did not point it out explicitly. It is not surprising if a contributor who was not careful did not find it on their own and took initiative to fix it themselves". I meant "I failed to spot it myself hence I didn't point it out in my review---I was not being so careful to aim for thoroughly cover and find all the similar issues". In any case, I'll tweak it while queueing. Thanks for noticing. diff --git i/t/valgrind/valgrind.sh w/t/valgrind/valgrind.sh index 9fbf90cee7..3c8ee19975 100755 --- i/t/valgrind/valgrind.sh +++ w/t/valgrind/valgrind.sh @@ -23,7 +23,7 @@ memcheck) VALGRIND_MAJOR=$(expr "$VALGRIND_VERSION" : '[^0-9]*\([0-9]*\)') VALGRIND_MINOR=$(expr "$VALGRIND_VERSION" : '[^0-9]*[0-9]*\.\([0-9]*\)') test 3 -gt "$VALGRIND_MAJOR" || - ( test 3 -eq "$VALGRIND_MAJOR" && test 4 -gt "$VALGRIND_MINOR" ) || + { test 3 -eq "$VALGRIND_MAJOR" && test 4 -gt "$VALGRIND_MINOR"; } || TOOL_OPTIONS="$TOOL_OPTIONS --track-origins=yes" ;; *)
On Sat, Nov 11, 2023 at 09:20:04AM +0900, Junio C Hamano wrote: > Junio C Hamano <gitster@pobox.com> writes: > > > I am not so surprised that this one was missed, though. I didn't > > point this one out during my review of the previous round, either, > > and not everybody is as careful as you are. > > Ah, sorry, thist came out in a way I did not mean to. > > I didn't mean "I did not point it out explicitly. It is not > surprising if a contributor who was not careful did not find it on > their own and took initiative to fix it themselves". > > I meant "I failed to spot it myself hence I didn't point it out in > my review---I was not being so careful to aim for thoroughly cover > and find all the similar issues". > > In any case, I'll tweak it while queueing. Thanks for noticing. Thanks indeed, I missed this instance as well when I scanned for any additional subshells. Patrick > diff --git i/t/valgrind/valgrind.sh w/t/valgrind/valgrind.sh > index 9fbf90cee7..3c8ee19975 100755 > --- i/t/valgrind/valgrind.sh > +++ w/t/valgrind/valgrind.sh > @@ -23,7 +23,7 @@ memcheck) > VALGRIND_MAJOR=$(expr "$VALGRIND_VERSION" : '[^0-9]*\([0-9]*\)') > VALGRIND_MINOR=$(expr "$VALGRIND_VERSION" : '[^0-9]*[0-9]*\.\([0-9]*\)') > test 3 -gt "$VALGRIND_MAJOR" || > - ( test 3 -eq "$VALGRIND_MAJOR" && test 4 -gt "$VALGRIND_MINOR" ) || > + { test 3 -eq "$VALGRIND_MAJOR" && test 4 -gt "$VALGRIND_MINOR"; } || > TOOL_OPTIONS="$TOOL_OPTIONS --track-origins=yes" > ;; > *)
diff --git a/GIT-VERSION-GEN b/GIT-VERSION-GEN index e54492f8271..7246ab7c78c 100755 --- a/GIT-VERSION-GEN +++ b/GIT-VERSION-GEN @@ -11,7 +11,7 @@ LF=' if test -f version then VN=$(cat version) || VN="$DEF_VER" -elif test -d ${GIT_DIR:-.git} -o -f .git && +elif { test -d "${GIT_DIR:-.git}" || test -f .git; } && VN=$(git describe --match "v[0-9]*" HEAD 2>/dev/null) && case "$VN" in *$LF*) (exit 1) ;; diff --git a/configure.ac b/configure.ac index 276593cd9dd..d1a96da14eb 100644 --- a/configure.ac +++ b/configure.ac @@ -94,7 +94,7 @@ AC_DEFUN([GIT_PARSE_WITH_SET_MAKE_VAR], [AC_ARG_WITH([$1], [AS_HELP_STRING([--with-$1=VALUE], $3)], if test -n "$withval"; then - if test "$withval" = "yes" -o "$withval" = "no"; then + if test "$withval" = "yes" || test "$withval" = "no"; then AC_MSG_WARN([You likely do not want either 'yes' or 'no' as] [a value for $1 ($2). Maybe you do...?]) fi diff --git a/contrib/subtree/git-subtree.sh b/contrib/subtree/git-subtree.sh index e0c5d3b0de6..43b5fec7320 100755 --- a/contrib/subtree/git-subtree.sh +++ b/contrib/subtree/git-subtree.sh @@ -489,13 +489,13 @@ find_existing_splits () { ;; END) debug "Main is: '$main'" - if test -z "$main" -a -n "$sub" + if test -z "$main" && test -n "$sub" then # squash commits refer to a subtree debug " Squash: $sq from $sub" cache_set "$sq" "$sub" fi - if test -n "$main" -a -n "$sub" + if test -n "$main" && test -n "$sub" then debug " Prior: $main -> $sub" cache_set $main $sub diff --git a/t/perf/perf-lib.sh b/t/perf/perf-lib.sh index e7786775a90..b952e5024b4 100644 --- a/t/perf/perf-lib.sh +++ b/t/perf/perf-lib.sh @@ -31,7 +31,7 @@ unset GIT_CONFIG_NOSYSTEM GIT_CONFIG_SYSTEM="$TEST_DIRECTORY/perf/config" export GIT_CONFIG_SYSTEM -if test -n "$GIT_TEST_INSTALLED" -a -z "$PERF_SET_GIT_TEST_INSTALLED" +if test -n "$GIT_TEST_INSTALLED" && test -z "$PERF_SET_GIT_TEST_INSTALLED" then error "Do not use GIT_TEST_INSTALLED with the perf tests. diff --git a/t/perf/run b/t/perf/run index 34115edec35..486ead21980 100755 --- a/t/perf/run +++ b/t/perf/run @@ -91,10 +91,10 @@ set_git_test_installed () { run_dirs_helper () { mydir=${1%/} shift - while test $# -gt 0 -a "$1" != -- -a ! -f "$1"; do + while test $# -gt 0 && test "$1" != -- && test ! -f "$1"; do shift done - if test $# -gt 0 -a "$1" = --; then + if test $# -gt 0 && test "$1" = --; then shift fi @@ -124,7 +124,7 @@ run_dirs_helper () { } run_dirs () { - while test $# -gt 0 -a "$1" != -- -a ! -f "$1"; do + while test $# -gt 0 && test "$1" != -- && test ! -f "$1"; do run_dirs_helper "$@" shift done @@ -180,7 +180,8 @@ run_subsection () { GIT_PERF_AGGREGATING_LATER=t export GIT_PERF_AGGREGATING_LATER - if test $# = 0 -o "$1" = -- -o -f "$1"; then + if test $# = 0 || test "$1" = -- || test -f "$1" + then set -- . "$@" fi diff --git a/t/valgrind/valgrind.sh b/t/valgrind/valgrind.sh index 669ebaf68be..9fbf90cee7c 100755 --- a/t/valgrind/valgrind.sh +++ b/t/valgrind/valgrind.sh @@ -23,7 +23,7 @@ memcheck) VALGRIND_MAJOR=$(expr "$VALGRIND_VERSION" : '[^0-9]*\([0-9]*\)') VALGRIND_MINOR=$(expr "$VALGRIND_VERSION" : '[^0-9]*[0-9]*\.\([0-9]*\)') test 3 -gt "$VALGRIND_MAJOR" || - test 3 -eq "$VALGRIND_MAJOR" -a 4 -gt "$VALGRIND_MINOR" || + ( test 3 -eq "$VALGRIND_MAJOR" && test 4 -gt "$VALGRIND_MINOR" ) || TOOL_OPTIONS="$TOOL_OPTIONS --track-origins=yes" ;; *)
Our coding guidelines say to not use `test` with `-a` and `-o` because it can easily lead to bugs. Convert trivial cases where we still use these to instead instead concatenate multiple invocations of `test` via `&&` and `||`, respectively. While not all of the converted instances can cause ambiguity, it is worth getting rid of all of them regardless: - It becomes easier to reason about the code as we do not have to argue why one use of `-a`/`-o` is okay while another one isn't. - We don't encourage people to use these expressions. Signed-off-by: Patrick Steinhardt <ps@pks.im> --- GIT-VERSION-GEN | 2 +- configure.ac | 2 +- contrib/subtree/git-subtree.sh | 4 ++-- t/perf/perf-lib.sh | 2 +- t/perf/run | 9 +++++---- t/valgrind/valgrind.sh | 2 +- 6 files changed, 11 insertions(+), 10 deletions(-)