configury: default to automake silent rules if available.
[m4/ericb.git] / NEWS
blob12815043a1efb62794c407f2d72c540adc724e47
1 GNU M4 NEWS - History of user-visible changes.       -*- outline -*-
3 * Noteworthy changes in Version 1.9b (200x-??-??) [beta]
4   Released by ????, based on git version 1.9a-*
6 NOTE - there are still a number of FIXMEs to resolve before this can be
7 promoted to 2.0.
9 ** Building M4
11 *** The build environment has been updated to modern GNU practices,
12     depending on newer features of Autoconf, Automake, Libtool, Gettext,
13     and Gnulib to be more portable to a wide variety of platforms.
15 ** New command line behavior
17 *** If the POSIXLY_CORRECT environment variable is set, it implies the
18     `-G' and `-Q' options, effectively giving a more fully POSIX-compliant
19     implementation with only compatible GNU extensions.
21 *** New `-b'/`--batch' command-line option to force non-interactive mode.
22     Also, in addition to `-e'/`--interactive' requesting interactive mode,
23     m4 now follows the lead of sh, and automatically enters interactive
24     mode when there are no files specified, and when both standard input
25     and standard error are terminals.
27 *** New `-B'/`--prepend-include' command-line option allows prepending to
28     the include path, rather than always searching `.' first.
30 *** New `--debuglen' command-line option matches the spelling of a new
31     macro, and the old spelling `--arglength' now issues a warning that it
32     might be withdrawn in the future.
34 *** The `-g'/`--gnu' command-line option is now required to allow all GNU
35     extensions when POSIXLY_CORRECT is set.
37 *** The `-H'/`--hashsize' command-line options, which were made no-ops in
38     a previous beta, now issue a deprecation warning.
40 *** The `-L'/`--nesting-limit' command-line option now performs argument
41     validation and accepts an optional multiplier suffix.
43 *** New `-p'/`--pushdef' and `--popdef' command-line options allow more
44     control over macro definitions from the command line between input
45     files.
47 *** New `--posix' command-line option is a synonym for `-G'/`--traditional'.
49 *** New `-r'/`--regexp-syntax' command-line option changes the default
50     regular expression syntax used by M4.  Without this option, M4
51     continues to use EMACS style expressions.  A new section in the info
52     docs explains the differences between them, and what builtins are
53     affected.
55 *** New `--safer' command-line option cripples the potentially unsafe
56     builtins `debugfile', `esyscmd', `maketemp', `mkdtemp', `mkstemp', and
57     `syscmd'.
59 *** New `--syncoutput' command-line option matches the builtin added in a
60     previous beta, and provides more control over sync line generation
61     from the command line between input files.  The previous options
62     `-s'/`--synclines' remain as aliases for `--syncoutput=1'.
64 *** New `--traceoff' command-line option, and new spelling `--traceon' for
65     `--trace', allow more control over macro tracing from the command line
66     between input files.
68 *** New `--warnings' command-line option re-enables warnings, overriding
69     `-Q'/`--quiet'/`--silent', allowing warnings even when POSIXLY_CORRECT.
71 *** When GNU extensions are enabled, any command line arguments that wauld
72     have been interpreted as input file names with previous releases are
73     still searched for as before, but will first attempt to be loaded as
74     compiled modules before falling back on loading as m4 input.  In
75     POSIXLY_CORRECT mode, only m4 input files in the current directory can
76     be loaded.
78 ** POSIX conformance
80 *** The `defn' builtin now allows any number of arguments, as POSIX requires.
81   - FIXME: This still doesn't work with concatenating builtins with text.
83   - FIXME: POSIX recommends using ${10} instead of $10 for the tenth
84   positional argument.  We should deprecate $10.
86 ** Removed builtins
88 *** The experimental `epatsubst' and `eregexp' builtins have been removed
89     in favor of a new `changeresyntax' builtin.
91 *** The `load' builtin, introduced in previous betas has been removed in
92     lieu of richer `include' and `sinclude' functionality.
94 ** New builtins
96 *** New `changeresyntax' builtin allows programmatic setting of the default
97     regular expression flavor, to match `-r'/`--regexp-syntax' command-line
98     option.
100 *** New `debuglen' builtin allows runtime setting of debug output length,
101     previously controlled only by the `-l' command line argument.
102     Additionally, whether using the new macro or the command line argument,
103     the length limitation now affects dumpdef output as well as trace
104     output, undergoes argument validation, and accepts an optional
105     multiplier suffix.
106   - FIXME the multiplier suffix isn't reliable yet
108 *** New `mkdtemp' builtin parallels `mkstemp', but allows the creation of
109     temporary directories instead of files.
111 *** New `refcount' builtin allows tracking how many times a module has
112     been loaded.
113   - FIXME: consider making m4modules smarter for this purpose
115 *** New `renamesyms' builtin allows programmatic renaming of all symbols
116     according to a regular expression.
117   - FIXME: This feature can cause core dumps when renaming multiple
118   symbols to the same name.
120 *** New `__traditional__' builtin identifies when the traditional module
121     is loaded instead of the gnu module.
123 *** The `modules' and `symbols' builtins, introduced in previous betas,
124     have been renamed `m4modules' and `m4symbols', in order to minimize
125     problems when upgrading from 1.4.x and processing English text.  To
126     prevent future problems, any future macro added as a GNU extension will
127     either be blind (ie. be unrecognized without arguments), or begin with
128     the prefix `m4' or `__'.
130 ** Changed behavior of builtins
132 *** The module identifier builtins, such as `__gnu__', `__m4_version__',
133     and `__unix__', now warn if given arguments.
135 *** The `builtin' builtin now has a special form, where if the first
136     argument is exactly the special token representing defn(`builtin'), the
137     expansion is the special token representing the builtin named in the
138     second argument.  This allows regenerating a macro with a more
139     efficient mapping directly to a builtin function, rather than through
140     textual indirection through further expansions of `builtin'.
142 *** The `changesyntax' builtin has been improved, to make it easier to add
143     and remove characters from a syntax class without having to specify the
144     entire set of characters in that class.  It also supports new syntax
145     categories, `$', `{' and `}', for extended argument handling in macro
146     definitions.  See the manual for more examples.
148 *** New `m' flag to `-d'/`--debug' command-line option or `debugmode'
149     builtin traces actions related to module loading and unloading, and
150     affects `dumpdef' and trace output to show where builtins come from.
151     New `s' flag shows the entire stack of `pushdef' definitions during
152     `dumpdef'.  The `c' flag has been updated to add information to the
153     first line to show the definition of the macro being expanded.
155 *** The `eval' and `mpeval' builtins now support the following new
156     operators: `>>>', `\', and  `,'.
158 *** When GNU extensions are enabled, the `include' and `sinclude' builtins
159     continue to search directories one at a time, but will first attempt to
160     load arguments as compiled modules and then as m4 input before moving
161     to the next directory in the search path.  In POSIXLY_CORRECT mode,
162     only m4 input in the current directory can be loaded.
164 *** The `maketemp' builtin now always warns that it is obsolete, even in GNU
165     mode where it uses the same secure algorithm as `mkstemp', because of
166     the recommendation of POSIX to obsolete `maketemp' as inherently
167     insecure when obeying POSIX.
169 *** The `m4symbols' builtin now warns if given a builtin token instead of
170     a macro name.  It remains silent for undefined macros.
172 *** The `patsubst' and `regexp' builtins have a new optional 4th argument
173     to use a different regular expression syntax for the duration of that
174     invocation.
176 *** The semantics of the `traceon' and `traceoff' builtins now match
177     traditional implementations: when called without arguments, they affect
178     global state rather than affecting only the macros defined at that
179     moment.  The manual includes an example of how to recover 1.4.x
180     semantics.
182 ** Other changes
184 *** The syntax of frozen files format V2 has been improved to save
185     additional state.  This includes the `R' directive for default regular
186     expression syntax, the `t' directive for traced macros, and the `d'
187     directive for debug mode.  Existing directives with consecutive strings
188     now require an intermediate newline, for faster parsing.  Also, a V2
189     file can now be represented completely in ASCII, thanks to escape
190     sequences.  Unfortunately, files frozen by M4 1.4q cannot be read by
191     1.9b, but since 1.4q was not widely distributed, this is not expected
192     to be much of an issue, and comes with the territory of using a beta
193     release.
194   - FIXME: format 2 still needs to catch more missing state; once 2.0 is
195     released, any further changes would introduce format 3.
197 *** Improvements made in the 1.4.x and 1.6 stable series have been
198     incorporated.
201 * Noteworthy changes in Version 1.6 (????-??-??) [stable]
202   Released by ????, based on git versions 1.4.10b.x-* and 1.5.*
204 ** Fix regression introduced in 1.4.4b where using `traceon' could delete
205    a macro.  This was most noticeable with `traceon(`traceon')', but
206    would also happen in cases such as `foo(traceon(`foo'))'.
208 ** Fix regressions introduced in 1.4.10b:
209 *** Using `builtin' or `indir' to perform nested `shift' calls triggered
210     an assertion failure (not present in 1.4.11).
211 *** The command-line option -dV, as well as the builtin `debugmode(V)',
212     failed to enable `t' and `c' debug options (not present in 1.4.11).
213 *** Comments that contain unbalanced quotes were not rescanned correctly
214     when passed through $@ (not present in 1.4.11).
215 *** Using `defn' on a traced but undefined macro triggered an assertion
216     failure (also present in 1.4.11, but not 1.4.12).
218 ** Remove the undocumented command-line option '-N', as no one complained
219    about the assertion failure regression that it introduced in 1.4.7.
221 ** The `-o'/`--error-output' command-line options, which were replaced by
222    `--debugfile' in 1.4.7, now issue a deprecation warning.  This warning
223    harmlessly triggers with versions of Autoconf 2.60 and earlier, but can
224    be silenced by applying this patch:
225      http://git.sv.gnu.org/gitweb/?p=autoconf.git;a=commitdiff;h=714eeee87
227 ** Fix the `m4wrap' builtin to accumulate wrapped text in FIFO order, as
228    required by POSIX.  The manual mentions a way to restore the LIFO order
229    present in earlier GNU M4 versions.  NOTE: this change exposes a bug
230    in Autoconf 2.59 and earlier (which was fixed in Autoconf 2.60).
232    If you want your package to work with pre-installed Autoconf without
233    requiring 2.60, then add these lines to your project's configure.ac,
234    prior to calling AC_INIT:
236      # As long as this project is not ready to upgrade to autoconf 2.60
237      # or newer, make sure that newer M4 will still use LIFO order:
238      m4_define([m4_wrap], [m4_ifdef([_$0_text],
239        [m4_define([_$0_text], [$1]m4_defn([_$0_text]))],
240        [m4_define([_$0_text], [$1])m4_builtin([m4wrap],
241          [m4_default(m4_defn([_$0_text])m4_undefine([_$0_text]))])])])
243    On the other hand, if you want to install Autoconf 2.59 or earlier,
244    then apply this patch:
245      http://git.sv.gnu.org/gitweb/?p=autoconf.git;a=commitdiff;h=56d42fa71
247 ** The `changecom' builtin semantics now match traditional
248    implementations; if the start-comment string resembles a macro name or
249    the start-quote string, comments are effectively disabled.
251 ** The `divert' builtin now accepts an optional second argument of text
252    that is immediately placed in the new diversion, regardless of whether
253    the current expansion is nested within argument collection of another
254    macro.  It has also been optimized for faster performance.
256 ** The `substr' builtin now treats negative arguments as indices relative
257    to the end of the string, and accepts an optional fourth argument of
258    text to supply in place of the selected substring.  The manual gives an
259    example of how to recover M4 1.4.x behavior, as well as an example of
260    simulating the new negative argument semantics with older M4.
262 ** The `index' builtin now takes an optional third argument as the index
263    to begin searching from, with a negative argument relative to the end of
264    the string.
266 ** The `-d'/`--debug' command-line option now understands `-' and `+'
267    modifiers, the way the builtin `debugmode' has always done; this allows
268    `-d-V' to disable prior debug settings from the command line, similar to
269    using the builtin `debugmode' without arguments.  The option
270    `--debugmode' is added as an alias for `-d'.  The new flag `d' is added
271    to control whether dereferencing an undefined macro causes a warning;
272    this flag is enabled by default if neither `-d' nor `-E' are specified.
273    The new flag `o' is added to control whether `dumpdef' outputs to stderr
274    or the current `debugfile' location.  When the command line option is
275    given the empty string, the mode is treated as `+adeq' instead of `aeq'.
276    Also, the position of `-d' with respect to files on the command line is
277    now significant.
279 ** A new predefined text macro, `__m4_version__', expands to the unquoted
280    version number of M4, if GNU extensions are enabled.  While you should
281    generally favor feature tests over version number checks, this macro can
282    be used, via `defn', to determine whether the version of m4 processing
283    your file is adequate.
285 ** The `defn', `popdef', and `undefine' builtins gained a new warning when
286    operating on an undefined macro name, to match the warning already
287    present in `builtin', `indir', and `dumpdef'.  For backwards
288    compatibility, the warning can be disabled by using `debugmode(`-d')'
289    (or the command line option `--debug=-d').  The flag is also cleared by
290    the command line option `-E'/`--fatal-warnings', so that scripts written
291    for 1.4.x do not cause the script to fail because of new warnings.
293 ** Enhance the `indir' builtin to trace indirect macros, where the trace
294    is requested via `traceon' or the command-line option `-t'.  Previously,
295    it was impossible to trace macro names such as `foo-bar' which could
296    only be invoked indirectly, without relying on global tracing (such as
297    with `debugmode(`t')') or the experimental `changeword'.
299 ** Aspects of tracing output that were previously undocumented have been
300    slightly altered, and the effect of the builtin `debugmode' on trace
301    output is more fully documented.  As POSIX does not specify trace output
302    format, parsing such output is inherently fragile in the first place.
303    The intent is that future M4 versions will not change documented trace
304    output without adding additional `debugmode' flags.
306 ** Enhance the `ifdef', `ifelse', and `shift' builtins, as well as all
307    user macros, to transparently handle builtin tokens generated by `defn'.
309 ** Allow the concatenation of builtin macros with arbitrary text in
310    several contexts, via the `defn' builtin or argument expansion, rather
311    than warning and converting the builtin token to an empty string.
312    However, it is still not possible to use a concatenated builtin when
313    defining a macro.
315 ** Enhance the `defn', `dumpdef', `ifdef', `popdef', `traceon', `traceoff',
316    and `undefine' macros to warn when encountering a builtin token in the
317    context of a macro name, rather than acting on the empty string.  This
318    was already done for `define', `pushdef', `builtin', and `indir'.
320 ** Enhance the `eval' builtin to understand the `?:' operator, and
321    downgrade a failed parse due to an unknown operator from an error to a
322    warning.
324 ** A number of portability improvements inherited from gnulib.
326 * Noteworthy changes in Version 1.4.10b (2008-02-25) [beta]
327   Released by Eric Blake, based on git version 1.4.10a
329 Note that M4 1.4.10b was released prior to 1.4.11, and includes all the
330 features of 1.4.11 except for C99 parsing in the `format' builtin.  It also
331 contains the following beta features that were deemed worth deferring until
332 1.6:
334 ** Further enhance the `index' builtin to often achieve sublinear results.
336 ** Enhance the `regexp' and `patsubst' builtins to cache frequently used
337    regular expressions, which speeds up typical Autoconf usage.
339 ** Enhance the `format' builtin to warn for more suspicious usages, such as
340    missing arguments or problems parsing according to the format string.
342 ** Enhance the `ifelse' and `shift' builtins so that tail-recursive
343    algorithms based on `$@' operate in linear, rather than quadratic, time
344    and memory.
346 ** A number of portability improvements inherited from gnulib.
348 * Noteworthy changes in Version 1.4.14 (2010-02-24) [stable]
349   Released by Eric Blake, based on git version 1.4.13.*
351 ** Fix regression introduced in 1.4.12 where executing with stdout closed
352    could crash m4 on exit on some platforms.
354 ** Fix regressions introduced in 1.4.13 in the `esyscmd' builtin, where
355    closed file descriptors could interfere with child execution, and where
356    a child status of 127 made m4 print a spurious message to stderr.
358 ** A number of portability improvements inherited from gnulib.
360 * Noteworthy changes in Version 1.4.13 (2009-04-01) [stable]
361   Released by Eric Blake, based on git version 1.4.12.*
363 ** The manual is now distributed under the terms of FDL 1.3.
365 ** The `divert' and `undivert' builtins have been made more efficient
366    when using temporary files for large diversions.
368 ** The `translit' builtin has been made more efficient when the second
369    argument is short.
371 ** The input engine has been optimized for faster processing.
373 ** The command line option `--debugfile', introduced in 1.4.7, now
374    treats its argument as optional, in order to allow setting the debug
375    output back to stderr when used without an argument; and order is now
376    significant with respect to command line files.  You must therefore use
377    `m4 --debugfile=trace file', not `m4 file --debugfile trace'.  This
378    change does not affect the deprecated `-o'/`--error-output' option.
380 ** The `syscmd' and `esyscmd' builtins can be configured to use an
381    alternate shell, via the new `configure' option `--with-syscmd-shell'.
383 ** A number of portability improvements inherited from gnulib.
385 * Noteworthy changes in Version 1.4.12 (2008-10-10) [stable]
386   Released by Eric Blake, based on git version 1.4.11.*
388 ** Fix regression introduced in 1.4.4b where using `traceon' could delete
389    a macro.  This was most noticeable with `traceon(`traceon')', but
390    would also happen in cases such as `foo(traceon(`foo'))'.
392 ** Fix regression introduced in 1.4.7 where `m4 -N9' died with an assertion
393    failure.
395 ** Fix regression introduced in 1.4.11 where `defn' died with an assertion
396    failure on a traced but undefined macro.
398 ** New `-g'/`--gnu' command-line option overrides `-G'/`--traditional'.
399    For now, the environment variable POSIXLY_CORRECT has no effect on M4
400    behavior; but a future release of M4 will behave as though --traditional
401    is implied if POSIXLY_CORRECT is set (this future change is necessary,
402    because in the current release, there is no way to disable GNU
403    extensions that conflict with POSIX without the use of a non-POSIX
404    command-line argument).  Clients of M4 that want to use GNU extensions,
405    even when POSIXLY_CORRECT is set, should start using the -g command-line
406    argument, even though it is currently a no-op if -G did not appear
407    earlier in the command line, so that the client will not break in the
408    face of an upgraded m4 and a POSIXLY_CORRECT execution environment.
410 ** The `-L'/`--nesting-limit' command-line option now defaults to 0 for
411    unlimited on platforms that can detect and deal with stack overflow.  On
412    systems that lack alternate stack support, such as Cygwin, and on
413    systems that do not obey the POSIX semantics for distinguishing stack
414    overflow from other exceptions, such as Linux, you can optionally
415    install the libsigsegv library (version 2.6 or newer recommended) to
416    enhance m4's ability to accurately report stack overflow:
417    http://www.gnu.org/software/libsigsegv/
419 ** A number of portability improvements inherited from gnulib.
421 * Noteworthy changes in Version 1.4.11 (2008-04-02) [stable]
422   Released by Eric Blake, based on git version 1.4.10a
424 ** Security fixes for the -F option, for bugs present since -F was
425    introduced in 1.3: Avoid core dump with 'm4 -F file -t undefined', and
426    avoid arbitrary code execution with certain file names.
428 ** Fix regression introduced in 1.4.9b in the `divert' builtin when more
429    than 512 kibibytes are saved in diversions on platforms like NetBSD
430    or darwin where fopen(name,"a+") seeks to the end of the file.
432 ** The output of the `maketemp' and `mkstemp' builtins is now quoted if a
433    file was created.  This is a minor security fix, because it was possible
434    (although rather unlikely) that an unquoted string could match an
435    existing macro name, such that use of the `mkstemp' output would trigger
436    inadvertent macro expansion and operate on the wrong file name.
438 ** Enhance the `defn' builtin to support concatenation of multiple text
439    arguments, as required by POSIX.  However, at this time, it is not
440    possible to concatenate a builtin macro with anything else; a warning is
441    now issued if this is attempted, although a future version of M4 may
442    lift this restriction to match other implementations.
444 ** Enhance the `format' builtin to parse all C99 floating point numbers,
445    even on platforms where strtod(3) is buggy, although the replacement
446    function does have the known issue of rounding errors when parsing
447    some decimal floating point values.  This fixes testsuite failures
448    introduced in 1.4.9b.
450 ** Enhance the `index' builtin to guarantee linear behavior, in spite of
451    the surprisingly large number of systems with a brain-dead quadratic
452    strstr(3).
454 ** A number of portability improvements inherited from gnulib.
456 * Noteworthy changes in Version 1.4.10 (2007-07-09) [stable]
457   Released by Eric Blake, based on CVS version 1.4.9c
459 ** Upgrade from GPL version 2 to GPL version 3 or later.
461 ** A number of portability improvements inherited from gnulib.
463 ** Avoid undefined behavior introduced in 1.4.9b in the `format' builtin
464    when handling %c.  However, this area of code has never been documented,
465    and currently does not match the POSIX behavior of printf(1), so it may
466    have further changes in the next version.
468 * Noteworthy changes in Version 1.4.9b (2007-05-29) [beta]
469   Released by Eric Blake, based on CVS version 1.4.9a
471 ** Fix regression introduced in 1.4.9 in the `eval' builtin when performing
472    division.
474 ** Fix regression introduced in 1.4.8 in the `-F' option that made it
475    impossible to freeze more than 512 kibibytes of diverted text.
477 ** The synclines option `-s' no longer generates sync lines in the middle of
478    multiline comments or quoted strings.
480 ** Work around a number of corner-case POSIX compliance bugs in various
481    broken stdio libraries.  In particular, the `syscmd' builtin behaves
482    more predictably when stdin is seekable.
484 ** The `format' builtin now understands formats such as %a, %A, and %'hhd,
485    and works around a number of platform printf bugs.  Furthermore, the
486    sequence format(%*.*d,-1,-1,1) no longer outputs random data.  However,
487    some non-compliant platforms such as mingw still have known bugs in
488    strtod that may cause testsuite failures.
490 ** The testsuite is improved to also run gnulib portability tests for the
491    features that M4 imports from gnulib.
493 * Noteworthy changes in Version 1.4.9 (2007-03-23) [stable]
494   Released by Eric Blake, based on CVS version 1.4.8c
496 ** Minor documentation and portability cleanups.
498 * Noteworthy changes in Version 1.4.8b (2007-02-24) [beta]
499   Released by Eric Blake, based on CVS version 1.4.8a
501 ** Fix a regression introduced in 1.4.8 that made m4 unable to process
502    files larger than 2GiB on some platforms.
504 ** Fix a regression introduced in 1.4.8 that made m4 dump core when
505    invoked as 'm4 -- file'.
507 ** The `eval' builtin now follows C precedence rules.  Additionally, the
508    short-circuit operators correctly short-circuit division by zero.  The
509    previously undocumented alias of '=' meaning '==' in eval now triggers a
510    deprecation warning, so that a future version of M4 can implement a form
511    of variable assignment as an extension.
513 ** The `include' builtin now affects exit status on failure, as required by
514    POSIX.  Use `sinclude' if you need a successful exit status.
516 ** The `-E'/`--fatal-warnings' command-line option now has two levels.  When
517    specified only once, warnings affect exit status, but execution
518    continues, so that you can see all warnings instead of fixing them one
519    at a time.  To achieve 1.4.8 behavior, where the first warning
520    immediately exits, specify -E twice on the command line.
522 ** A new `--warn-macro-sequence' command-line option allows detection of
523    sequences in `define' and `pushdef' definitions that match an optional
524    regular expression.  The default regular expression is
525    `\$\({[^}]*}\|[0-9][0-9]+\)', corresponding to the sequences that might
526    not behave correctly when upgrading to the eventual M4 2.0.  By default,
527    M4 2.0 will follow the POSIX requirement that a macro definition
528    containing `$11' must expand to the first argument concatenated with 1,
529    rather than the eleventh argument; and will take advantage of the POSIX
530    wording that allows implementations to treat `${11}' as the eleventh
531    argument instead of literal text.  Be aware that Autoconf 2.61 will not
532    work with this option enabled with the default regular expression; but
533    Autoconf 2.62 will be compatible with this option.
535 ** Improved portability to platforms such as BSD/OS and AIX.
537 * Noteworthy changes in Version 1.4.8 (2006-11-20) [stable]
538   Released by Eric Blake, based on CVS version 1.4.7a
540 ** The `divert' macro and `-H'/`--hashsize' command line option no longer
541    cause a core dump when handed extra large values.  Also, `divert' now
542    uses memory proportional to the number of diversions in use, rather than
543    to the maximum diversion number encountered, so that large diversion
544    numbers are less likely to exhaust system memory; and is no longer
545    limited by the maximum number of file descriptors.
547 ** The `--help' and `--version' command line options now consistently
548    override all earlier options.  For example, `m4 --debugfile=trace
549    --help' now no longer accidentally creates an empty file `trace'.
551 ** The `-L'/`--nesting-limit' command line option can now be set to 0
552    to remove the default limit of 1024.  However, it is still possible that
553    heavily nested input can cause abrupt program termination due to stack
554    overflow.
556 ** Problems encountered when writing to standard error, such as with the
557    `errprint' macro, now always cause a non-zero exit status.
559 ** Warnings and errors issued during macro expansion are now consistently
560    reported at the line where the macro name was detected, rather than
561    where the close parenthesis resides.  Text wrapped by `m4wrap' now
562    remembers the location that was in effect when m4wrap was invoked,
563    rather than changing to line 0 and the empty string for a file.  The
564    macros `__line__' and `__file__' now work correctly even as the last
565    token in an included file.
567 ** The `builtin' and `indir' macros now transparently handle builtin
568    tokens generated by `defn'.
570 ** When diversions created by the `divert' macro collect enough text that
571    M4 must use temporary files, the environment variable $TMPDIR is now
572    consulted, and a better effort is made to clean up those files in the
573    event of a fatal signal.
575 ** The `mkstemp' builtin is added with the same GNU semantics as `maketemp',
576    based on the recommendation of POSIX to deprecate the POSIX semantics of
577    `maketemp' as inherently insecure.  In GNU mode (no -G supplied on the
578    command line), `maketemp' silently retains the secure GNU semantics, but
579    a future release of M4 will change this to emit a warning.  In
580    traditional mode (m4 -G), `maketemp' now uses the POSIX-mandated
581    insecure semantics, and issues a warning that you should convert your
582    script to use `mkstemp' instead.  Additionally, `mkstemp' and `maketemp'
583    are now well-defined even if the template argument does not end in six
584    `X' characters.
586 ** The manual has been improved, including a new section on a composite
587    macro `foreach'.
589 ** The `changecom' and `changequote' macros now treat an empty second
590    argument the same as if it were missing, rather than using the empty
591    string and making it impossible to end a comment or quote.
593 ** The `translit' macro now operates in linear instead of quadratic time,
594    and is now eight-bit clean.
596 ** The `-D', `-U', `-s', and `-t' command line options now take effect
597    after any files encountered earlier on the command line, rather than up
598    front, as is done in traditional implementations and required by POSIX.
600 * Noteworthy changes in Version 1.4.7 (2006-09-25) [stable]
601   Released by Eric Blake, based on CVS version 1.4.6a
603 ** Fix regression from 1.4.5 in handling a file that ends in a macro
604    expansion without arguments instead of a newline.
606 ** The define and pushdef macros now warn when the first argument is not
607    a string, rather than silently doing nothing.
609 ** Standard input can now be read more than once, as in 'm4 - file -', and
610    is not closed until all wrapped text is handled.  This makes a
611    difference when stdin is not a regular file, and also fixes bugs when
612    using the syscmd or esyscmd macros from wrapped text.
614 ** When standard input is a seekable file, the m4exit, syscmd, and esyscmd
615    macros now restore the current position to the next unread byte rather
616    than discarding an arbitrary amount of buffered data.
618 ** SysV command-line compatibility is no longer a goal of GNU M4; the
619    focus will be instead on POSIX compatibility.  This release continues to
620    support previous usage, but adds warnings in areas which will allow a
621    future version of GNU M4 to use its own extensions without being tied to
622    the SysV command line interface.
624 ** The no-op compatibility command line options -B, -N, -S, -T, and
625    --diversions may be withdrawn or assigned new meanings in future
626    releases, so they now issue a warning if used.
628 ** A new command line option -i replaces the compatibility -e as the
629    short spelling of --interactive, for consistency with other GNU tools; a
630    warning is issued if the old spelling is used, and it may be assigned
631    new meaning in future releases.
633 ** A new command line option --debugfile replaces the options -o and
634    --error-output as the preferred spelling.  The old options were
635    misleading in their names and inconsistent with other GNU tools; they
636    are still silently accepted, but no longer documented in --help, and may
637    be assigned new meanings in future releases.
639 * Noteworthy changes in Version 1.4.6 (2006-08-25) [stable]
640   Released by Eric Blake, based on CVS version 1.4.5a
642 ** Fix buffer overruns in regexp and patsubst macros when handed a trailing
643    backslash in the replacement text, or when handling \n substitutions
644    beyond the number of \(\) groups.
646 ** Fix memory leak in regexp, patsubst, and changeword macros.
648 ** The format macro now understands %F, %g, and %G.
650 ** When loading frozen files, m4 now exits with status 63 if version
651    mismatch is detected.
653 ** Fix bugs that occurred when invoked with stdout or stderr closed,
654    and detect write failures to stdout or to the target of the debugfile
655    macro.  In particular, the syscmd and esyscmd macros can no longer
656    interfere with the debug stream or diversions.
658 ** The m4exit macro now converts values outside the range 0-255 to 1.
660 ** It is now an error if a command-line input file ends in the middle of a
661    comment, matching the behavior of mid-string and mid-argument
662    collection.
664 ** The dnl macro now warns if end of file is encountered instead of a
665    newline.
667 ** The error message when end of file is encountered now uses the file and
668    line where the dangling construct started, rather than `NONE:0:'.
670 ** The debugmode and __file__ macros, and the -s/--synclines option, now
671    show what directory a file was found in when the -I/--include option or
672    M4PATH variable had an effect.
674 ** The changequote and changecom macros now work with 8-bit characters, and
675    quotes and comments that begin with `(' are properly recognized
676    following a word.
678 ** The new macro __program__ is added, which allows the input file to issue
679    an error message that resembles messages from m4.  Warning and error
680    messages have been reformatted to comply with GNU Coding Standards.
682 ** The errprint, m4wrap, and shift macros are now recognized only with
683    arguments.
685 ** The index, substr, translit, regexp, and patsubst macros now produce
686    output when given only one argument, but still warn about a missing
687    second argument.
689 ** The patsubst macro now reliably finds zero-length matches at the end
690    of a string.
692 * Noteworthy changes in Version 1.4.5 (2006-07-15) [stable]
693   Released by Eric Blake, based on CVS version 1.4.4c
695 ** Fix sysval on BeOS, OS/2, and other systems that store exit status
696    in the low-order byte.  Additionally, on Unix platforms, if syscmd was
697    terminated by a signal, sysval now displays the signal number shifted
698    left by eight bits, to match traditional m4 implementations.
700 ** The maketemp macro is no longer subject to platform limitations (such as
701    26 or 32 max files from a given template).
703 ** Frozen files now require that the first directive be V (version), to
704    better diagnose version mismatch.  Additionally, if the F directive
705    (builtin function) names an unknown builtin that existed in the m4 that
706    froze the file but not in the current m4 (for example, changeword), the
707    warning is deferred until an attempt is made to actually use the
708    builtin.  This allows downgrading from beta m4-1.4o to stable m4-1.4.5
709    without breaking autoconf.
711 ** The format and indir macros are now recognized only with arguments.
713 ** The eval macro no longer crashes on x86 architectures when dividing the
714    minimum integer by -1.
716 ** On systems with ecvt and fcvt, format no longer truncates trailing
717    zeroes on integers printed with %.0f.  On systems without these
718    functions, format is no longer subject to a buffer overflow that
719    permitted arbitrary code execution.
721 ** On native Windows builds, the macro __windows__ is provided instead of
722    __unix__.  Likewise, on OS/2 builds, the macro __os2__ is provided.
723    This allows input files to determine when syscmd might behave
724    differently.
726 ** Fix bug in 1.4.3 patch to use \n line-endings that did not work for
727    cygwin.
729 ** When given the empty string or 0, undivert is now documented as a no-op
730    rather than closing stdout, warning about a non-existent file, or trying
731    to read a directory as a file.
733 ** Many documentation improvements.  Also, the manual is now distributed
734    under FDL 1.2, rather than a stricter verbatim-only license.
736 ** Raise the -L (--nesting-limit) command line option limit from 250 to
737    1024.
739 ** The decr, incr, divert, m4exit, and substr macros treat an empty number
740    as 0, issue a warning, and expand as normal; rather than issuing an
741    error and expanding to the empty string.
743 ** The eval macro now treats an empty radix argument as 10, handles radix 1,
744    and treats the width argument as number of digits excluding the sign,
745    for compatibility with other m4 implementations.
747 ** The ifdef, divert, m4exit, substr, and translit macros now correctly
748    ignore extra arguments.
750 ** The popdef and undefine macros now correctly accept multiple arguments.
752 ** Although changeword is on its last leg, if enabled, it now reverts to the
753    default (faster) regexp when passed the empty string.
755 ** The regexp and substr macros now warn and ignore a trailing backslash in
756    the replacement, and warn on \n for n larger than the number of
757    sub-expressions in the regexp.
759 * Noteworthy changes in Version 1.4.4b (2006-06-17) [beta]
760   Released by Eric Blake, based on CVS version 1.4.4a
762 ** Fix a recursive push_string crashing bug, which affected changequote of
763    three or more characters on some compilers.
765 ** Use automake to fix build portability issues.
767 ** Fix a recursive m4wrap crashing bug.
769 ** Fix a 1 in 2**32 hash crashing bug.
771 ** Tracing a macro by name is now persistent, even if the macro is
772    subsequently undefined or redefined.  The traceon and traceoff macros no
773    longer warn about undefined symbols.  This solves a crash when using
774    indir on an undefined macro traced with the -t option, as well as an
775    incorrect result of ifdef.  Furthermore, tracing is no longer
776    transferred with builtins, solving the bug of "m4 -tm4_eval" failing to
777    give trace output on the input
778    "define(`m4_eval',defn(`eval'))m4_eval(1)".
780 ** Fix a crash when a macro is undefined while collecting its arguments, by
781    always using the definition that was in effect before argument
782    collection.  This behavior matches the C pre-processor, and means that
783    the sequence "define(`f',`1')f(define(`f',`2'))f" is now documented to
784    result in "12", rather than the previously undocumented "22".
786 ** Update the regex engine to fix several bugs.
788 ** Fix a potential crash on machines where char is signed.
790 * Noteworthy changes in Version 1.4.4 (Oct 2005) [stable]
791   Released by Gary V. Vaughan
793 ** ./configure --infodir=/usr/share/info now works correctly.
795 ** When any file named on the command line is missing exit with status 1.
797 * Noteworthy changes in Version 1.4.3 (Mar 2005) [stable]
798   Released by Gary V. Vaughan
800 ** DESTDIR installs now work correctly.
802 ** Don't segfault with uncompilable regexps to changeword().
804 ** Always use \n line-endings for frozen files (fixes a Windows bug).
806 ** Portability fix for systems lacking mkstemp(3).
808 ** Approximately 20% speed up in the common case of usage with autoconf.
810 ** Supported on QNX 6.3.
812 * Noteworthy changes in Version 1.4.2 (Aug 2004) [stable]
813   Released by Paul Eggert
815 ** No user visible changes; portability bug fixes only.
817 * Noteworthy changes in Version 1.4.1 (Jun 2004) [stable]
818   Released by Paul Eggert
820 ** The 1.4.x series is intended to be stable; features added in 1.4[a-q]
821    were not backported to 1.4.x unless specifically mentioned above.
823 ** maketemp now creates an empty file with the given name, instead of merely
824    returning the name of a nonexistent file.  This closes a security hole.
827 * Version beta 1.4q - August 2001, by Gary V. Vaughan
829 ** Support for the experimental `changeword' has been dropped.
831 ** `m4 --hashsize' and `-H' are still accepted, but have no effect.  M4
832    will grow its internal symbol table if the symbol density is having an
833    effect on performance.
835 ** `configure --without-modules' will build an m4 binary with no preloaded
836    modules.  At startup it will search for and load modules `m4' and either
837    `gnu' or `traditional'.  This mode of operation can be used for
838    development and debugging of the base modules without the need to
839    recompile all of m4 with each modification.
841 ** `configure --with-modules="gnu m4 traditional load"', for example,
842    will build an m4 binary with the named modules preloaded, ready to be
843    activated (even on static lib only machines) with the `-m' option or
844    using the `load' builtin.
846 ** M4 has no builtins or macros in core, they are all loaded from modules
847    at startup.  This means that modules are no longer optional, though the
848    standard build will statically link the modules `m4', `gnu' and
849    `traditional', so even on machines with no ltdl support, all of the
850    functionality from previous releases is available.
852 ** New builtin `load' to dynamically load modules which can define new
853    builtins and user macros.
855 ** New builtin `unload' to remove loaded modules (and the builtins and user
856    macros they define) from the running m4 interpreter.
858 ** New builtins `eregexp' and `epatsubst' to use Extended Regular
859    Expressions syntax in lieu of Basic Regular Expressions as used by
860    `regexp' and `patsubst'.
862 ** The names of all currently loaded modules are returned by the new
863    builtin, ``modules''.
865 ** Loadable modules can define new builtin functions or text expansion
866    macros.
868 ** The module code has been rewritten to use libltdl, the libtool dynamic
869    loader, which means GNU m4 can now load (and unload) modules just about
870    anywhere which it can be built.  This includes obscure hosts such as
871    cygwin and BeOS, and also on hosts which do not have shared libraries,
872    through preloading (see libtool manual) and GNU dld.
874 ** Modules can now be built without the m4 source being available using the
875    installed m4module.h header file (and some other headers that it
876    includes for you), and the installed libm4.la libtool library.  All
877    symbols exported from libm4.la have a prefix of `m4_' or `M4_'.  See the
878    modules directory for examples of usage.
880 ** A new V2 format for frozen files that saves module and syntax information.
882 * Version beta 1.4o - January 2000, by Rene' Seindal
884 ** Modules can be loaded from the command line with --load-module
886 ** Modules now use libtool's wrapper libltdl.
888 ** New builtin `symbols' allows dynamic queries of all currently defined
889    macros.
891 ** Various Bug fixes.
893 * Version beta 1.4n - November 1998, by Rene' Seindal
895 ** The module code has been reorganised yet again, and now compiles
896    correctly on GNU/Linux, HPUX 9 and 10, SunOS 5 and Solaris 5.
898 ** When configured --with-gmp a new builtin `mpeval' is now defined.  The
899    builtin `eval' retains its normal behaviour.
901 ** m4 --version also shows which options were used for compilation, such as:
902    "GNU m4 1.4n (options: modules gmp changeword)"
904 ** New option --import-environment defines all environment variables as
905    macros.  This is done before -D and -U are handled, so the macros can be
906    changed through these options.
908 ** Error messages now always print program name before input file name as
909    specified by GNU coding standards.  Reported by Akim Demaille.
911 ** Bug fixed: "undivert(0)" could cause m4 to read standard output.  A call
912    of "undivert(0)" is now silently ignored.
914 ** Bug fixed: when compiling --with-included-gettext, <libintl.h> wasn't
915    found in intl/ directory.  Reported by Andrew Bettison.
917 * Version beta 1.4m - November 1998, by Rene' Seindal
919 ** Using libtool for compiling modules and for linking main app.
921 ** Reorganised the dynamic module code to encapsulate system dependencies
922    better.  The code for HPUX shl_load() still needs testing and debugging.
923    A dld interface is also missing.  Any volunteers?
925 ** The files from the GNU m4 web-site is now in examples/WWW as a more
926    complete example of what GNU m4 can do.
928 * Version beta 1.4l - November 1998, by Rene' Seindal
930 ** GNU m4 now has an escape syntax category.  If a character is marked as
931    an escape, words are only recognised as macros if preceded by an escape
932    character.  It is a bit like -P, but dynamic: it can be turned on and
933    off.  The GNU m4 web-site on http://www.seindal.dk/rene/gnu/ is
934    maintained with this feature - the m4 source is available on the site.
936 ** The module interface is improved, thanks to "Brian J. Fox",
937    who has contributed some code from Meta-HTML.  The modules now build
938    automatically and installs properly, by default in
939    /usr/local/libexec/m4.  There is a preliminary, untested support for
940    shl_load().
942 ** There is now a __m4_version__ macro that expands to the current version
943    number.
945 * Version beta 1.4k - November 1998, by Erick Branderhorst and Rene' Seindal
947 ** GNU m4 now uses gettext to support internationalization.
949 ** GNU m4 now uses automake to control Makefile.in generation.  This
950    should make it more consistent with the GNU standards.
952 ** GNU m4 will use the gmp library for multiple precision integral and
953    rational arithmetic in `eval' if configured with `--with-gmp'.  If
954    configured without `--with-gmp' or if gmp is not available, and the type
955    `long long int' is, GNU m4 will use that for `eval' arithmetic.
957 ** GNU m4 now parses the input according to a syntax table, that can be
958    modified through the new builtin `changesyntax'.  It is a generalisation
959    of the existing builtins `changecom' and `changequote'.  The changes are
960    completely backwards compatible (except for the existence of
961    `changesyntax').
963 ** Sync lines can be turned on and off with the `syncoutput' builtin.  The
964    builtin `syncoutput' is a GNU extension.
966 ** New experimental feature: dynamically loadable modules.  New builtin
967    `loadmodules' loads shared libraries, that can define new builtin
968    macros, ie, new macros can be written in C.  Depends on the dlopen()
969    interface, and is currently only tested on Linux.  Enabled at configure
970    time with `--with-modules'.  Documentation is in src/module.c and
971    module/README.
973 ** Implement a GNU message catalog for French (Franc,ois Pinard).
975 ** Filenames found through path searches are now correctly reflected in
976    error and debug messages and through the `__file__' macro.
978 ** Bugs fixed:
980 *** All 8-bit characters can now be used for quotes.
982 * Version 1.4 - October 1994, by Franc,ois Pinard
984 ** (No user visible changes)
986 * Version 1.3 - September 1994, by Franc,ois Pinard
988 ** Diversions are created as needed.  Option `-N' is still accepted, but
989    otherwise ignored.  Users should use only negative diversion numbers,
990    instead of high positive numbers, for diverting to nowhere.
992 ** Diversions should also work faster.  No temporary files will be needed
993    at all if all diversions taken altogether do not use more than 512K.
995 ** Frozen state files may be produced with the `--freeze-state' (-F)
996    option and later brought back through the `--reload-state' (-R) option.
998 * Version 1.2 - July 1994, by Franc,ois Pinard
1000 ** In patsubst(STRING, REGEXP, REPLACEMENT), \& in REPLACEMENT has been
1001    changed to represent this part of STRING matched by the whole REGEXP,
1002    instead of the whole STRING as before.  \0 does the same, but emits a
1003    diagnostic saying it will disappear in some subsequent release.
1005 ** eval(EXPR) emits a diagnostic if EXPR has suffixed crumb.  The same for
1006    other numeric conversions in incr(), decr(), divert(), etc.
1008 ** `--fatal-warnings' (-E) stops execution at first warning.
1010 ** `--nesting-limit=LEVEL' (-L LEVEL) sets a limit to macro nesting.
1011    It is initially fixed at 250.
1013 ** `--word-regexp=REGEXP' (-W REGEXP) modifies macro name syntax, like
1014    does the new `changeword(REGEXP)' macro.  This feature is experimental,
1015    tell me your opinions about it.  You do need --enable-changeword at
1016    configure time to get these things.  Do *not* depend on them yet.
1018 ** Trace output format is scannable by GNU Emacs' next-error function.
1020 ** Stack overflow is detected and diagnosed on some capable systems.
1022 ** Various bugs have been corrected, m4 should be more portable.  See the
1023    ChangeLog for details.
1025 * Version 1.1 - November 1993, by Franc,ois Pinard
1027 ** Changes which might affect existing GNU m4 scripts:
1029 *** Option `-V' has been removed, use `--version' instead.  `--version'
1030     writes on standard output instead of standard error, and inhibits any
1031     script execution.
1033 *** `--no-gnu-extensions' has been renamed `--traditional'.
1035 *** In `eval', `^' used to indicate exponentiation, use `**' instead.
1037 *** The automatic undiversion which takes place at end of all input is
1038     forced into the main output stream.
1040 ** Changes which are unlikely to affect existing scripts:
1042 *** `--help' prints an usage summary on standard output.  Script execution
1043     is then inhibited.
1045 *** `--prefix-builtins' (-P) prefixes all builtin macros by `m4_'.
1047 *** Most builtin macros for which arguments are mandatory, called without
1048     any arguments, are no more recognized as builtin macros: they are
1049     consequently copied verbatim to the output stream.
1051 *** `define' and `pushdef' are usable with only one argument, they give
1052     this argument an empty definition.
1054 *** `eval' new operators for binary representation handling: `^' for
1055     exclusive-or, `~' for the bitwise negation, `<<' and `>>' for shifts.
1057 *** `eval' recognizes the notation 0bDIGITS for binary numbers and the
1058     notation 0rRADIX:DIGITS for numbers in any radix from 1 to 36.
1060 * Version 1.0.3 - December 1992, by Franc,ois Pinard
1062 ** Changes for the user:
1064 *** `dnl' outputs a diagnostic if immediately followed by `('.  Usually,
1065     `dnl' is followed by newline or whitespace.
1067 *** `ifelse' accepts without complaining the common idiom of having only
1068     one argument.  This is useful for introducing long comments.
1070 *** `eval' always expresses values as signed, whatever the radix.
1072 *** M4OPTS environment variable is no longer obeyed.
1074 *** `--no-warnings' option is renamed `--silent'.
1076 *** Debug lines use a new format more compatible with GNU standards.
1078 *** Various bugs have been corrected.  See the ChangeLog for details.
1080 ** Changes for the installer:
1082 *** GNU m4 now uses an Autoconf-generated configure script, and should be
1083     more easily portable in many ways.  (Cray is not supported yet).
1085 *** `make check' has been made more portable, expect no errors.
1087 ** Changes for the programmer:
1089 *** Sources have been fully reindented to comply with GNU standards, and
1090     cleaned up in many ways.
1092 *** Sources have been protoized.  Non-ANSI compilers are automatically
1093     detected, then sources are unprotoized on the fly before compilation.
1095 *** GNU m4 uses newer versions of obstack, regex, getopt, etc.
1097 * Version 1.0 - October 1991, by Rene' Seindal
1099 ** Uses GNU configure, taken from the gdb distribution.
1101 ** Uses GNU getopt(), with long option names.
1103 ** The -Q/+quiet option is added, which suppresses warnings about missing
1104    or superflous arguments to builtin macros.
1106 ** Added default options via the M4OPTS environment variable.
1108 ** Several minor bugs have been fixed.
1110 * Version 0.99 - July 1991, by Rene' Seindal
1112 ** The builtins `incr' and `decr' are now implemented without use of
1113    `eval'.
1115 ** The builtin `indir' is added, to allow for indirect macro calls
1116    (allows use of "illegal" macro names).
1118 ** The debugging and tracing facilities has been enhanced considerably.
1119    See the manual for details.
1121 ** The -tMACRO option is added, marks MACRO for tracing as soon as it
1122    is defined.
1124 ** Builtins are traced after renaming iff they were before.
1126 ** Named files can now be undiverted.
1128 ** The -Nnum option can be used to increase the number of divertions
1129    available.
1131 ** Calling changecom without arguments now disables all comment handling.
1133 ** A bug in `dnl' is fixed.
1135 ** A bug in the multi-character quoting code is fixed.
1137 ** Several typos in the manual has been corrected.  More probably persist.
1139 * Version 0.75 - November 1990, by Rene' Seindal
1141 ** Implemented search path for include files (-I option and M4PATH
1142    environment variable).
1144 ** Implemented builtin `format' for printf-like formatting.
1146 ** Implemented builtin `regexp' for searching for regular expressions.
1148 ** Implemented builtin `patsubst' for substitution with regular
1149    expressions.
1151 ** Implemented builtin `esyscmd', which expands to a shell commands output.
1153 ** Implemented `__file__' and `__line__' for use in error messages.
1155 ** Implemented character ranges in `translit'.
1157 ** Implemented control over debugging output.
1159 ** Implemented multi-character quotes.
1161 ** Implemented multi-character comment delimiters.
1163 ** Changed predefined macro `gnu' to `__gnu__'.
1165 ** Changed predefined macro `unix' to `__unix__', when the -G option is
1166    not used.  With -G, `unix' is still defined.
1168 ** Added program name to error messages.
1170 ** Fixed two missing null bytes bugs.
1172 * Version 0.50 - January 1990, by Rene' Seindal
1174 * Initial beta release.
1176 ========================================================================
1178 Local Variables:
1179 fill-column: 75
1180 End:
1182 Copyright (C) 1992, 1993, 1994, 1998, 2000, 2001, 2006, 2007, 2008,
1183 2009, 2010 Free Software Foundation, Inc.
1185 Permission is granted to copy, distribute and/or modify this document
1186 under the terms of the GNU Free Documentation License, Version 1.3 or
1187 any later version published by the Free Software Foundation; with no
1188 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
1189 Texts.  A copy of the license is included in the ``GNU Free
1190 Documentation License'' file as part of this distribution.