From: Alexandre Duret-Lutz Date: Sat, 26 Feb 2005 21:32:18 +0000 (+0000) Subject: * doc/automake.texi: "filename" -> "file name", for consistency X-Git-Tag: Release-1-9b~180 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b500f951e8ebdbc1599d80c8ef694b81c02482ce;p=thirdparty%2Fautomake.git * doc/automake.texi: "filename" -> "file name", for consistency with GNU Coding Standards. See also Paul's change on 2004-08-20 in Autoconf. --- diff --git a/ChangeLog b/ChangeLog index 0328e0151..771e43513 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,9 @@ 2005-02-26 Alexandre Duret-Lutz + * doc/automake.texi: "filename" -> "file name", for consistency + with GNU Coding Standards. See also Paul's change on 2004-08-20 + in Autoconf. + * doc/automake.texi (A Library, Libtool Libraries): Show how to link a program with a static or libtool library. (Program and Library Variables): Make clearer that _LDADD and diff --git a/doc/automake.texi b/doc/automake.texi index d9c547ddf..24ecda391 100644 --- a/doc/automake.texi +++ b/doc/automake.texi @@ -1393,9 +1393,9 @@ because @code{$@{APIVERSION@}} is known at @code{make}-time. Note that you should not use shell variables to declare @file{Makefile} files for which @command{automake} must create @file{Makefile.in}. Even @code{AC_SUBST} does not help here, because -@command{automake} needs to know the filename when it runs in order to -check whether @file{Makefile.am} exists. (In the very hairy case that -your setup requires such use of variables, you will have to tell +@command{automake} needs to know the file name when it runs in order +to check whether @file{Makefile.am} exists. (In the very hairy case +that your setup requires such use of variables, you will have to tell Automake which @file{Makefile.in}s to generate on the command-line.) To summarize: @@ -4312,7 +4312,7 @@ will require a copy of @file{malloc.c}, @file{memcmp.c}, @file{strdup.c}, @file{alloca.c} in @file{src/} too.) Because @code{$(LIBOBJS)} and @code{$(ALLOCA)} contain object -filenames that end with @code{.$(OBJEXT)}, they are not suitable for +file names that end with @code{.$(OBJEXT)}, they are not suitable for Libtool libraries (where the expected object extension is @file{.lo}): @code{LTLIBOBJS} and @code{LTALLOCA} should be used instead. @@ -4371,7 +4371,7 @@ per-executable (or per-library) @code{_CFLAGS}. @item COMPILE This is the command used to actually compile a C source file. The -filename is appended to form the complete command line. +file name is appended to form the complete command line. @item AM_LDFLAGS This is the variable which the @file{Makefile.am} author can use to pass @@ -4472,7 +4472,7 @@ Automake makes it possible to include multiple @code{yacc} (or one distinct @code{yacc} (or @code{lex}) source file in a directory, Automake uses a small program called @code{ylwrap} to run @code{yacc} (or @code{lex}) in a subdirectory. This is necessary because yacc's -output filename is fixed, and a parallel make could conceivably invoke +output file name is fixed, and a parallel make could conceivably invoke more than one instance of @code{yacc} simultaneously. The @code{ylwrap} program is distributed with Automake. It should appear in the directory specified by @samp{AC_CONFIG_AUX_DIR}, or one of its @@ -4824,7 +4824,7 @@ included by the C++ linker, then they must be manually added to an @code{_LDADD} or @code{_LIBADD} variable by the user writing the @file{Makefile.am}. -Automake only looks at the filenames listed in @file{_SOURCES} +Automake only looks at the file names listed in @file{_SOURCES} variables to choose the linker, and defaults to the C linker. Sometimes this is inconvenient because you are linking against a library written in another language and would like to set the linker @@ -6698,7 +6698,7 @@ changed. AC_SUBST([CONFIG_STATUS_DEPENDENCIES], ['$(top_srcdir)/version.sh']) @end example @noindent -Note the @code{$(top_srcdir)/} in the filename. Since this variable +Note the @code{$(top_srcdir)/} in the file name. Since this variable is to be used in all @file{Makefile}s, its value must be sensible at any level in the build hierarchy. @@ -6831,8 +6831,8 @@ Hook @code{dist-tarZ} to @code{dist}. @item @code{filename-length-max=99} @cindex Option, @code{filename-length-max=99} @opindex filename-length-max=99 -Abort if filenames longer than 99 characters are found during -@code{make dist}. Such long filenames are generally considered not to +Abort if file names longer than 99 characters are found during +@code{make dist}. Such long file names are generally considered not to be portable in tarballs. See the @code{tar-v7} and @code{tar-ustar} options below. This option should be used in the top-level @file{Makefile.am} or as an argument of @code{AM_INIT_AUTOMAKE} in @@ -6988,26 +6988,26 @@ Automake will complain if it sees such options in an @code{tar-v7} selects the old V7 tar format. This is the historical default. This antiquated format is understood by all tar -implementations and supports filenames with up to 99 characters. When -given longer filenames some tar implementations will diagnose the +implementations and supports file names with up to 99 characters. When +given longer file names some tar implementations will diagnose the problem while other will generate broken tarballs or use non-portable extensions. Furthermore, the V7 format cannot store empty directories. When using this format, consider using the -@code{filename-length-max=99} option to catch filenames too long. +@code{filename-length-max=99} option to catch file names too long. @code{tar-ustar} selects the ustar format defined by POSIX 1003.1-1988. This format is believed to be old enough to be portable. -It fully supports empty directories. It can store filenames with up -to 256 characters, provided that the filename can be split at +It fully supports empty directories. It can store file names with up +to 256 characters, provided that the file name can be split at directory separator in two parts, first of them being at most 155 bytes long. So, in most cases the maximum file name length will be shorter than 256 characters. However you may run against broken tar -implementations that incorrectly handle filenames longer than 99 +implementations that incorrectly handle file names longer than 99 characters (please report them to @email{bug-automake@@gnu.org} so we can document this accurately). @code{tar-pax} selects the new pax interchange format defined by POSIX -1003.1-2001. It does not limit the length of filenames. However, +1003.1-2001. It does not limit the length of file names. However, this format is very young and should probably be restricted to packages which target only very modern platforms. There are moves to change the pax format in an upward-compatible way, so this option may @@ -7096,7 +7096,7 @@ ETAGS_ARGS = automake.in --lang=none \ --regex='/^@@node[ \t]+\([^,]+\)/\1/' automake.texi @end example -If you add filenames to @samp{ETAGS_ARGS}, you will probably also +If you add file names to @samp{ETAGS_ARGS}, you will probably also want to define @samp{TAGS_DEPENDENCIES}. The contents of this variable are added directly to the dependencies for the @code{tags} rule. @vindex TAGS_DEPENDENCIES