From: Eric Blake <eblake@redhat.com>
Date: Wed, 18 Jul 2012 20:53:24 +0000 (-0600)
Subject: doc: mention trap pitfalls
X-Git-Tag: v2.69b~220
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=45737f00b02eb455bc754e9b359fa192b9979786;p=thirdparty%2Fautoconf.git

doc: mention trap pitfalls

Document why the previous patch was useful.

* doc/autoconf.texi (Limitations of Builtins) <trap>: Mention the
need to be defensive in trap handlers.
---

diff --git a/doc/autoconf.texi b/doc/autoconf.texi
index 506d9667..927921c4 100644
--- a/doc/autoconf.texi
+++ b/doc/autoconf.texi
@@ -18346,6 +18346,18 @@ $ @kbd{bash-2.05b -c 'trap ":; /bin/true" 0; exit 2'; echo $?}
 2
 @end example
 
+Be aware that a trap can be called from any number of places in your
+script, and therefore the trap handler should not make assumptions about
+shell state.  For some examples, if your script temporarily modifies
+@env{IFS}, then the trap should include an initialization back to its
+typical value of space-tab-newline (autoconf does this for generated
+@file{configure} files).  Likewise, if your script changes the current
+working directory at some point after the trap is installed, then your
+trap cannot assume which directory it is in, and should begin by
+changing directories to an absolute path if that is important to the
+cleanup efforts (autotest does this for generated @file{testsuite}
+files).
+
 @item @command{true}
 @c -----------------
 @prindex @command{true}