[PATCH -perfbook] utilities/autodate.sh: Fix potential hung-up on missing tcolorbox

[PATCH -perfbook] utilities/autodate.sh: Fix potential hung-up on missing tcolorbox

[Akira Yokosawa]

"kpsewhich tcolorbox.sty" can be empty if tcolorbox is not
available.

If this is the case, "grep" in `grep ProvidePackage | sed ...`
will wait forever.

Add an empty check in front of "grep" with exit code of 1.

Fixes: b2f19231bcc5 ("utilities/autodate.sh: Make newer tcolorbox behave as before")
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
---
 utilities/autodate.sh | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/utilities/autodate.sh b/utilities/autodate.sh
index 7bd7cbb8..2b9c1117 100644
--- a/utilities/autodate.sh
+++ b/utilities/autodate.sh
@@ -97,6 +97,13 @@ env printf '\\IfQqzBg{}{\\setboolean{qqzbg}{%s}}\n' $qqzbg
 
 # command for newer tcolorbox (4.40 or later) to have backward-compatible skips
 tcolorbox_sty=`kpsewhich tcolorbox.sty`
+
+if [ "$tcolorbox_sty" == "" ]
+then
+	echo "Error: package 'tcolorbox' not found. See See #9 in FAQ-BUILD.txt" >&2
+	exit 1
+fi
+
 tcbversion=`grep ProvidesPackage $tcolorbox_sty | sed -e 's/.*version \([0-9]\+\.[0-9]\+\).*/\1/g'`
 tcbold=4.39
 env printf '%% tcolorbox version: %s\n' $tcbversion
-- 
2.17.1

Re: [PATCH -perfbook] utilities/autodate.sh: Fix potential hung-up on missing tcolorbox

[Akira Yokosawa]

On Sun, 2 May 2021 20:40:42 +0900, Akira Yokosawa wrote:
> "kpsewhich tcolorbox.sty" can be empty if tcolorbox is not
> available.
> 
> If this is the case, "grep" in `grep ProvidePackage | sed ...`
> will wait forever.
> 
> Add an empty check in front of "grep" with exit code of 1.

Paul,

Please ignore this patch.
I'll respin soon.

Sorry for the noise.

-- Akira


> 
> Fixes: b2f19231bcc5 ("utilities/autodate.sh: Make newer tcolorbox behave as before")
> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
> ---
>  utilities/autodate.sh | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/utilities/autodate.sh b/utilities/autodate.sh
> index 7bd7cbb8..2b9c1117 100644
> --- a/utilities/autodate.sh
> +++ b/utilities/autodate.sh
> @@ -97,6 +97,13 @@ env printf '\\IfQqzBg{}{\\setboolean{qqzbg}{%s}}\n' $qqzbg
>  
>  # command for newer tcolorbox (4.40 or later) to have backward-compatible skips
>  tcolorbox_sty=`kpsewhich tcolorbox.sty`
> +
> +if [ "$tcolorbox_sty" == "" ]
> +then
> +	echo "Error: package 'tcolorbox' not found. See See #9 in FAQ-BUILD.txt" >&2
> +	exit 1
> +fi
> +
>  tcbversion=`grep ProvidesPackage $tcolorbox_sty | sed -e 's/.*version \([0-9]\+\.[0-9]\+\).*/\1/g'`
>  tcbold=4.39
>  env printf '%% tcolorbox version: %s\n' $tcbversion
> 

[PATCH -perfbook v2] utilities/autodate.sh: Fix potential hung-up on missing tcolorbox

[Akira Yokosawa]

"kpsewhich tcolorbox.sty" can be empty if tcolorbox is not
available.

If this is the case, "grep" in `grep ProvidePackage | sed ...`
will wait forever.

Add an empty check in front of "grep" with exit code of 1.

Fixes: b2f19231bcc5 ("utilities/autodate.sh: Make newer tcolorbox behave as before")
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
---
Change since v1:

o Fix string comparison operator of shell script ("=")

