Skip to contentSkip to conversation

Optimized print_help()

PATCH In review Pavel Roskin 3 participants 5 messages Jun 15, 2016

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Optimized print_help()

Hello!

print_help() in cg-Xlib should not be calling "which" 3 times. It's an external command. The patch caches the result in a local variable.

cg-Xlib +4 -3
@@ -130,10 +130,11 @@ update_index () {
 
 
 print_help () {
-	which "cg-$1" >/dev/null 2>&1 || exit 1
-	sed -n '/^USAGE=/,0s/.*"\(.*\)"/Usage: \1/p' < $(which cg-$1) 
+	local toolpath=$(which cg-$1 2>/dev/null)
+	[ -z "$toolpath" ] && exit 1
+	sed -n '/^USAGE=/,0s/.*"\(.*\)"/Usage: \1/p' < $toolpath
 	echo
-	cat $(which cg-$1) | sed -n '3,/^$/s/^# *//p'
+	cat $toolpath | sed -n '3,/^$/s/^# *//p'
 	exit
 }
 
Signature · 2 lines
Regards,
Pavel Roskin
#1 lore raw

Pavel Roskin <[email protected]> wrote Tue, Jun 14, 2005:

Quoted 11 lines

Hello!

print_help() in cg-Xlib should not be calling "which" 3 times. It's an external command. The patch caches the result in a local variable.

cg-Xlib update_index () { · line 135

Quoted 8 lines
cg-Xlib +3 -2
@@ -130,10 +130,11 @@ update_index () {
 
 
 print_help () {
-	which "cg-$1" >/dev/null 2>&1 || exit 1
-	sed -n '/^USAGE=/,0s/.*"\(.*\)"/Usage: \1/p' < $(which cg-$1) 
+	local toolpath=$(which cg-$1 2>/dev/null)
+	[ -z "$toolpath" ] && exit 1
+	sed -n '/^USAGE=/,0s/.*"\(.*\)"/Usage: \1/p' < $toolpath

Shouldn't $toolpath be quoted here to make it safer? Although it seems the make install don't handle irregular toolpaths at the moment.

cg-Xlib update_index () { · line 137

Quoted 3 lines
cg-Xlib +1 -1
 	echo
-	cat $(which cg-$1) | sed -n '3,/^$/s/^# *//p'
+	cat $toolpath | sed -n '3,/^$/s/^# *//p'

What about also removing UUOC from this line ...

	sed -n '3,/^$/s/^# *//p' < "$toolpath"
Quoted 2 lines
cg-Xlib +0 -0
 	exit
 }
Signature · 1 line
Jonas Fonseca
#2 lore raw
Quoted 2 lines · Jonas Fonseca

Shouldn't $toolpath be quoted here to make it safer? Although it seems the make install don't handle irregular toolpaths at the moment.

Sure.

Quoted 3 lines

Review

Quoted 1 line
(quoted diff) +1 -0
+	cat $toolpath | sed -n '3,/^$/s/^# *//p'

What about also removing UUOC from this line ...

UUOC? I had too look it up :-)

It's not just "useless use of cat", but also useless use of redirection in both cases. I guess sed can exit after it finishes processing the range (I don't know if it actually does), so feeding it the whole file is not need.

OK, here's an improved patch.

cg-Xlib +4 -3
@@ -130,10 +130,11 @@ update_index () {
 
 
 print_help () {
-	which "cg-$1" >/dev/null 2>&1 || exit 1
-	sed -n '/^USAGE=/,0s/.*"\(.*\)"/Usage: \1/p' < $(which cg-$1) 
+	local toolpath=$(which cg-$1 2>/dev/null)
+	[ -z "$toolpath" ] && exit 1
+	sed -n '/^USAGE=/,0s/.*"\(.*\)"/Usage: \1/p' "$toolpath"
 	echo
-	cat $(which cg-$1) | sed -n '3,/^$/s/^# *//p'
+	sed -n '3,/^$/s/^# *//p' "$toolpath"
 	exit
 }
 

P.S. Maybe we could use "type" rather than "which" because the former is a shell built-in. Or maybe we should hardcode the prefix on install. Anyway, it's out of scope of this patch.

P.P.S. I hope that $toolpath doesn't start with "-". I could add "--" to the sed command line, but I'm not sure if BSD sed would like it.

Signature · 2 lines
Regards,
Pavel Roskin
#3 lore raw
Quoted 11 lines · Pavel Roskin
Quoted 3 lines

Review

Quoted 1 line
(quoted diff) +1 -0
+	cat $toolpath | sed -n '3,/^$/s/^# *//p'

What about also removing UUOC from this line ...

UUOC? I had too look it up :-)

It's not just "useless use of cat", but also useless use of redirection in both cases. I guess sed can exit after it finishes processing the range (I don't know if it actually does), so feeding it the whole file is not need.

It doesn't matter if the shell opens the file or if sed does it itself, sed's ability to close the file and quit when done doesn't depend on that. So this call is equivalent and has the advantage of being resistant against filenames starting with a "-":

sed -n '3,/^$/s/^# *//p' <"$toolpath"

Rene

#4 lore raw

Hello, Rene!

Quoted 3 lines · Rene Scharfe

It doesn't matter if the shell opens the file or if sed does it itself, sed's ability to close the file and quit when done doesn't depend on that.

I checked sed 4.1.4 and found following:

1) sed won't close stdin ever, but it will close files specified on the command line.

2) sed will exit when told to do so by a command such as "q", and it won't read the reminder of the file, whether it's stdin or not.

3) sed has code that makes it exit after it has processed all address ranges and the "-n" option is used. However, this feature is buggy and disabled by default (see EXPERIMENTAL_DASH_N_OPTIMIZATION). It may be enabled in the future versions.

In other words, you are correct (except the part about closing the file).

Quoted 4 lines

So this call is equivalent and has the advantage of being
resistant against filenames starting with a "-":

   sed -n '3,/^$/s/^# *//p' <"$toolpath"

OK. Here's the third version of the patch.

cg-Xlib +4 -3
@@ -130,10 +130,11 @@ update_index () {
 
 
 print_help () {
-	which "cg-$1" >/dev/null 2>&1 || exit 1
-	sed -n '/^USAGE=/,0s/.*"\(.*\)"/Usage: \1/p' < $(which cg-$1) 
+	local toolpath=$(which cg-$1 2>/dev/null)
+	[ -z "$toolpath" ] && exit 1
+	sed -n '/^USAGE=/,0s/.*"\(.*\)"/Usage: \1/p' <"$toolpath"
 	echo
-	cat $(which cg-$1) | sed -n '3,/^$/s/^# *//p'
+	sed -n '3,/^$/s/^# *//p' <"$toolpath"
 	exit
 }
 
Signature · 2 lines
Regards,
Pavel Roskin