[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

another batch of minor doc patches

From: Paul Eggert
Subject: another batch of minor doc patches
Date: Fri, 16 Jun 2006 13:38:51 -0700
User-agent: Gnus/5.1008 (Gnus v5.10.8) Emacs/21.4 (gnu/linux)

I installed this to accommodate the flurry of last-minute suggestions
and a few other VPATH/quoting problems I noticed (can't say I caught
them all....):

2006-06-16  Paul Eggert  <address@hidden>

        * doc/autoconf.texi:
        (Installation Directory Variables, Build Directories):
        (Automatic Remaking, Subdirectories, Fortran Compiler):
        (Making testsuite Scripts, Defining Directories):
        Quote variable usages better.
        (Installation Directory Variables): Fix table item font.
        Reword slightly to clarify.  Generalize advice about
        not using special characters to include all file-related
        vars, not just VPATH.
        (Special Chars in Variables): Warn about special characters in
        $(srcdir) too.
        (Assignments): Clarify default-value example as suggested by
        Ralf Wildenhues in
        (Special Shell Variables): Note leading ./ or ../, as suggested
        by Stepan Kasal.
        (Limitations of Builtins): Under cd, warn about CDPATH.
        (The Make Macro MAKEFLAGS): Untabify.  Problem reported by
        Ralf Wildenhues.

Index: doc/autoconf.texi
RCS file: /cvsroot/autoconf/autoconf/doc/autoconf.texi,v
retrieving revision 1.1050
diff -p -u -r1.1050 autoconf.texi
--- doc/autoconf.texi   16 Jun 2006 11:42:20 -0000      1.1050
+++ doc/autoconf.texi   16 Jun 2006 20:36:36 -0000
@@ -2577,7 +2577,7 @@ edit = sed \
 autoheader autom4te: Makefile
         rm -f $@@ $@@.tmp
-        $(edit) $(srcdir)/$ >$@@.tmp
+        $(edit) '$(srcdir)/$' >$@@.tmp
         chmod +x $@@.tmp
         chmod a-w $@@.tmp
         mv $@@.tmp $@@
@@ -2591,31 +2591,38 @@ autom4te: $(srcdir)/
 Some details are noteworthy:
address@hidden @samp
address@hidden @@datadir[@@]
address@hidden @asis
address@hidden @samp{@@datadir[@@]}
 The brackets prevent @command{configure} from replacing
 @samp{@@datadir@@} in the Sed expression itself.
 Brackets are preferable to a backslash here, since
 Posix says @samp{\@@} is not portable.
address@hidden $(pkgdatadir)
address@hidden @samp{$(pkgdatadir)}
 Don't use @samp{@@pkgdatadir@@}!  Use the matching makefile variable
address@hidden ,
-Don't use @samp{/} in the Sed expression(s) since most likely the
address@hidden @samp{/}
+Don't use @samp{/} in the Sed expressions that replace file names since
+most likely the
 variables you use, such as @samp{$(pkgdatadir)}, contain @samp{/}.
+Use a shell metacharacter instead, such as @samp{|}.
address@hidden Dependency on @file{Makefile}
address@hidden special characters
+File names, file name components, and the value of @code{VPATH} should
+not contain shell metacharacters or white
+space.  @xref{Special Chars in Variables}.
address@hidden dependency on @file{Makefile}
 Since @code{edit} uses values that depend on the configuration specific
 values (@code{prefix}, etc.)@: and not only on @code{VERSION} and so forth,
 the output depends on @file{Makefile}, not @file{}.
address@hidden $@@
address@hidden @samp{$@@}
 The main rule is generic, and uses @samp{$@@} extensively to
 avoid the need for multiple copies of the rule.
address@hidden Separated dependencies and Single Suffix Rules
address@hidden Separated dependencies and single suffix rules
 You can't use them!  The above snippet cannot be (portably) rewritten
@@ -2632,13 +2639,9 @@ autoconf autoheader: Makefile
 @xref{Single Suffix Rules}, for details.
address@hidden $(srcdir)
address@hidden @samp{$(srcdir)}
 Be sure to specify the name of the source directory,
 otherwise the package won't support separated builds.
address@hidden VPATH
-The value of @code{VPATH} should not contain shell metacharacters or white
-space.  @xref{Special Chars in Variables}.
 @end table
 For the more specific installation of Erlang libraries, the following variables
@@ -2706,7 +2709,7 @@ files by prefixing them with @samp{$(src
 @example time.texinfo
-        $(MAKEINFO) $(srcdir)/time.texinfo
+        $(MAKEINFO) '$(srcdir)/time.texinfo'
 @end example
 @node Automatic Remaking
@@ -2737,13 +2740,13 @@ conflicts, etc.).
 $(srcdir)/configure: aclocal.m4
-        cd $(srcdir) && autoconf
+        cd '$(srcdir)' && autoconf
 # autoheader might not change, so touch a stamp file.
 $(srcdir)/ aclocal.m4
-        cd $(srcdir) && autoheader
-        echo timestamp > $(srcdir)/
+        cd '$(srcdir)' && autoheader
+        echo timestamp > '$(srcdir)/'
 config.h: stamp-h
 stamp-h: config.status
@@ -3234,7 +3237,7 @@ If a given @var{dir} is not found, an er
 subdirectory is optional, write:
-if test -d $srcdir/foo; then
+if test -d "$srcdir/foo"; then
 @end example
@@ -6951,7 +6954,7 @@ command:
 foo.o: foo.f90
-     $(FC) -c $(FCFLAGS) $(FCFLAGS_f90) $(srcdir)/foo.f90
+     $(FC) -c $(FCFLAGS) $(FCFLAGS_f90) '$(srcdir)/foo.f90'
 @end example
 If @code{AC_FC_SRCEXT} succeeds in compiling files with the @var{ext}
@@ -8282,12 +8285,13 @@ arbitrarily be replaced by a single spac
 These restrictions apply both to the values that @command{configure}
 computes, and to the values set directly by the user.  For example, the
 following invocations of @command{configure} are problematic, since they
-attempt to use special characters within @code{CPPFLAGS}:
+attempt to use special characters within @code{CPPFLAGS} and white space
+within @code{$(srcdir)}:
-CPPFLAGS='-DOUCH="&\"#$*?"' ./configure
+CPPFLAGS='-DOUCH="&\"#$*?"' '../My Source/ouch-1.0/configure'
-./configure CPPFLAGS='-DOUCH="&\"#$*?"'
+'../My Source/ouch-1.0/configure' CPPFLAGS='-DOUCH="&\"#$*?"'
 @end example
 @node Caching Results
@@ -11596,12 +11600,12 @@ address@hidden"$default"@}
 If the default value contains a closing brace, then use:
-test "address@hidden@}" = set || var="$default"
+test "address@hidden@}" = set || var="has a '@}'"
 @end example
 @end enumerate
 In most cases @address@hidden"$default"@}} is fine, but in case of