--
utilities/autodate.sh | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/utilities/autodate.sh b/utilities/autodate.sh
index 7bd7cbb8..acf3b051 100644
--- a/utilities/autodate.sh
+++ b/utilities/autodate.sh
@@ -97,6 +97,13 @@ env printf '\\IfQqzBg{}{\\setboolean{qqzbg}{%s}}\n' $qqzbg
 
 # command for newer tcolorbox (4.40 or later) to have backward-compatible skips
 tcolorbox_sty=`kpsewhich tcolorbox.sty`
+
+if [ "$tcolorbox_sty" = "" ]
+then
+	echo "Error: package 'tcolorbox' not found. See See #9 in FAQ-BUILD.txt" >&2
+	exit 1
+fi
+
 tcbversion=`grep ProvidesPackage $tcolorbox_sty | sed -e 's/.*version \([0-9]\+\.[0-9]\+\).*/\1/g'`
 tcbold=4.39
 env printf '%% tcolorbox version: %s\n' $tcbversion
-- 
2.17.1

[PATCH -perfbook v3] utilities/autodate.sh: Fix potential hung-up on missing tcolorbox

[Akira Yokosawa]

"kpsewhich tcolorbox.sty" can be empty if tcolorbox is not
available.

If this is the case, "grep" in `grep ProvidePackage | sed ...`
will wait forever.

Add an empty check in front of "grep" with exit code of 1.

Fixes: b2f19231bcc5 ("utilities/autodate.sh: Make newer tcolorbox behave as before")
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
---
Change since v2:

o Refer to #5 in FAQ-BUILD.txt, as tcolorbox is not a font package.

Change since v1:

o Fix string comparison operator of shell script ("=").

--
utilities/autodate.sh | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/utilities/autodate.sh b/utilities/autodate.sh
index 7bd7cbb8..7d00738f 100644
--- a/utilities/autodate.sh
+++ b/utilities/autodate.sh
@@ -97,6 +97,13 @@ env printf '\\IfQqzBg{}{\\setboolean{qqzbg}{%s}}\n' $qqzbg
 
 # command for newer tcolorbox (4.40 or later) to have backward-compatible skips
 tcolorbox_sty=`kpsewhich tcolorbox.sty`
+
+if [ "$tcolorbox_sty" = "" ]
+then
+	echo "Error: package 'tcolorbox' not found. See See #5 in FAQ-BUILD.txt" >&2
+	exit 1
+fi
+
 tcbversion=`grep ProvidesPackage $tcolorbox_sty | sed -e 's/.*version \([0-9]\+\.[0-9]\+\).*/\1/g'`
 tcbold=4.39
 env printf '%% tcolorbox version: %s\n' $tcbversion
-- 
2.17.1

Re: [PATCH -perfbook] utilities/autodate.sh: Fix potential hung-up on missing tcolorbox

[Paul E. McKenney]

On Sun, May 02, 2021 at 08:59:43PM +0900, Akira Yokosawa wrote:
> On Sun, 2 May 2021 20:40:42 +0900, Akira Yokosawa wrote:
> > "kpsewhich tcolorbox.sty" can be empty if tcolorbox is not
> > available.
> > 
> > If this is the case, "grep" in `grep ProvidePackage | sed ...`
> > will wait forever.
> > 
> > Add an empty check in front of "grep" with exit code of 1.
> 
> Paul,
> 
> Please ignore this patch.
> I'll respin soon.
> 
> Sorry for the noise.

Ignored, and no problem!  Been there, done that!  ;-)

							Thanx, Paul

> -- Akira
> 
> 
> > 
> > Fixes: b2f19231bcc5 ("utilities/autodate.sh: Make newer tcolorbox behave as before")
> > Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
> > ---
> >  utilities/autodate.sh | 7 +++++++
> >  1 file changed, 7 insertions(+)
> > 
> > diff --git a/utilities/autodate.sh b/utilities/autodate.sh
> > index 7bd7cbb8..2b9c1117 100644
> > --- a/utilities/autodate.sh
> > +++ b/utilities/autodate.sh
> > @@ -97,6 +97,13 @@ env printf '\\IfQqzBg{}{\\setboolean{qqzbg}{%s}}\n' $qqzbg
> >  
> >  # command for newer tcolorbox (4.40 or later) to have backward-compatible skips
> >  tcolorbox_sty=`kpsewhich tcolorbox.sty`
> > +
> > +if [ "$tcolorbox_sty" == "" ]
> > +then
> > +	echo "Error: package 'tcolorbox' not found. See See #9 in FAQ-BUILD.txt" >&2
> > +	exit 1
> > +fi
> > +
> >  tcbversion=`grep ProvidesPackage $tcolorbox_sty | sed -e 's/.*version \([0-9]\+\.[0-9]\+\).*/\1/g'`
> >  tcbold=4.39
> >  env printf '%% tcolorbox version: %s\n' $tcbversion
> > 

