Skip to contentSkip to conversation

scripts/tags.sh: use `find` for $ALLSOURCE_ARCHS generation

PATCH Superseded Joey Pabalinas 2 participants 6 messages May 18, 2018 – May 22, 2018

v4 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 scripts/tags.sh: use `find` for $ALLSOURCE_ARCHS generation

Parsing ls is fragile at best and _will_ fail when $tree contains spaces. Replace this with a find-generated string and directly assign it to $ALLSOURCE_ARCHS; a subshell is implied by $(), so cd doesn't affect the current working directory.

 1 file changed, 1 insertion(+), 10 deletions(-)
scripts/tags.sh +1 -10
index 78e546ff689c2d5f40..c08347fdeef12a7621 100755
@@ -26,24 +26,15 @@ else
 fi
 
 # ignore userspace tools
 ignore="$ignore ( -path ${tree}tools ) -prune -o"
 
-# Find all available archs
-find_all_archs()
-{
-	ALLSOURCE_ARCHS=""
-	for arch in `ls ${tree}arch`; do
-		ALLSOURCE_ARCHS="${ALLSOURCE_ARCHS} "${arch##\/}
-	done
-}
-
 # Detect if ALLSOURCE_ARCHS is set. If not, we assume SRCARCH
 if [ "${ALLSOURCE_ARCHS}" = "" ]; then
 	ALLSOURCE_ARCHS=${SRCARCH}
 elif [ "${ALLSOURCE_ARCHS}" = "all" ]; then
-	find_all_archs
+	ALLSOURCE_ARCHS="$(find "${tree}arch/" -mindepth 1 -maxdepth 1 -type d -printf ' %f')"
 fi
 
 # find sources in arch/$ARCH
 find_arch_sources()
 {
Signature · 1 line
2.17.0.rc1.35.g90bbd502d54fe92035.dirty
#1 lore raw

Hi.

The commit log is wrong.

2018-05-18 20:56 GMT+09:00 Joey Pabalinas <[email protected]>:

Quoted 2 lines

Parsing ls is fragile at best and _will_ fail when $tree contains spaces.

This statement is wrong.

The cause of the problem is not using whatever command you use, but missing quoting.
The following would work even if $tree contains spaces:

    for arch in `ls "${tree}arch"`; do

BTW, what was your motivation of this patch?

Does ${tree} contain spaces?

If the file path contains spaces, the top Makefile terminates it earlier.

Makefile:128: *** main directory cannot contain spaces nor colons. Stop.

Quoted 4 lines

Replace this with a find-generated string
and directly assign it to $ALLSOURCE_ARCHS; a subshell is implied by $(), so cd doesn't affect the current working directory.

This patch no longer uses cd

Quoted 37 lines
 1 file changed, 1 insertion(+), 10 deletions(-)
scripts/tags.sh +1 -11
index 78e546ff689c2d5f40..c08347fdeef12a7621 100755
@@ -26,24 +26,15 @@ else
 fi
 
 # ignore userspace tools
 ignore="$ignore ( -path ${tree}tools ) -prune -o"
 
-# Find all available archs
-find_all_archs()
-{
-       ALLSOURCE_ARCHS=""
-       for arch in `ls ${tree}arch`; do
-               ALLSOURCE_ARCHS="${ALLSOURCE_ARCHS} "${arch##\/}
-       done
-}
-
 # Detect if ALLSOURCE_ARCHS is set. If not, we assume SRCARCH
 if [ "${ALLSOURCE_ARCHS}" = "" ]; then
        ALLSOURCE_ARCHS=${SRCARCH}
 elif [ "${ALLSOURCE_ARCHS}" = "all" ]; then
-       find_all_archs
+       ALLSOURCE_ARCHS="$(find "${tree}arch/" -mindepth 1 -maxdepth 1 -type d -printf ' %f')"
 fi
 
 # find sources in arch/$ARCH
 find_arch_sources()
 {
--

2.17.0.rc1.35.g90bbd502d54fe92035.dirty

Signature · 2 lines
Best Regards
Masahiro Yamada
#2 lore raw
Quoted 7 lines · Masahiro Yamada

The commit log is wrong.

2018-05-18 20:56 GMT+09:00 Joey Pabalinas <[email protected]>:

Quoted 2 lines

Parsing ls is fragile at best and _will_ fail when $tree contains spaces.

Quoted 7 lines

This statement is wrong.

The cause of the problem is not using whatever command you use, but missing quoting.
The following would work even if $tree contains spaces:

    for arch in `ls "${tree}arch"`; do

Ah, to be completely honest that case didn't even occur to me.

Quoted 8 lines

BTW, what was your motivation of this patch?

Does ${tree} contain spaces?

If the file path contains spaces, the top Makefile terminates it earlier.

Makefile:128: *** main directory cannot contain spaces nor colons. Stop.

It doesn't; I didn't realize the Makefile already had a guard against spaces in paths. It was something I noticed when poking at something else and I thought it might be something worth fixing.

But now I agree with you that this patch isn't really needed at all. I can no longer think of a case where even the original

Quoted 1 line

for arch in ls ${tree}arch; do

would break since spaces are not allowed at all.

Well, on the bright side, the times you happen to be wrong are also the times where you learn the most :)

Signature · 2 lines
Cheers,
Joey Pabalinas
#3 lore raw

2018-05-22 17:21 GMT+09:00 Joey Pabalinas <[email protected]>:

Quoted 34 lines · Masahiro Yamada
Quoted 7 lines

The commit log is wrong.

2018-05-18 20:56 GMT+09:00 Joey Pabalinas <[email protected]>:

Quoted 2 lines

Parsing ls is fragile at best and _will_ fail when $tree contains spaces.

Quoted 7 lines

This statement is wrong.

The cause of the problem is not using whatever command you use, but missing quoting.
The following would work even if $tree contains spaces:

    for arch in `ls "${tree}arch"`; do

Ah, to be completely honest that case didn't even occur to me.

Quoted 8 lines

BTW, what was your motivation of this patch?

Does ${tree} contain spaces?

If the file path contains spaces, the top Makefile terminates it earlier.

Makefile:128: *** main directory cannot contain spaces nor colons. Stop.

It doesn't; I didn't realize the Makefile already had a guard against spaces in paths. It was something I noticed when poking at something else and I thought it might be something worth fixing.

But now I agree with you that this patch isn't really needed at all. I can no longer think of a case where even the original

Quoted 7 lines
Quoted 1 line

for arch in ls ${tree}arch; do

would break since spaces are not allowed at all.

Well, on the bright side, the times you happen to be wrong are also the times where you learn the most :)

I see some new motivations for this patch now.

- The current code includes 'Kconfig' in ALLSOURCE_ARCHS, but it should not.

- Simplify the code, removing the find_all_archs().

If you are motivated for v5,
how about this?

- Remove the double-quotes from "${tree}arch/"
(Because the rest parts of this script do not have double-quoting,
I do not see point in adding it in this line only.)

- Update the git-log to not mention the hypothetical space things.

Signature · 2 lines
Best Regards
Masahiro Yamada
#4 lore raw
Quoted 8 lines · Masahiro Yamada

I see some new motivations for this patch now.

- The current code includes 'Kconfig' in ALLSOURCE_ARCHS, but it should not.

- Simplify the code, removing the find_all_archs().

Quoted 8 lines

If you are motivated for v5,
how about this?

- Remove the double-quotes from "${tree}arch/"
(Because the rest parts of this script do not have double-quoting,
I do not see point in adding it in this line only.)

- Update the git-log to not mention the hypothetical space things.

Alright, that sounds reasonable. What do you think of:

Quoted 1 line

ALLSOURCE_ARCHS=$(find ${tree}arch/ -mindepth 1 -maxdepth 1 -type d -printf '%f ')

The double quotes surrounding the arguments have been removed to be more consistent with the other find commands in the script.

The ' %f' was changed to '%f ' so that you don't get that weird leading space; I couldn't think of a way this could break anything but I wanted to be 100% sure instead of needing to make a v6, heh.

The commit message will definitely be fixed as well.

Signature · 2 lines
Cheers,
Joey Pabalinas
#5 lore raw

2018-05-22 18:06 GMT+09:00 Joey Pabalinas <[email protected]>:

Quoted 20 lines · Masahiro Yamada
Quoted 8 lines

I see some new motivations for this patch now.

- The current code includes 'Kconfig' in ALLSOURCE_ARCHS, but it should not.

- Simplify the code, removing the find_all_archs().

Quoted 8 lines

If you are motivated for v5,
how about this?

- Remove the double-quotes from "${tree}arch/"
(Because the rest parts of this script do not have double-quoting,
I do not see point in adding it in this line only.)

- Update the git-log to not mention the hypothetical space things.

Alright, that sounds reasonable. What do you think of:

Quoted 8 lines
Quoted 1 line

ALLSOURCE_ARCHS=$(find ${tree}arch/ -mindepth 1 -maxdepth 1 -type d -printf '%f ')

The double quotes surrounding the arguments have been removed to be more consistent with the other find commands in the script.

The ' %f' was changed to '%f ' so that you don't get that weird leading space; I couldn't think of a way this could break anything but I wanted to be 100% sure instead of needing to make a v6, heh.

Fine with me.

Signature · 2 lines
Best Regards
Masahiro Yamada