-doubt, just use the latter.  @xref{Shell Substitutions}, items
+doubt, just use the last form.  @xref{Shell Substitutions}, items
 @address@hidden@var{var}:address@hidden@}} and 
 for the rationale.
@@ -11697,7 +11701,8 @@ Autoconf-generated scripts export this v
 @item CDPATH
 @evindex CDPATH
 When this variable is set it specifies a list of directories to search
-when invoking @code{cd} with a relative file name.  Posix
+when invoking @code{cd} with a relative file name that did not start
+with @samp{./} or @samp{../}.  Posix
 1003.1-2001 says that if a nonempty directory name from @env{CDPATH}
 is used successfully, @code{cd} prints the resulting absolute
 file name.  Unfortunately this output can break idioms like
@@ -11713,6 +11718,9 @@ In practice the shells that have this pr
 (unset CDPATH) >/dev/null 2>&1 && unset CDPATH
 @end example
+You can also avoid output by ensuring that your directory name is
+absolute or anchored at @samp{./}, as in @samp{abs=`cd ./src && pwd`}.
 Autoconf-generated scripts automatically unset @env{CDPATH} if
 possible, so you need not worry about this problem in those scripts.
@@ -12097,6 +12105,8 @@ Also, Autoconf-generated scripts check f
 variables like @code{ac_top_srcdir} (@pxref{Configuration Actions}),
 so it is safe to @command{cd} to these variables.
+See @xref{Special Shell Variables}, for portability problems involving
address@hidden and the @env{CDPATH} environment variable.
 Also please see the discussion of the @command{pwd} command.
@@ -13851,7 +13861,7 @@ contains single-letter options, since in
 $ @kbd{cat Makefile}
-       @@echo MAKEFLAGS = $(MAKEFLAGS)
+        @@echo MAKEFLAGS = $(MAKEFLAGS)
 $ @kbd{make}
 MAKEFLAGS = --unix
 $ @kbd{make -k}
@@ -17867,7 +17877,7 @@ $(srcdir)/package.m4: $(top_srcdir)/conf
           echo 'm4_define([AT_PACKAGE_VERSION],   [@@PACKAGE_VERSION@@])'; \
           echo 'm4_define([AT_PACKAGE_STRING],    [@@PACKAGE_STRING@@])'; \
           echo 'm4_define([AT_PACKAGE_BUGREPORT], [@@PACKAGE_BUGREPORT@@])'; \
-        @} >$(srcdir)/package.m4
+        @} >'$(srcdir)/package.m4'
 @end smallexample
@@ -17904,15 +17914,19 @@ EXTRA_DIST = $(TESTSUITE) a
 TESTSUITE = $(srcdir)/testsuite
 check-local: atconfig atlocal $(TESTSUITE)
 installcheck-local: atconfig atlocal $(TESTSUITE)
-        $(SHELL) $(TESTSUITE) AUTOTEST_PATH="$(bindir)" \
+        $(SHELL) '$(TESTSUITE)' AUTOTEST_PATH='$(bindir)' \
+        test ! -f '$(TESTSUITE)' || \
+         $(SHELL) '$(TESTSUITE)' --clean
 AUTOTEST = $(AUTOM4TE) --language=autotest
 $(TESTSUITE): $(srcdir)/
-        $(AUTOTEST) -I $(srcdir) -o $@@.tmp $
+        $(AUTOTEST) -I '$(srcdir)' -o $@@.tmp $
         mv $@@.tmp $@@
 @end example
@@ -18177,7 +18191,7 @@ This solution can be simplified when com
 extend the @code{CPPFLAGS}:
-CPPFLAGS = -DDATADIR=\"$(datadir)\" @@CPPFLAGS@@
+CPPFLAGS = -DDATADIR='"$(datadir)"' @@CPPFLAGS@@
 @end example

reply via email to

[Prev in Thread] Current Thread [Next in Thread]