[PATCH -perfbook v4] utilities/autodate.sh: Fix potential hung-up on missing tcolorbox

[Akira Yokosawa]

"kpsewhich tcolorbox.sty" can be empty if tcolorbox is not
available.

If this is the case, "grep" in `grep ProvidePackage | sed ...`
will wait forever.

Add existence check of tcolorbox early in the script and error-exit.

To prevent empty autodate.tex from left behind, modify the behavior
of the script so that it doesn't rely on the redirection in Makefile.

Fixes: b2f19231bcc5 ("utilities/autodate.sh: Make newer tcolorbox behave as before")
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
---
Changes since v3:

o Fix typo of "See See" in the error message.
o Move existence check of tcolorbox to the beginning.
o Use redirection in the script, not in the Makefile

Change since v2:

o Refer to #5 in FAQ-BUILD.txt, as tcolorbox is not a font package.

Change since v1:

o Fix string comparison operator of shell script ("=").

--
 Makefile              |  2 +-
 utilities/autodate.sh | 24 ++++++++++++++++--------
 2 files changed, 17 insertions(+), 9 deletions(-)

diff --git a/Makefile b/Makefile
index dc6b68e0..b23a7096 100644
--- a/Makefile
+++ b/Makefile
@@ -234,7 +234,7 @@ endif
 autodate.tex: perfbook-lt.tex $(LATEXSOURCES) $(BIBSOURCES) \
     $(PDFTARGETS_OF_EPS) $(PDFTARGETS_OF_SVG) $(FCVSNIPPETS) $(FCVSNIPPETS_VIA_LTMS) \
     $(GITREFSTAGS) utilities/autodate.sh
-	sh utilities/autodate.sh >autodate.tex
+	sh utilities/autodate.sh
 
 perfbook_flat.tex: autodate.tex
 ifndef LATEXPAND
diff --git a/utilities/autodate.sh b/utilities/autodate.sh
index 7bd7cbb8..e33c254d 100644
--- a/utilities/autodate.sh
+++ b/utilities/autodate.sh
@@ -19,12 +19,21 @@
 # along with this program; if not, you can access it online at
 # http://www.gnu.org/licenses/gpl-2.0.html.
 #
-# Copyright (C) Akira Yokosawa, 2017--2020
+# Copyright (C) Akira Yokosawa, 2017--2021
 #
 # Authors: Akira Yokosawa <akiyks@gmail.com>
 
 export LC_TIME=C
 qqzbg="false"
+fn="autodate.tex"
+
+# check if we have tcolorbox
+tcolorbox_sty=`kpsewhich tcolorbox.sty`
+if [ "$tcolorbox_sty" = "" ]
+then
+	echo "Error: package 'tcolorbox' not found. See #5 in FAQ-BUILD.txt." >&2
+	exit 1
+fi
 
 # check if we are in git repository
 if ! test -e .git
@@ -90,17 +99,16 @@ then
 	release=`env printf '%s %s' '\\\\' "$release"`
 fi
 
-env printf '\\date{%s %s, %s %s %s}\n' $month $day $year "$release" $modified
-env printf '\\newcommand{\\commityear}{%s}\n' $year
-env printf '\\newcommand{\\commitid}{%s}\n' $commitid$modified
-env printf '\\IfQqzBg{}{\\setboolean{qqzbg}{%s}}\n' $qqzbg
+env printf '\\date{%s %s, %s %s %s}\n' $month $day $year "$release" $modified > $fn
+env printf '\\newcommand{\\commityear}{%s}\n' $year >> $fn
+env printf '\\newcommand{\\commitid}{%s}\n' $commitid$modified >> $fn
+env printf '\\IfQqzBg{}{\\setboolean{qqzbg}{%s}}\n' $qqzbg >> $fn
 
 # command for newer tcolorbox (4.40 or later) to have backward-compatible skips
