1 GNU m4 NEWS - History of user-visible changes. -*- outline -*-
2 Copyright (C) 1992, 1993, 1994, 1998, 2000, 2001, 2006, 2007, 2008, 2009
3 Free Software Foundation, Inc.
5 * Noteworthy changes in Version 1.9b (200x-??-??) [beta]
6 Released by ????, based on git version 1.9a-*
8 NOTE - there are still a number of FIXMEs to resolve before this can be
13 *** The build environment has been updated to modern GNU practices,
14 depending on newer features of Autoconf, Automake, Libtool, Gettext,
15 and Gnulib to be more portable to a wide variety of platforms.
17 ** New command line behavior
19 *** If the POSIXLY_CORRECT environment variable is set, it implies the
20 `-G' and `-Q' options, effectively giving a more fully POSIX-compliant
21 implementation with only compatible GNU extensions.
23 *** New `-b'/`--batch' command-line option to force non-interactive mode.
24 Also, in addition to `-e'/`--interactive' requesting interactive mode,
25 m4 now follows the lead of sh, and automatically enters interactive
26 mode when there are no files specified, and when both standard input
27 and standard error are terminals.
29 *** New `-B'/`--prepend-include' command-line option allows prepending to
30 the include path, rather than always searching `.' first.
32 *** New `--debuglen' command-line option matches the spelling of a new
33 macro, and the old spelling `--arglength' now issues a warning that it
34 might be withdrawn in the future.
36 *** The `-g'/`--gnu' command-line option is now required to allow all GNU
37 extensions when POSIXLY_CORRECT is set.
39 *** The `-H'/`--hashsize' command-line options, which were made no-ops in
40 a previous beta, now issue a deprecation warning.
42 *** The `-L'/`--nesting-limit' command-line option now performs argument
43 validation and accepts an optional multiplier suffix.
45 *** New `-p'/`--pushdef' and `--popdef' command-line options allow more
46 control over macro definitions from the command line between input
49 *** New `--posix' command-line option is a synonym for `-G'/`--traditional'.
51 *** New `-r'/`--regexp-syntax' command-line option changes the default
52 regular expression syntax used by M4. Without this option, M4
53 continues to use EMACS style expressions. A new section in the info
54 docs explains the differences between them, and what builtins are
57 *** New `--safer' command-line option cripples the potentially unsafe
58 builtins `debugfile', `esyscmd', `maketemp', `mkdtemp', `mkstemp', and
61 *** New `--syncoutput' command-line option matches the builtin added in a
62 previous beta, and provides more control over sync line generation
63 from the command line between input files. The previous options
64 `-s'/`--synclines' remain as aliases for `--syncoutput=1'.
66 *** New `--traceoff' command-line option, and new spelling `--traceon' for
67 `--trace', allow more control over macro tracing from the command line
70 *** New `--unload-module' command-line option allows more control over
71 dynamic modules from the command line. Also, `-m'/`--load-module' now
72 acts between input files.
74 *** New `--warnings' command-line option re-enables warnings, overriding
75 `-Q'/`--quiet'/`--silent', allowing warnings even when POSIXLY_CORRECT.
79 *** The `defn' builtin now allows any number of arguments, as POSIX requires.
80 - FIXME: This still doesn't work with concatenating builtins with text.
82 - FIXME: POSIX recommends using ${10} instead of $10 for the tenth
83 positional argument. We should deprecate $10.
87 *** The experimental `epatsubst' and `eregexp' builtins have been removed
88 in favor of a new `changeresyntax' builtin.
92 *** New `changeresyntax' builtin allows programmatic setting of the default
93 regular expression flavor, to match `-r'/`--regexp-syntax' command-line
96 *** New `debuglen' builtin allows runtime setting of debug output length,
97 previously controlled only by the `-l' command line argument.
98 Additionally, whether using the new macro or the command line argument,
99 the length limitation now affects dumpdef output as well as trace
100 output, undergoes argument validation, and accepts an optional
102 - FIXME the multiplier suffix isn't reliable yet
104 *** New `mkdtemp' builtin parallels `mkstemp', but allows the creation of
105 temporary directories instead of files.
107 *** New `refcount' builtin allows tracking how many times a module has
109 - FIXME: consider making m4modules smarter for this purpose
111 *** New `renamesyms' builtin allows programmatic renaming of all symbols
112 according to a regular expression.
113 - FIXME: This feature can cause core dumps when renaming multiple
114 symbols to the same name.
116 *** New `__traditional__' builtin identifies when the traditional module
117 is loaded instead of the gnu module.
119 *** The `modules' and `symbols' builtins, introduced in previous betas,
120 have been renamed `m4modules' and `m4symbols', in order to minimize
121 problems when upgrading from 1.4.x and processing English text. To
122 prevent future problems, any future macro added as a GNU extension will
123 either be blind (ie. be unrecognized without arguments), or begin with
124 the prefix `m4' or `__'.
126 ** Changed behavior of builtins
128 *** The module identifier builtins, such as `__gnu__', `__m4_version__',
129 and `__unix__', now warn if given arguments.
131 *** The `builtin' builtin now has a special form, where if the first
132 argument is exactly the special token representing defn(`builtin'), the
133 expansion is the special token representing the builtin named in the
134 second argument. This allows regenerating a macro with a more
135 efficient mapping directly to a builtin function, rather than through
136 textual indirection through further expansions of `builtin'.
138 *** The `changesyntax' builtin has been improved, to make it easier to add
139 and remove characters from a syntax class without having to specify the
140 entire set of characters in that class. It also supports new syntax
141 categories, `$', `{' and `}', for extended argument handling in macro
142 definitions. See the manual for more examples.
144 *** New `m' flag to `-d'/`--debug' command-line option or `debugmode'
145 builtin traces actions related to module loading and unloading, and
146 affects `dumpdef' and trace output to show where builtins come from.
147 New `s' flag shows the entire stack of `pushdef' definitions during
148 `dumpdef'. The `c' flag has been updated to add information to the
149 first line to show the definition of the macro being expanded.
151 *** The `eval' and `mpeval' builtins now support the following new
152 operators: `>>>', `\', and `,'.
154 *** The `maketemp' builtin now always warns that it is obsolete, even in GNU
155 mode where it uses the same secure algorithm as `mkstemp', because of
156 the recommendation of POSIX to obsolete `maketemp' as inherently
157 insecure when obeying POSIX.
159 *** The `m4symbols' builtin now warns if given a builtin token instead of
160 a macro name. It remains silent for undefined macros.
162 *** The `patsubst' and `regexp' builtins have a new optional 4th argument
163 to use a different regular expression syntax for the duration of that
166 *** The semantics of the `traceon' and `traceoff' builtins now match
167 traditional implementations: when called without arguments, they affect
168 global state rather than affecting only the macros defined at that
169 moment. The manual includes an example of how to recover 1.4.x
174 *** The syntax of frozen files format V2 has been improved to save
175 additional state. This includes the `R' directive for default regular
176 expression syntax, the `t' directive for traced macros, and the `d'
177 directive for debug mode. Existing directives with consecutive strings
178 now require an intermediate newline, for faster parsing. Also, a V2
179 file can now be represented completely in ASCII, thanks to escape
180 sequences. Unfortunately, files frozen by M4 1.4q cannot be read by
181 1.9b, but since 1.4q was not widely distributed, this is not expected
182 to be much of an issue, and comes with the territory of using a beta
184 - FIXME: format 2 still needs to catch more missing state; once 2.0 is
185 released, any further changes would introduce format 3.
187 *** Improvements made in the 1.4.x and 1.6 stable series have been
191 * Noteworthy changes in Version 1.6 (????-??-??) [stable]
192 Released by ????, based on git versions 1.4.10b.x-* and 1.5.*
194 ** Fix regression introduced in 1.4.4b where using `traceon' could delete
195 a macro. This was most noticeable with `traceon(`traceon')', but
196 would also happen in cases such as `foo(traceon(`foo'))'.
198 ** Fix regressions introduced in 1.4.10b:
199 *** Using `builtin' or `indir' to perform nested `shift' calls triggered
200 an assertion failure (not present in 1.4.11).
201 *** The command-line option -dV, as well as the builtin `debugmode(V)',
202 failed to enable `t' and `c' debug options (not present in 1.4.11).
203 *** Comments that contain unbalanced quotes were not rescanned correctly
204 when passed through $@ (not present in 1.4.11).
205 *** Using `defn' on a traced but undefined macro triggered an assertion
206 failure (also present in 1.4.11, but not 1.4.12).
208 ** Remove the undocumented command-line option '-N', as no one complained
209 about the assertion failure regression that it introduced in 1.4.7.
211 ** The `-o'/`--error-output' command-line options, which were replaced by
212 `--debugfile' in 1.4.7, now issue a deprecation warning. This warning
213 harmlessly triggers with versions of Autoconf 2.60 and earlier, but can
214 be silenced by applying this patch:
215 http://git.sv.gnu.org/gitweb/?p=autoconf.git;a=commitdiff;h=714eeee87
217 ** Improve the speed of the input engine.
219 ** Fix the `m4wrap' builtin to accumulate wrapped text in FIFO order, as
220 required by POSIX. The manual mentions a way to restore the LIFO order
221 present in earlier GNU M4 versions. NOTE: this change exposes a bug
222 in Autoconf 2.59 and earlier (which was fixed in Autoconf 2.60).
224 If you want your package to work with pre-installed Autoconf without
225 requiring 2.60, then add these lines to your project's configure.ac,
226 prior to calling AC_INIT:
228 # As long as this project is not ready to upgrade to autoconf 2.60
229 # or newer, make sure that newer M4 will still use LIFO order:
230 m4_define([m4_wrap], [m4_ifdef([_$0_text],
231 [m4_define([_$0_text], [$1]m4_defn([_$0_text]))],
232 [m4_define([_$0_text], [$1])m4_builtin([m4wrap],
233 [m4_default(m4_defn([_$0_text])m4_undefine([_$0_text]))])])])
235 On the other hand, if you want to install Autoconf 2.59 or earlier,
236 then apply this patch:
237 http://git.sv.gnu.org/gitweb/?p=autoconf.git;a=commitdiff;h=56d42fa71
239 ** The `changecom' builtin semantics now match traditional
240 implementations; if the start-comment string resembles a macro name or
241 the start-quote string, comments are effectively disabled.
243 ** The `divert' builtin now accepts an optional second argument of text
244 that is immediately placed in the new diversion, regardless of whether
245 the current expansion is nested within argument collection of another
246 macro. It has also been optimized for faster performance.
248 ** The `substr' builtin now treats negative arguments as indices relative
249 to the end of the string, and accepts an optional fourth argument of
250 text to supply in place of the selected substring. The manual gives an
251 example of how to recover M4 1.4.x behavior, as well as an example of
252 simulating the new negative argument semantics with older M4.
254 ** The `index' builtin now takes an optional third argument as the index
255 to begin searching from, with a negative argument relative to the end of
258 ** The `-d'/`--debug' command-line option now understands `-' and `+'
259 modifiers, the way the builtin `debugmode' has always done; this allows
260 `-d-V' to disable prior debug settings from the command line, similar to
261 using the builtin `debugmode' without arguments. The option
262 `--debugmode' is added as an alias for `-d'. The new flag `d' is added
263 to control whether dereferencing an undefined macro causes a warning;
264 this flag is enabled by default if neither `-d' nor `-E' are specified.
265 The new flag `o' is added to control whether `dumpdef' outputs to stderr
266 or the current `debugfile' location. When the command line option is
267 given the empty string, the mode is treated as `+adeq' instead of `aeq'.
268 Also, the position of `-d' with respect to files on the command line is
271 ** A new predefined text macro, `__m4_version__', expands to the unquoted
272 version number of M4, if GNU extensions are enabled. While you should
273 generally favor feature tests over version number checks, this macro can
274 be used, via `defn', to determine whether the version of m4 processing
275 your file is adequate.
277 ** The `defn', `popdef', and `undefine' builtins gained a new warning when
278 operating on an undefined macro name, to match the warning already
279 present in `builtin', `indir', and `dumpdef'. For backwards
280 compatibility, the warning can be disabled by using `debugmode(`-d')'
281 (or the command line option `--debug=-d'). The flag is also cleared by
282 the command line option `-E'/`--fatal-warnings', so that scripts written
283 for 1.4.x do not cause the script to fail because of new warnings.
285 ** Enhance the `indir' builtin to trace indirect macros, where the trace
286 is requested via `traceon' or the command-line option `-t'. Previously,
287 it was impossible to trace macro names such as `foo-bar' which could
288 only be invoked indirectly, without relying on global tracing (such as
289 with `debugmode(`t')') or the experimental `changeword'.
291 ** Aspects of tracing output that were previously undocumented have been
292 slightly altered, and the effect of the builtin `debugmode' on trace
293 output is more fully documented. As POSIX does not specify trace output
294 format, parsing such output is inherently fragile in the first place.
295 The intent is that future M4 versions will not change documented trace
296 output without adding additional `debugmode' flags.
298 ** Enhance the `ifdef', `ifelse', and `shift' builtins, as well as all
299 user macros, to transparently handle builtin tokens generated by `defn'.
301 ** Allow the concatenation of builtin macros with arbitrary text in
302 several contexts, via the `defn' builtin or argument expansion, rather
303 than warning and converting the builtin token to an empty string.
304 However, it is still not possible to use a concatenated builtin when
307 ** Enhance the `defn', `dumpdef', `ifdef', `popdef', `traceon', `traceoff',
308 and `undefine' macros to warn when encountering a builtin token in the
309 context of a macro name, rather than acting on the empty string. This
310 was already done for `define', `pushdef', `builtin', and `indir'.
312 ** Enhance the `eval' builtin to understand the `?:' operator, and
313 downgrade a failed parse due to an unknown operator from an error to a
316 ** A number of portability improvements inherited from gnulib.
318 * Noteworthy changes in Version 1.4.10b (2008-02-25) [beta]
319 Released by Eric Blake, based on git version 1.4.10a
321 Note that M4 1.4.10b was released prior to 1.4.11, and includes all the
322 features of 1.4.11 except for C99 parsing in the `format' builtin. It also
323 contains the following beta features that were deemed worth deferring until
326 ** Further enhance the `index' builtin to often achieve sublinear results.
328 ** Enhance the `regexp' and `patsubst' builtins to cache frequently used
329 regular expressions, which speeds up typical Autoconf usage.
331 ** Enhance the `format' builtin to warn for more suspicious usages, such as
332 missing arguments or problems parsing according to the format string.
334 ** Enhance the `ifelse' and `shift' builtins so that tail-recursive
335 algorithms based on `$@' operate in linear, rather than quadratic, time
338 ** A number of portability improvements inherited from gnulib.
340 * Noteworthy changes in Version 1.4.13 (2008-12-??) [stable]
341 Released by Eric Blake, based on git version 1.4.12.*
343 ** The manual is now distributed under the terms of FDL 1.3.
345 ** The `divert' and `undivert' builtins have been made more efficient
346 when using temporary files for large diversions.
348 ** The command line option `--debugfile', introduced in 1.4.7, now
349 treats its argument as optional, in order to allow setting the debug
350 output back to stderr when used without an argument; and order is now
351 significant with respect to command line files. You must therefore use
352 `m4 --debugfile=trace file', not `m4 file --debugfile trace'. This
353 change does not affect the deprecated `-o'/`--error-output' option.
355 ** A number of portability improvements inherited from gnulib.
357 * Noteworthy changes in Version 1.4.12 (2008-10-10) [stable]
358 Released by Eric Blake, based on git version 1.4.11.*
360 ** Fix regression introduced in 1.4.4b where using `traceon' could delete
361 a macro. This was most noticeable with `traceon(`traceon')', but
362 would also happen in cases such as `foo(traceon(`foo'))'.
364 ** Fix regression introduced in 1.4.7 where `m4 -N9' died with an assertion
367 ** Fix regression introduced in 1.4.11 where `defn' died with an assertion
368 failure on a traced but undefined macro.
370 ** New `-g'/`--gnu' command-line option overrides `-G'/`--traditional'.
371 For now, the environment variable POSIXLY_CORRECT has no effect on M4
372 behavior; but a future release of M4 will behave as though --traditional
373 is implied if POSIXLY_CORRECT is set (this future change is necessary,
374 because in the current release, there is no way to disable GNU
375 extensions that conflict with POSIX without the use of a non-POSIX
376 command-line argument). Clients of M4 that want to use GNU extensions,
377 even when POSIXLY_CORRECT is set, should start using the -g command-line
378 argument, even though it is currently a no-op if -G did not appear
379 earlier in the command line, so that the client will not break in the
380 face of an upgraded m4 and a POSIXLY_CORRECT execution environment.
382 ** The `-L'/`--nesting-limit' command-line option now defaults to 0 for
383 unlimited on platforms that can detect and deal with stack overflow. On
384 systems that lack alternate stack support, such as Cygwin, and on
385 systems that do not obey the POSIX semantics for distinguishing stack
386 overflow from other exceptions, such as Linux, you can optionally
387 install the libsigsegv library (version 2.6 or newer recommended) to
388 enhance m4's ability to accurately report stack overflow:
389 http://www.gnu.org/software/libsigsegv/
391 ** A number of portability improvements inherited from gnulib.
393 * Noteworthy changes in Version 1.4.11 (2008-04-02) [stable]
394 Released by Eric Blake, based on git version 1.4.10a
396 ** Security fixes for the -F option, for bugs present since -F was
397 introduced in 1.3: Avoid core dump with 'm4 -F file -t undefined', and
398 avoid arbitrary code execution with certain file names.
400 ** Fix regression introduced in 1.4.9b in the `divert' builtin when more
401 than 512 kibibytes are saved in diversions on platforms like NetBSD
402 or darwin where fopen(name,"a+") seeks to the end of the file.
404 ** The output of the `maketemp' and `mkstemp' builtins is now quoted if a
405 file was created. This is a minor security fix, because it was possible
406 (although rather unlikely) that an unquoted string could match an
407 existing macro name, such that use of the `mkstemp' output would trigger
408 inadvertent macro expansion and operate on the wrong file name.
410 ** Enhance the `defn' builtin to support concatenation of multiple text
411 arguments, as required by POSIX. However, at this time, it is not
412 possible to concatenate a builtin macro with anything else; a warning is
413 now issued if this is attempted, although a future version of M4 may
414 lift this restriction to match other implementations.
416 ** Enhance the `format' builtin to parse all C99 floating point numbers,
417 even on platforms where strtod(3) is buggy, although the replacement
418 function does have the known issue of rounding errors when parsing
419 some decimal floating point values. This fixes testsuite failures
420 introduced in 1.4.9b.
422 ** Enhance the `index' builtin to guarantee linear behavior, in spite of
423 the surprisingly large number of systems with a brain-dead quadratic
426 ** A number of portability improvements inherited from gnulib.
428 * Noteworthy changes in Version 1.4.10 (2007-07-09) [stable]
429 Released by Eric Blake, based on CVS version 1.4.9c
431 ** Upgrade from GPL version 2 to GPL version 3 or later.
433 ** A number of portability improvements inherited from gnulib.
435 ** Avoid undefined behavior introduced in 1.4.9b in the `format' builtin
436 when handling %c. However, this area of code has never been documented,
437 and currently does not match the POSIX behavior of printf(1), so it may
438 have further changes in the next version.
440 * Noteworthy changes in Version 1.4.9b (2007-05-29) [beta]
441 Released by Eric Blake, based on CVS version 1.4.9a
443 ** Fix regression introduced in 1.4.9 in the `eval' builtin when performing
446 ** Fix regression introduced in 1.4.8 in the `-F' option that made it
447 impossible to freeze more than 512 kibibytes of diverted text.
449 ** The synclines option `-s' no longer generates sync lines in the middle of
450 multiline comments or quoted strings.
452 ** Work around a number of corner-case POSIX compliance bugs in various
453 broken stdio libraries. In particular, the `syscmd' builtin behaves
454 more predictably when stdin is seekable.
456 ** The `format' builtin now understands formats such as %a, %A, and %'hhd,
457 and works around a number of platform printf bugs. Furthermore, the
458 sequence format(%*.*d,-1,-1,1) no longer outputs random data. However,
459 some non-compliant platforms such as mingw still have known bugs in
460 strtod that may cause testsuite failures.
462 ** The testsuite is improved to also run gnulib portability tests for the
463 features that M4 imports from gnulib.
465 * Noteworthy changes in Version 1.4.9 (2007-03-23) [stable]
466 Released by Eric Blake, based on CVS version 1.4.8c
468 ** Minor documentation and portability cleanups.
470 * Noteworthy changes in Version 1.4.8b (2007-02-24) [beta]
471 Released by Eric Blake, based on CVS version 1.4.8a
473 ** Fix a regression introduced in 1.4.8 that made m4 unable to process
474 files larger than 2GiB on some platforms.
476 ** Fix a regression introduced in 1.4.8 that made m4 dump core when
477 invoked as 'm4 -- file'.
479 ** The `eval' builtin now follows C precedence rules. Additionally, the
480 short-circuit operators correctly short-circuit division by zero. The
481 previously undocumented alias of '=' meaning '==' in eval now triggers a
482 deprecation warning, so that a future version of M4 can implement a form
483 of variable assignment as an extension.
485 ** The `include' builtin now affects exit status on failure, as required by
486 POSIX. Use `sinclude' if you need a successful exit status.
488 ** The `-E'/`--fatal-warnings' command-line option now has two levels. When
489 specified only once, warnings affect exit status, but execution
490 continues, so that you can see all warnings instead of fixing them one
491 at a time. To achieve 1.4.8 behavior, where the first warning
492 immediately exits, specify -E twice on the command line.
494 ** A new `--warn-macro-sequence' command-line option allows detection of
495 sequences in `define' and `pushdef' definitions that match an optional
496 regular expression. The default regular expression is
497 `\$\({[^}]*}\|[0-9][0-9]+\)', corresponding to the sequences that might
498 not behave correctly when upgrading to the eventual M4 2.0. By default,
499 M4 2.0 will follow the POSIX requirement that a macro definition
500 containing `$11' must expand to the first argument concatenated with 1,
501 rather than the eleventh argument; and will take advantage of the POSIX
502 wording that allows implementations to treat `${11}' as the eleventh
503 argument instead of literal text. Be aware that Autoconf 2.61 will not
504 work with this option enabled with the default regular expression; but
505 Autoconf 2.62 will be compatible with this option.
507 ** Improved portability to platforms such as BSD/OS and AIX.
509 * Noteworthy changes in Version 1.4.8 (2006-11-20) [stable]
510 Released by Eric Blake, based on CVS version 1.4.7a
512 ** The `divert' macro and `-H'/`--hashsize' command line option no longer
513 cause a core dump when handed extra large values. Also, `divert' now
514 uses memory proportional to the number of diversions in use, rather than
515 to the maximum diversion number encountered, so that large diversion
516 numbers are less likely to exhaust system memory; and is no longer
517 limited by the maximum number of file descriptors.
519 ** The `--help' and `--version' command line options now consistently
520 override all earlier options. For example, `m4 --debugfile=trace
521 --help' now no longer accidentally creates an empty file `trace'.
523 ** The `-L'/`--nesting-limit' command line option can now be set to 0
524 to remove the default limit of 1024. However, it is still possible that
525 heavily nested input can cause abrupt program termination due to stack
528 ** Problems encountered when writing to standard error, such as with the
529 `errprint' macro, now always cause a non-zero exit status.
531 ** Warnings and errors issued during macro expansion are now consistently
532 reported at the line where the macro name was detected, rather than
533 where the close parenthesis resides. Text wrapped by `m4wrap' now
534 remembers the location that was in effect when m4wrap was invoked,
535 rather than changing to line 0 and the empty string for a file. The
536 macros `__line__' and `__file__' now work correctly even as the last
537 token in an included file.
539 ** The `builtin' and `indir' macros now transparently handle builtin
540 tokens generated by `defn'.
542 ** When diversions created by the `divert' macro collect enough text that
543 M4 must use temporary files, the environment variable $TMPDIR is now
544 consulted, and a better effort is made to clean up those files in the
545 event of a fatal signal.
547 ** The `mkstemp' builtin is added with the same GNU semantics as `maketemp',
548 based on the recommendation of POSIX to deprecate the POSIX semantics of
549 `maketemp' as inherently insecure. In GNU mode (no -G supplied on the
550 command line), `maketemp' silently retains the secure GNU semantics, but
551 a future release of M4 will change this to emit a warning. In
552 traditional mode (m4 -G), `maketemp' now uses the POSIX-mandated
553 insecure semantics, and issues a warning that you should convert your
554 script to use `mkstemp' instead. Additionally, `mkstemp' and `maketemp'
555 are now well-defined even if the template argument does not end in six
558 ** The manual has been improved, including a new section on a composite
561 ** The `changecom' and `changequote' macros now treat an empty second
562 argument the same as if it were missing, rather than using the empty
563 string and making it impossible to end a comment or quote.
565 ** The `translit' macro now operates in linear instead of quadratic time,
566 and is now eight-bit clean.
568 ** The `-D', `-U', `-s', and `-t' command line options now take effect
569 after any files encountered earlier on the command line, rather than up
570 front, as is done in traditional implementations and required by POSIX.
572 * Noteworthy changes in Version 1.4.7 (2006-09-25) [stable]
573 Released by Eric Blake, based on CVS version 1.4.6a
575 ** Fix regression from 1.4.5 in handling a file that ends in a macro
576 expansion without arguments instead of a newline.
578 ** The define and pushdef macros now warn when the first argument is not
579 a string, rather than silently doing nothing.
581 ** Standard input can now be read more than once, as in 'm4 - file -', and
582 is not closed until all wrapped text is handled. This makes a
583 difference when stdin is not a regular file, and also fixes bugs when
584 using the syscmd or esyscmd macros from wrapped text.
586 ** When standard input is a seekable file, the m4exit, syscmd, and esyscmd
587 macros now restore the current position to the next unread byte rather
588 than discarding an arbitrary amount of buffered data.
590 ** SysV command-line compatibility is no longer a goal of GNU M4; the
591 focus will be instead on POSIX compatibility. This release continues to
592 support previous usage, but adds warnings in areas which will allow a
593 future version of GNU M4 to use its own extensions without being tied to
594 the SysV command line interface.
596 ** The no-op compatibility command line options -B, -N, -S, -T, and
597 --diversions may be withdrawn or assigned new meanings in future
598 releases, so they now issue a warning if used.
600 ** A new command line option -i replaces the compatibility -e as the
601 short spelling of --interactive, for consistency with other GNU tools; a
602 warning is issued if the old spelling is used, and it may be assigned
603 new meaning in future releases.
605 ** A new command line option --debugfile replaces the options -o and
606 --error-output as the preferred spelling. The old options were
607 misleading in their names and inconsistent with other GNU tools; they
608 are still silently accepted, but no longer documented in --help, and may
609 be assigned new meanings in future releases.
611 * Noteworthy changes in Version 1.4.6 (2006-08-25) [stable]
612 Released by Eric Blake, based on CVS version 1.4.5a
614 ** Fix buffer overruns in regexp and patsubst macros when handed a trailing
615 backslash in the replacement text, or when handling \n substitutions
616 beyond the number of \(\) groups.
618 ** Fix memory leak in regexp, patsubst, and changeword macros.
620 ** The format macro now understands %F, %g, and %G.
622 ** When loading frozen files, m4 now exits with status 63 if version
623 mismatch is detected.
625 ** Fix bugs that occurred when invoked with stdout or stderr closed,
626 and detect write failures to stdout or to the target of the debugfile
627 macro. In particular, the syscmd and esyscmd macros can no longer
628 interfere with the debug stream or diversions.
630 ** The m4exit macro now converts values outside the range 0-255 to 1.
632 ** It is now an error if a command-line input file ends in the middle of a
633 comment, matching the behavior of mid-string and mid-argument
636 ** The dnl macro now warns if end of file is encountered instead of a
639 ** The error message when end of file is encountered now uses the file and
640 line where the dangling construct started, rather than `NONE:0:'.
642 ** The debugmode and __file__ macros, and the -s/--synclines option, now
643 show what directory a file was found in when the -I/--include option or
644 M4PATH variable had an effect.
646 ** The changequote and changecom macros now work with 8-bit characters, and
647 quotes and comments that begin with `(' are properly recognized
650 ** The new macro __program__ is added, which allows the input file to issue
651 an error message that resembles messages from m4. Warning and error
652 messages have been reformatted to comply with GNU Coding Standards.
654 ** The errprint, m4wrap, and shift macros are now recognized only with
657 ** The index, substr, translit, regexp, and patsubst macros now produce
658 output when given only one argument, but still warn about a missing
661 ** The patsubst macro now reliably finds zero-length matches at the end
664 * Noteworthy changes in Version 1.4.5 (2006-07-15) [stable]
665 Released by Eric Blake, based on CVS version 1.4.4c
667 ** Fix sysval on BeOS, OS/2, and other systems that store exit status
668 in the low-order byte. Additionally, on Unix platforms, if syscmd was
669 terminated by a signal, sysval now displays the signal number shifted
670 left by eight bits, to match traditional m4 implementations.
672 ** The maketemp macro is no longer subject to platform limitations (such as
673 26 or 32 max files from a given template).
675 ** Frozen files now require that the first directive be V (version), to
676 better diagnose version mismatch. Additionally, if the F directive
677 (builtin function) names an unknown builtin that existed in the m4 that
678 froze the file but not in the current m4 (for example, changeword), the
679 warning is deferred until an attempt is made to actually use the
680 builtin. This allows downgrading from beta m4-1.4o to stable m4-1.4.5
681 without breaking autoconf.
683 ** The format and indir macros are now recognized only with arguments.
685 ** The eval macro no longer crashes on x86 architectures when dividing the
686 minimum integer by -1.
688 ** On systems with ecvt and fcvt, format no longer truncates trailing
689 zeroes on integers printed with %.0f. On systems without these
690 functions, format is no longer subject to a buffer overflow that
691 permitted arbitrary code execution.
693 ** On native Windows builds, the macro __windows__ is provided instead of
694 __unix__. Likewise, on OS/2 builds, the macro __os2__ is provided.
695 This allows input files to determine when syscmd might behave
698 ** Fix bug in 1.4.3 patch to use \n line-endings that did not work for
701 ** When given the empty string or 0, undivert is now documented as a no-op
702 rather than closing stdout, warning about a non-existent file, or trying
703 to read a directory as a file.
705 ** Many documentation improvements. Also, the manual is now distributed
706 under FDL 1.2, rather than a stricter verbatim-only license.
708 ** Raise the -L (--nesting-limit) command line option limit from 250 to
711 ** The decr, incr, divert, m4exit, and substr macros treat an empty number
712 as 0, issue a warning, and expand as normal; rather than issuing an
713 error and expanding to the empty string.
715 ** The eval macro now treats an empty radix argument as 10, handles radix 1,
716 and treats the width argument as number of digits excluding the sign,
717 for compatibility with other m4 implementations.
719 ** The ifdef, divert, m4exit, substr, and translit macros now correctly
720 ignore extra arguments.
722 ** The popdef and undefine macros now correctly accept multiple arguments.
724 ** Although changeword is on its last leg, if enabled, it now reverts to the
725 default (faster) regexp when passed the empty string.
727 ** The regexp and substr macros now warn and ignore a trailing backslash in
728 the replacement, and warn on \n for n larger than the number of
729 sub-expressions in the regexp.
731 * Noteworthy changes in Version 1.4.4b (2006-06-17) [beta]
732 Released by Eric Blake, based on CVS version 1.4.4a
734 ** Fix a recursive push_string crashing bug, which affected changequote of
735 three or more characters on some compilers.
737 ** Use automake to fix build portability issues.
739 ** Fix a recursive m4wrap crashing bug.
741 ** Fix a 1 in 2**32 hash crashing bug.
743 ** Tracing a macro by name is now persistent, even if the macro is
744 subsequently undefined or redefined. The traceon and traceoff macros no
745 longer warn about undefined symbols. This solves a crash when using
746 indir on an undefined macro traced with the -t option, as well as an
747 incorrect result of ifdef. Furthermore, tracing is no longer
748 transferred with builtins, solving the bug of "m4 -tm4_eval" failing to
749 give trace output on the input
750 "define(`m4_eval',defn(`eval'))m4_eval(1)".
752 ** Fix a crash when a macro is undefined while collecting its arguments, by
753 always using the definition that was in effect before argument
754 collection. This behavior matches the C pre-processor, and means that
755 the sequence "define(`f',`1')f(define(`f',`2'))f" is now documented to
756 result in "12", rather than the previously undocumented "22".
758 ** Update the regex engine to fix several bugs.
760 ** Fix a potential crash on machines where char is signed.
762 * Noteworthy changes in Version 1.4.4 (Oct 2005) [stable]
763 Released by Gary V. Vaughan
765 ** ./configure --infodir=/usr/share/info now works correctly.
767 ** When any file named on the command line is missing exit with status 1.
769 * Noteworthy changes in Version 1.4.3 (Mar 2005) [stable]
770 Released by Gary V. Vaughan
772 ** DESTDIR installs now work correctly.
774 ** Don't segfault with uncompilable regexps to changeword().
776 ** Always use \n line-endings for frozen files (fixes a Windows bug).
778 ** Portability fix for systems lacking mkstemp(3).
780 ** Approximately 20% speed up in the common case of usage with autoconf.
782 ** Supported on QNX 6.3.
784 * Noteworthy changes in Version 1.4.2 (Aug 2004) [stable]
785 Released by Paul Eggert
787 ** No user visible changes; portability bug fixes only.
789 * Noteworthy changes in Version 1.4.1 (Jun 2004) [stable]
790 Released by Paul Eggert
792 ** The 1.4.x series is intended to be stable; features added in 1.4[a-q]
793 were not backported to 1.4.x unless specifically mentioned above.
795 ** maketemp now creates an empty file with the given name, instead of merely
796 returning the name of a nonexistent file. This closes a security hole.
799 * Version beta 1.4q - August 2001, by Gary V. Vaughan
801 ** Support for the experimental `changeword' has been dropped.
803 ** `m4 --hashsize' and `-H' are still accepted, but have no effect. M4
804 will grow its internal symbol table if the symbol density is having an
805 effect on performance.
807 ** `configure --without-modules' will build an m4 binary with no preloaded
808 modules. At startup it will search for and load modules `m4' and either
809 `gnu' or `traditional'. This mode of operation can be used for
810 development and debugging of the base modules without the need to
811 recompile all of m4 with each modification.
813 ** `configure --with-modules="gnu m4 traditional load"', for example,
814 will build an m4 binary with the named modules preloaded, ready to be
815 activated (even on static lib only machines) with the `-m' option or
816 using the `load' builtin.
818 ** M4 has no builtins or macros in core, they are all loaded from modules
819 at startup. This means that modules are no longer optional, though the
820 standard build will statically link the modules `m4', `gnu' and
821 `traditional', so even on machines with no ltdl support, all of the
822 functionality from previous releases is available.
824 ** New builtin `load' to dynamically load modules which can define new
825 builtins and user macros.
827 ** New builtin `unload' to remove loaded modules (and the builtins and user
828 macros they define) from the running m4 interpreter.
830 ** New builtins `eregexp' and `epatsubst' to use Extended Regular
831 Expressions syntax in lieu of Basic Regular Expressions as used by
832 `regexp' and `patsubst'.
834 ** The names of all currently loaded modules are returned by the new
835 builtin, ``modules''.
837 ** Loadable modules can define new builtin functions or text expansion
840 ** The module code has been rewritten to use libltdl, the libtool dynamic
841 loader, which means GNU m4 can now load (and unload) modules just about
842 anywhere which it can be built. This includes obscure hosts such as
843 cygwin and BeOS, and also on hosts which do not have shared libraries,
844 through preloading (see libtool manual) and GNU dld.
846 ** Modules can now be built without the m4 source being available using the
847 installed m4module.h header file (and some other headers that it
848 includes for you), and the installed libm4.la libtool library. All
849 symbols exported from libm4.la have a prefix of `m4_' or `M4_'. See the
850 modules directory for examples of usage.
852 ** A new V2 format for frozen files that saves module and syntax information.
854 * Version beta 1.4o - January 2000, by Rene' Seindal
856 ** Modules can be loaded from the command line with --load-module
858 ** Modules now use libtool's wrapper libltdl.
860 ** New builtin `symbols' allows dynamic queries of all currently defined
863 ** Various Bug fixes.
865 * Version beta 1.4n - November 1998, by Rene' Seindal
867 ** The module code has been reorganised yet again, and now compiles
868 correctly on GNU/Linux, HPUX 9 and 10, SunOS 5 and Solaris 5.
870 ** When configured --with-gmp a new builtin `mpeval' is now defined. The
871 builtin `eval' retains its normal behaviour.
873 ** m4 --version also shows which options were used for compilation, such as:
874 "GNU m4 1.4n (options: modules gmp changeword)"
876 ** New option --import-environment defines all environment variables as
877 macros. This is done before -D and -U are handled, so the macros can be
878 changed through these options.
880 ** Error messages now always print program name before input file name as
881 specified by GNU coding standards. Reported by Akim Demaille.
883 ** Bug fixed: "undivert(0)" could cause m4 to read standard output. A call
884 of "undivert(0)" is now silently ignored.
886 ** Bug fixed: when compiling --with-included-gettext, <libintl.h> wasn't
887 found in intl/ directory. Reported by Andrew Bettison.
889 * Version beta 1.4m - November 1998, by Rene' Seindal
891 ** Using libtool for compiling modules and for linking main app.
893 ** Reorganised the dynamic module code to encapsulate system dependencies
894 better. The code for HPUX shl_load() still needs testing and debugging.
895 A dld interface is also missing. Any volunteers?
897 ** The files from the GNU m4 web-site is now in examples/WWW as a more
898 complete example of what GNU m4 can do.
900 * Version beta 1.4l - November 1998, by Rene' Seindal
902 ** GNU m4 now has an escape syntax category. If a character is marked as
903 an escape, words are only recognised as macros if preceded by an escape
904 character. It is a bit like -P, but dynamic: it can be turned on and
905 off. The GNU m4 web-site on http://www.seindal.dk/rene/gnu/ is
906 maintained with this feature - the m4 source is available on the site.
908 ** The module interface is improved, thanks to "Brian J. Fox",
909 who has contributed some code from Meta-HTML. The modules now build
910 automatically and installs properly, by default in
911 /usr/local/libexec/m4. There is a preliminary, untested support for
914 ** There is now a __m4_version__ macro that expands to the current version
917 * Version beta 1.4k - November 1998, by Erick Branderhorst and Rene' Seindal
919 ** GNU m4 now uses gettext to support internationalization.
921 ** GNU m4 now uses automake to control Makefile.in generation. This
922 should make it more consistent with the GNU standards.
924 ** GNU m4 will use the gmp library for multiple precision integral and
925 rational arithmetic in `eval' if configured with `--with-gmp'. If
926 configured without `--with-gmp' or if gmp is not available, and the type
927 `long long int' is, GNU m4 will use that for `eval' arithmetic.
929 ** GNU m4 now parses the input according to a syntax table, that can be
930 modified through the new builtin `changesyntax'. It is a generalisation
931 of the existing builtins `changecom' and `changequote'. The changes are
932 completely backwards compatible (except for the existence of
935 ** Sync lines can be turned on and off with the `syncoutput' builtin. The
936 builtin `syncoutput' is a GNU extension.
938 ** New experimental feature: dynamically loadable modules. New builtin
939 `loadmodules' loads shared libraries, that can define new builtin
940 macros, ie, new macros can be written in C. Depends on the dlopen()
941 interface, and is currently only tested on Linux. Enabled at configure
942 time with `--with-modules'. Documentation is in src/module.c and
945 ** Implement a GNU message catalog for French (Franc,ois Pinard).
947 ** Filenames found through path searches are now correctly reflected in
948 error and debug messages and through the `__file__' macro.
952 *** All 8-bit characters can now be used for quotes.
954 * Version 1.4 - October 1994, by Franc,ois Pinard
956 ** (No user visible changes)
958 * Version 1.3 - September 1994, by Franc,ois Pinard
960 ** Diversions are created as needed. Option `-N' is still accepted, but
961 otherwise ignored. Users should use only negative diversion numbers,
962 instead of high positive numbers, for diverting to nowhere.
964 ** Diversions should also work faster. No temporary files will be needed
965 at all if all diversions taken altogether do not use more than 512K.
967 ** Frozen state files may be produced with the `--freeze-state' (-F)
968 option and later brought back through the `--reload-state' (-R) option.
970 * Version 1.2 - July 1994, by Franc,ois Pinard
972 ** In patsubst(STRING, REGEXP, REPLACEMENT), \& in REPLACEMENT has been
973 changed to represent this part of STRING matched by the whole REGEXP,
974 instead of the whole STRING as before. \0 does the same, but emits a
975 diagnostic saying it will disappear in some subsequent release.
977 ** eval(EXPR) emits a diagnostic if EXPR has suffixed crumb. The same for
978 other numeric conversions in incr(), decr(), divert(), etc.
980 ** `--fatal-warnings' (-E) stops execution at first warning.
982 ** `--nesting-limit=LEVEL' (-L LEVEL) sets a limit to macro nesting.
983 It is initially fixed at 250.
985 ** `--word-regexp=REGEXP' (-W REGEXP) modifies macro name syntax, like
986 does the new `changeword(REGEXP)' macro. This feature is experimental,
987 tell me your opinions about it. You do need --enable-changeword at
988 configure time to get these things. Do *not* depend on them yet.
990 ** Trace output format is scannable by GNU Emacs' next-error function.
992 ** Stack overflow is detected and diagnosed on some capable systems.
994 ** Various bugs have been corrected, m4 should be more portable. See the
995 ChangeLog for details.
997 * Version 1.1 - November 1993, by Franc,ois Pinard
999 ** Changes which might affect existing GNU m4 scripts:
1001 *** Option `-V' has been removed, use `--version' instead. `--version'
1002 writes on standard output instead of standard error, and inhibits any
1005 *** `--no-gnu-extensions' has been renamed `--traditional'.
1007 *** In `eval', `^' used to indicate exponentiation, use `**' instead.
1009 *** The automatic undiversion which takes place at end of all input is
1010 forced into the main output stream.
1012 ** Changes which are unlikely to affect existing scripts:
1014 *** `--help' prints an usage summary on standard output. Script execution
1017 *** `--prefix-builtins' (-P) prefixes all builtin macros by `m4_'.
1019 *** Most builtin macros for which arguments are mandatory, called without
1020 any arguments, are no more recognized as builtin macros: they are
1021 consequently copied verbatim to the output stream.
1023 *** `define' and `pushdef' are usable with only one argument, they give
1024 this argument an empty definition.
1026 *** `eval' new operators for binary representation handling: `^' for
1027 exclusive-or, `~' for the bitwise negation, `<<' and `>>' for shifts.
1029 *** `eval' recognizes the notation 0bDIGITS for binary numbers and the
1030 notation 0rRADIX:DIGITS for numbers in any radix from 1 to 36.
1032 * Version 1.0.3 - December 1992, by Franc,ois Pinard
1034 ** Changes for the user:
1036 *** `dnl' outputs a diagnostic if immediately followed by `('. Usually,
1037 `dnl' is followed by newline or whitespace.
1039 *** `ifelse' accepts without complaining the common idiom of having only
1040 one argument. This is useful for introducing long comments.
1042 *** `eval' always expresses values as signed, whatever the radix.
1044 *** M4OPTS environment variable is no longer obeyed.
1046 *** `--no-warnings' option is renamed `--silent'.
1048 *** Debug lines use a new format more compatible with GNU standards.
1050 *** Various bugs have been corrected. See the ChangeLog for details.
1052 ** Changes for the installer:
1054 *** GNU m4 now uses an Autoconf-generated configure script, and should be
1055 more easily portable in many ways. (Cray is not supported yet).
1057 *** `make check' has been made more portable, expect no errors.
1059 ** Changes for the programmer:
1061 *** Sources have been fully reindented to comply with GNU standards, and
1062 cleaned up in many ways.
1064 *** Sources have been protoized. Non-ANSI compilers are automatically
1065 detected, then sources are unprotoized on the fly before compilation.
1067 *** GNU m4 uses newer versions of obstack, regex, getopt, etc.
1069 * Version 1.0 - October 1991, by Rene' Seindal
1071 ** Uses GNU configure, taken from the gdb distribution.
1073 ** Uses GNU getopt(), with long option names.
1075 ** The -Q/+quiet option is added, which suppresses warnings about missing
1076 or superflous arguments to builtin macros.
1078 ** Added default options via the M4OPTS environment variable.
1080 ** Several minor bugs have been fixed.
1082 * Version 0.99 - July 1991, by Rene' Seindal
1084 ** The builtins `incr' and `decr' are now implemented without use of
1087 ** The builtin `indir' is added, to allow for indirect macro calls
1088 (allows use of "illegal" macro names).
1090 ** The debugging and tracing facilities has been enhanced considerably.
1091 See the manual for details.
1093 ** The -tMACRO option is added, marks MACRO for tracing as soon as it
1096 ** Builtins are traced after renaming iff they were before.
1098 ** Named files can now be undiverted.
1100 ** The -Nnum option can be used to increase the number of divertions
1103 ** Calling changecom without arguments now disables all comment handling.
1105 ** A bug in `dnl' is fixed.
1107 ** A bug in the multi-character quoting code is fixed.
1109 ** Several typos in the manual has been corrected. More probably persist.
1111 * Version 0.75 - November 1990, by Rene' Seindal
1113 ** Implemented search path for include files (-I option and M4PATH
1114 environment variable).
1116 ** Implemented builtin `format' for printf-like formatting.
1118 ** Implemented builtin `regexp' for searching for regular expressions.
1120 ** Implemented builtin `patsubst' for substitution with regular
1123 ** Implemented builtin `esyscmd', which expands to a shell commands output.
1125 ** Implemented `__file__' and `__line__' for use in error messages.
1127 ** Implemented character ranges in `translit'.
1129 ** Implemented control over debugging output.
1131 ** Implemented multi-character quotes.
1133 ** Implemented multi-character comment delimiters.
1135 ** Changed predefined macro `gnu' to `__gnu__'.
1137 ** Changed predefined macro `unix' to `__unix__', when the -G option is
1138 not used. With -G, `unix' is still defined.
1140 ** Added program name to error messages.
1142 ** Fixed two missing null bytes bugs.
1144 * Version 0.50 - January 1990, by Rene' Seindal
1146 * Initial beta release.