-tcolorbox_sty=`kpsewhich tcolorbox.sty`
 tcbversion=`grep ProvidesPackage $tcolorbox_sty | sed -e 's/.*version \([0-9]\+\.[0-9]\+\).*/\1/g'`
 tcbold=4.39
-env printf '%% tcolorbox version: %s\n' $tcbversion
+env printf '%% tcolorbox version: %s\n' $tcbversion >> $fn
 if [ $(echo $tcbversion $tcbold | awk '{if ($1 > $2) print 1;}') ] ;
 then
-	env printf '\\tcbsetforeverylayer{autoparskip}\n';
+	env printf '\\tcbsetforeverylayer{autoparskip}\n' >> $fn
 fi
-- 
2.17.1

Re: [PATCH -perfbook] utilities/autodate.sh: Fix potential hung-up on missing tcolorbox

[Akira Yokosawa]

On Sun, 2 May 2021 09:38:40 -0700, Paul E. McKenney wrote:
> On Sun, May 02, 2021 at 08:59:43PM +0900, Akira Yokosawa wrote:
>> On Sun, 2 May 2021 20:40:42 +0900, Akira Yokosawa wrote:
>>> "kpsewhich tcolorbox.sty" can be empty if tcolorbox is not
>>> available.
>>>
>>> If this is the case, "grep" in `grep ProvidePackage | sed ...`
>>> will wait forever.
>>>
>>> Add an empty check in front of "grep" with exit code of 1.
>>
>> Paul,
>>
>> Please ignore this patch.
>> I'll respin soon.
>>
>> Sorry for the noise.
> 
> Ignored, and no problem!  Been there, done that!  ;-)

Patch v4 I just sent out should be good enough.
I'm afraid you don't have a handy environment to test the error path,
but I did uninstall texlive-tcolorbox on a Fedora container
and confirmed the error check works as expected.

        Thanks, Akira

> 
> 							Thanx, Paul
> 
>> -- Akira
>>
>>
>>>
>>> Fixes: b2f19231bcc5 ("utilities/autodate.sh: Make newer tcolorbox behave as before")
>>> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
>>> ---
>>>  utilities/autodate.sh | 7 +++++++
>>>  1 file changed, 7 insertions(+)
>>>
>>> diff --git a/utilities/autodate.sh b/utilities/autodate.sh
>>> index 7bd7cbb8..2b9c1117 100644
>>> --- a/utilities/autodate.sh
>>> +++ b/utilities/autodate.sh
>>> @@ -97,6 +97,13 @@ env printf '\\IfQqzBg{}{\\setboolean{qqzbg}{%s}}\n' $qqzbg
>>>  
>>>  # command for newer tcolorbox (4.40 or later) to have backward-compatible skips
>>>  tcolorbox_sty=`kpsewhich tcolorbox.sty`
>>> +
>>> +if [ "$tcolorbox_sty" == "" ]
>>> +then
>>> +	echo "Error: package 'tcolorbox' not found. See See #9 in FAQ-BUILD.txt" >&2
>>> +	exit 1
>>> +fi
>>> +
>>>  tcbversion=`grep ProvidesPackage $tcolorbox_sty | sed -e 's/.*version \([0-9]\+\.[0-9]\+\).*/\1/g'`
>>>  tcbold=4.39
>>>  env printf '%% tcolorbox version: %s\n' $tcbversion
>>>

Re: [PATCH -perfbook v4] utilities/autodate.sh: Fix potential hung-up on missing tcolorbox

[Paul E. McKenney]

On Mon, May 03, 2021 at 09:47:18AM +0900, Akira Yokosawa wrote:
> "kpsewhich tcolorbox.sty" can be empty if tcolorbox is not
> available.
> 
> If this is the case, "grep" in `grep ProvidePackage | sed ...`
> will wait forever.
> 
> Add existence check of tcolorbox early in the script and error-exit.
> 
> To prevent empty autodate.tex from left behind, modify the behavior
> of the script so that it doesn't rely on the redirection in Makefile.
> 
> Fixes: b2f19231bcc5 ("utilities/autodate.sh: Make newer tcolorbox behave as before")
> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>

Queued and pushed, thank you!

							Thanx, Paul

> ---
> Changes since v3:
> 
> o Fix typo of "See See" in the error message.
> o Move existence check of tcolorbox to the beginning.
> o Use redirection in the script, not in the Makefile
> 
> Change since v2:
> 
> o Refer to #5 in FAQ-BUILD.txt, as tcolorbox is not a font package.
> 
> Change since v1:
> 
> o Fix string comparison operator of shell script ("=").
> 
> --
>  Makefile              |  2 +-
>  utilities/autodate.sh | 24 ++++++++++++++++--------
>  2 files changed, 17 insertions(+), 9 deletions(-)
> 
> diff --git a/Makefile b/Makefile
> index dc6b68e0..b23a7096 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -234,7 +234,7 @@ endif
>  autodate.tex: perfbook-lt.tex $(LATEXSOURCES) $(BIBSOURCES) \
>      $(PDFTARGETS_OF_EPS) $(PDFTARGETS_OF_SVG) $(FCVSNIPPETS) $(FCVSNIPPETS_VIA_LTMS) \
>      $(GITREFSTAGS) utilities/autodate.sh
> -	sh utilities/autodate.sh >autodate.tex
> +	sh utilities/autodate.sh
>  
>  perfbook_flat.tex: autodate.tex
>  ifndef LATEXPAND
> diff --git a/utilities/autodate.sh b/utilities/autodate.sh
> index 7bd7cbb8..e33c254d 100644
> --- a/utilities/autodate.sh
> +++ b/utilities/autodate.sh
> @@ -19,12 +19,21 @@
>  # along with this program; if not, you can access it online at
>  # http://www.gnu.org/licenses/gpl-2.0.html.
>  #
> -# Copyright (C) Akira Yokosawa, 2017--2020
> +# Copyright (C) Akira Yokosawa, 2017--2021
>  #
>  # Authors: Akira Yokosawa <akiyks@gmail.com>
>  
>  export LC_TIME=C
>  qqzbg="false"
> +fn="autodate.tex"
> +
> +# check if we have tcolorbox
> +tcolorbox_sty=`kpsewhich tcolorbox.sty`
> +if [ "$tcolorbox_sty" = "" ]
> +then
> +	echo "Error: package 'tcolorbox' not found. See #5 in FAQ-BUILD.txt." >&2
> +	exit 1
> +fi
>  
>  # check if we are in git repository
>  if ! test -e .git
> @@ -90,17 +99,16 @@ then
>  	release=`env printf '%s %s' '\\\\' "$release"`
>  fi
>  
> -env printf '\\date{%s %s, %s %s %s}\n' $month $day $year "$release" $modified
> -env printf '\\newcommand{\\commityear}{%s}\n' $year
> -env printf '\\newcommand{\\commitid}{%s}\n' $commitid$modified
> -env printf '\\IfQqzBg{}{\\setboolean{qqzbg}{%s}}\n' $qqzbg
> +env printf '\\date{%s %s, %s %s %s}\n' $month $day $year "$release" $modified > $fn
> +env printf '\\newcommand{\\commityear}{%s}\n' $year >> $fn
> +env printf '\\newcommand{\\commitid}{%s}\n' $commitid$modified >> $fn
> +env printf '\\IfQqzBg{}{\\setboolean{qqzbg}{%s}}\n' $qqzbg >> $fn
>  
>  # command for newer tcolorbox (4.40 or later) to have backward-compatible skips
> -tcolorbox_sty=`kpsewhich tcolorbox.sty`
>  tcbversion=`grep ProvidesPackage $tcolorbox_sty | sed -e 's/.*version \([0-9]\+\.[0-9]\+\).*/\1/g'`
>  tcbold=4.39
> -env printf '%% tcolorbox version: %s\n' $tcbversion
> +env printf '%% tcolorbox version: %s\n' $tcbversion >> $fn
>  if [ $(echo $tcbversion $tcbold | awk '{if ($1 > $2) print 1;}') ] ;
>  then
> -	env printf '\\tcbsetforeverylayer{autoparskip}\n';
> +	env printf '\\tcbsetforeverylayer{autoparskip}\n' >> $fn
>  fi
> -- 
> 2.17.1
> 
>