xref: /freebsd/contrib/bc/NEWS.md (revision e9ac41698b2f322d55ccf9da50a3596edb2c1800)
1# News
2
3## 6.7.6
4
5This is a production release to fix one bug.
6
7The bug was that `bc` attempted to jump out when flushing `stdout` on exit, but
8there is no jump buf at that point.
9
10## 6.7.5
11
12This is a production release to fix one small bug.
13
14The bug is that sometimes numbers are printed to incorrect line lengths. The
15number is always correct; the line is just longer than the limit.
16
17Users who do not care do not need to update.
18
19## 6.7.4
20
21This is a production release to fix problems in the `bc` manual.
22
23Users only need to update if desired.
24
25## 6.7.3
26
27This is a production release to fix the library build on Mac OSX.
28
29Users on other platforms do *not* need to update.
30
31## 6.7.2
32
33This is a production release to remove some debugging code that I accidentally
34committed.
35
36## 6.7.1
37
38This is a production release with a bug fix for `SIGINT` only being handled
39once.
40
41## 6.7.0
42
43This is a production release with three new functions in the [extended math
44library][16]: `min()`, `max()`, and `i2rand()`.
45
46## 6.6.1
47
48This is a production release with an improved `p()` function in the [extended
49math library][16].
50
51Users who don't care do not need to upgrade.
52
53## 6.6.0
54
55This is a production release with two bug fixes and one change.
56
57The first bug fix is to fix the build on Mac OSX.
58
59The second bug was to remove printing a leading zero in scientific or
60engineering output modes.
61
62The change was that the implementation of `irand()` was improved to call the
63PRNG less.
64
65## 6.5.0
66
67This is a production release that fixes an infinite loop bug in `root()` and
68`cbrt()`, fixes a bug with `BC_LINE_LENGTH=0`, and adds the `fib()` function to
69the extended math library to calculate Fibonacci numbers.
70
71## 6.4.0
72
73This is a production release that fixes a `read()`/`?` bug and adds features to
74`bcl`.
75
76The bug was that multiple read calls could repeat old data.
77
78The new features in `bcl` are functions to preserve `BclNumber` arguments and
79not free them.
80
81***WARNING for `bcl` Users***: The `bcl_rand_seedWithNum()` function used to not
82consume its arguments. Now it does. This change could have made this version
83`7.0.0`, but I'm 99.9% confident that there are no `bcl` users, or if there are,
84they probably don't use the PRNG. So I took a risk and didn't update the major
85version.
86
87`bcl` now includes more capacity to check for invalid numbers when built to run
88under Valgrind.
89
90## 6.3.1
91
92This is a production release that fixes a `bc` dependency loop for minimal
93environments and Linux from Scratch.
94
95## 6.3.0
96
97This is a production release with a couple of fixes for manuals and a new
98feature for `dc`: there is now a command to query whether extended registers are
99enabled or not.
100
101Users who don't care do not need to upgrade.
102
103## 6.2.6
104
105This is a production release that fixes an install bug that affected locale
106installation of all locales when using `mksh`. Users do ***NOT*** need to
107upgrade if they don't use `mksh` and/or don't need to install all locales.
108
109## 6.2.5
110
111This is a production release that fixes a test bug that affected Android and
112`mksh`. Users do ***NOT*** need to upgrade unless they use `mksh` or another
113affected shell and need to run the test suite.
114
115## 6.2.4
116
117This is a production release that fixes a test failure that happens when
118`tests/bc/scripts/timeconst.bc` doesn't exist. This should only affect
119packagers.
120
121This bug happened because I forgot something I added in the previous release:
122better error checking in tests to help packagers. Unfortunately, I was too
123zealous with the error checking.
124
125## 6.2.3
126
127This is a production release that moves `bc` to <https://git.gavinhoward.com>.
128
129That's all it does: update links. Users do ***NOT*** need to upgrade; there are
130redirects that will stay in place indefinitely. This release is only for new
131users.
132
133## 6.2.2
134
135This is a production release that fixes a bug.
136
137The bug was that if an array element was used as a parameter, and then a later
138parameter had the same name as the array whose element was used, `bc` would grab
139the element from the new array parameter, not the actual element from before the
140function call.
141
142## 6.2.1
143
144This is a production release with one bug fix for a memory bug in history.
145
146## 6.2.0
147
148This is a production release with a new feature and a few bug fixes.
149
150The bug fixes include:
151
152* A crash when `bc` and `dc` are built using editline, but history is not
153  activated.
154* A missing local in the `uint*()` family of functions in the extended math
155  library.
156* A failure to clear the tail call list in `dc` on error.
157* A crash when attempting to swap characters in command-line history when no
158  characters exist.
159* `SIGWINCH` was activated even when history was not.
160
161The new feature is that stack traces are now given for runtime errors. In debug
162mode, the C source file and line of errors are given as well.
163
164## 6.1.1
165
166This is a production release that fixes a build issue with predefined builds and
167generated tests.
168
169## 6.1.0
170
171This is a production release that fixes a discrepancy from the `bc` standard,
172a couple of memory bugs, and adds new features.
173
174The discrepancy from the `bc` standard was with regards to the behavior of the
175`quit` command. This `bc` used to quit whenever it encountered `quit` during
176parsing, even if it was parsing a full file. Now, `bc` only quits when
177encountering `quit` *after* it has executed all executable statements up to that
178point.
179
180This behavior is slightly different from GNU `bc`, but users will only notice
181the difference if they put `quit` on the same line as other statements.
182
183The first memory bug could be reproduced by assigning a string to a non-local
184variable in a function, then redefining the function with use of the same
185non-local variable, which would still refer to a string in the previous version
186of the function.
187
188The second memory bug was caused by passing an array argument to the `asciify()`
189built-in function. In certain cases, that was wrongly allowed, and the
190interpreter just assumed everything was correct and accessed memory. Now that
191arrays are allowed as arguments (see below), this is not an issue.
192
193The first feature was the addition of the `is_number()` built-in function (`u`
194in `dc`) that returns 1 if the runtime argument is a number and 0 otherwise.
195
196The second feature was the addition of the `is_string()` built-in function (`t`
197in `dc`) that returns 1 if the runtime argument is a string and 0 otherwise.
198
199These features were added because I realized that type-checking is necessary now
200that strings can be assigned to variables in `bc` and because they've always
201been assignable to variables in `dc`.
202
203The last added feature is the ability of the `asciify()` built-in function in
204`bc` to convert a full array of numbers into a string. This means that
205character-by-character printing will not be necessary, and more strings than
206just single-character ones will be able to be created.
207
208## 6.0.4
209
210This is a production release that most users will not need to upgrade to.
211
212This fixes a build bug for `bcl` only on OpenBSD. Users that do not need `bcl`
213or have not run into build errors with `bcl` do ***NOT*** need to upgrade.
214
215## 6.0.3
216
217This is a production release that fixes a build bug for cross-compilation.
218
219Users that do not need cross-compilation do ***NOT*** need to upgrade.
220
221## 6.0.2
222
223This is a production release that fixes two bugs:
224
225* The `-l` option overrode the `-S` option.
226* A double-free and crash when sending a `SIGINT` while executing expressions
227  given on the command-line.
228
229## 6.0.1
230
231This is a production release that fixes memory bugs and memory leaks in `bcl`.
232
233Users that do not use `bcl` (use only `bc` and/or `dc`) do ***NOT*** need to
234upgrade.
235
236These happened because I was unaware that the `bcl` test was not hooked into the
237Valgrind test infrastructure. Then, when I ran the release script, which tests
238everything under Valgrind (or so I thought), it caught nothing, and I thought it
239was safe.
240
241But it was not.
242
243Nevertheless, I have now run it under Valgrind and fixed all of the memory bugs
244(caused by not using `memset()` where I should have but previously didn't have
245to) and memory leaks.
246
247## 6.0.0
248
249This is a production release that fixes an oversight in the `bc` parser (that
250sometimes caused the wrong error message) and adds a feature for compatibility
251with the BSD `bc` and `dc`: turning off digit clamping when parsing numbers.
252
253The default for clamping can be set during the build (see the [build
254manual][13]), it can be set with the `BC_DIGIT_CLAMP` and `DC_DIGIT_CLAMP`
255environment variables, and it can be set with the `-c` and `-C` command-line
256options.
257
258Turning off clamping was also added to the `bcl` library.
259
260In addition, signal handling was removed from the `bcl` library in order to add
261the capability for multi-threading. This required a major version bump. I
262apologize to all library users (I don't know of any), but signals and threads do
263not play well together.
264
265To help with building, a convenience option (`-p`) to `configure.sh` was added
266to build a `bc` and `dc` that is by default compatible with either the BSD `bc`
267and `dc` or the GNU `bc` and `dc`.
268
269## 5.3.3
270
271This is a production release that fixes a build problem in the FreeBSD base
272system.
273
274All other users do **NOT** need to upgrade.
275
276## 5.3.2
277
278This is a production release that fixes prompt bugs with editline and readline
279where the `BC_PROMPT` environment variable was not being respected.
280
281This also fixes editline and readline output on `EOF`.
282
283## 5.3.1
284
285This is a production release that fixes a build problem in the FreeBSD base
286system, as well as a problem in the `en_US` locale. If you don't have problems
287with either, you do not need to upgrade.
288
289## 5.3.0
290
291This is a production release that adds features and has a few bug fixes.
292
293First, support for editline and readline history has been added. To use
294editline, pass `-e` to `configure.sh`, and to use readline, pass `-r`.
295
296Second, history support for Windows has been fixed and re-enabled.
297
298Third, command-line options to set `scale`, `ibase`, `obase`, and `seed` were
299added. This was requested long ago, and I originally disagreed with the idea.
300
301Fourth, the manuals had typos and were missing information. That has been fixed.
302
303Fifth, the manuals received different formatting to be more readable as
304manpages.
305
306## 5.2.5
307
308This is a production release that fixes this `bc`'s behavior on `^D` to match
309GNU `bc`.
310
311## 5.2.4
312
313This is a production release that fixes two bugs in history:
314
315* Without prompt, the cursor could not be placed on the first character in a
316  line.
317* Home and End key handling in `tmux` was fixed.
318
319Any users that do not care about these improvements do not need to upgrade.
320
321## 5.2.3
322
323This is a production release that fixes one bug, a parse error when passing a
324file to `bc` using `-f` if that file had a multiline comment or string in it.
325
326## 5.2.2
327
328This is a production release that fixes one bug, a segmentation fault if
329`argv[0]` equals `NULL`.
330
331This is not a critical bug; there will be no vulnerability as far as I can tell.
332There is no need to update if you do not wish to.
333
334## 5.2.1
335
336This is a production release that fixes two parse bugs when in POSIX standard
337mode. One of these bugs was due to a quirk of the POSIX grammar, and the other
338was because `bc` was too strict.
339
340## 5.2.0
341
342This is a production release that adds a new feature, fixes some bugs, and adds
343out-of-source builds and a `pkg-config` file for `bcl`.
344
345The new feature is the ability to turn off exiting on expressions. It is also
346possible to set the default using `configure.sh`. This behavior used to exist
347with the `BC_EXPR_EXIT` environment variable, which is now used again.
348
349Bugs fixed include:
350
351* Some possible race conditions with error handling.
352* Install and uninstall targets for `bcl` did not work.
353
354## 5.1.1
355
356This is a production release that completes a bug fix from `5.1.0`. The bug
357exists in all versions of `bc`.
358
359The bug was that `if` statements without `else` statements would not be handled
360correctly at the end of files or right before a function definition.
361
362## 5.1.0
363
364This is a production release with some fixes and new features.
365
366* Fixed a bug where an `if` statement without an `else` before defining a
367  function caused an error.
368* Fixed a bug with the `bc` banner and `-q`.
369* Fixed a bug on Windows where files were not read correctly.
370* Added a command-line flag (`-z`) to make `bc` and `dc` print leading zeroes on
371  numbers `-1 < x < 1`.
372* Added four functions to `lib2.bc` (`plz()`, `plznl()`, `pnlz()`, and
373  `pnlznl()`) to allow printing numbers with or without leading zeros, despite
374  the use of `-z` or not.
375* Added builtin functions to query global state like line length, global stacks,
376  and leading zeroes.
377* Added a command-line flag (`-L`) to disable wrapping when printing numbers.
378* Improved builds on Windows.
379
380## 5.0.2
381
382This is a production release with one fix for a flaky test. If you have not
383experienced problems with the test suite, you do ***NOT*** need to upgrade.
384
385The test was one that tested whether `bc` fails gracefully when it can't
386allocate memory. Unfortunately, there are cases when Linux and FreeBSD lie and
387pretend to allocate the memory.
388
389The reason they do this is because a lot of programs don't use all of the memory
390they allocate, so those OS's usually get away with it.
391
392However, this `bc` uses all of the memory it allocates (at least at page
393granularity), so when it tries to use the memory, FreeBSD and Linux kill it.
394
395This only happens sometimes, however. Other times (on my machine), they do, in
396fact, refuse the request.
397
398So I changed the test to not test for that because I think the graceful failure
399code won't really change much.
400
401## 5.0.1
402
403This is a production release with two fixes:
404
405* Fix for the build on Mac OSX.
406* Fix for the build on Android.
407
408Users that do not use those platforms do ***NOT*** need to update.
409
410## 5.0.0
411
412This is a major production release with several changes:
413
414* Added support for OpenBSD's `pledge()` and `unveil()`.
415* Fixed print bug where a backslash newline combo was printed even if only one
416  digit was left, something I blindly copied from GNU `bc`, like a fool.
417* Fixed bugs in the manuals.
418* Fixed a possible multiplication overflow in power.
419* Temporary numbers are garbage collected if allocation fails, and the
420  allocation is retried. This is to make `bc` and `dc` more resilient to running
421  out of memory.
422* Limited the number of temporary numbers and made the space for them static so
423  that allocating more space for them cannot fail.
424* Allowed integers with non-zero `scale` to be used with power, places, and
425  shift operators.
426* Added greatest common divisor and least common multiple to `lib2.bc`.
427* Added `SIGQUIT` handling to history.
428* Added a command to `dc` (`y`) to get the length of register stacks.
429* Fixed multi-digit bugs in `lib2.bc`.
430* Removed the no prompt build option.
431* Created settings that builders can set defaults for and users can set their
432  preferences for. This includes the `bc` banner, resetting on `SIGINT`, TTY
433  mode, and prompt.
434* Added history support to Windows.
435* Fixed bugs with the handling of register names in `dc`.
436* Fixed bugs with multi-line comments and strings in both calculators.
437* Added a new error type and message for `dc` when register stacks don't have
438  enough items.
439* Optimized string allocation.
440* Made `bc` and `dc` UTF-8 capable.
441* Fixed a bug with `void` functions.
442* Fixed a misspelled symbol in `bcl`. This is technically a breaking change,
443  which requires this to be `5.0.0`.
444* Added the ability for users to get the copyright banner back.
445* Added the ability for users to have `bc` and `dc` quit on `SIGINT`.
446* Added the ability for users to disable prompt and TTY mode by environment
447  variables.
448* Added the ability for users to redefine keywords. This is another reason this
449  is `5.0.0`.
450* Added `dc`'s modular exponentiation and divmod to `bc`.
451* Added the ability to assign strings to variables and array elements and pass
452  them to functions in `bc`.
453* Added `dc`'s asciify command and stream printing to `bc`.
454* Added a command to `dc` (`Y`) to get the length of an array.
455* Added a command to `dc` (`,`) to get the depth of the execution stack.
456* Added bitwise and, or, xor, left shift, right shift, reverse, left rotate,
457  right rotate, and mod functions to `lib2.bc`.
458* Added the functions `s2u(x)` and `s2un(x,n)`, to `lib2.bc`.
459
460## 4.0.2
461
462This is a production release that fixes two bugs:
463
4641.	If no files are used and the first statement on `stdin` is invalid, `scale`
465	would not be set to `20` even if `-l` was used.
4662.	When using history, `bc` failed to respond properly to `SIGSTOP` and
467	`SIGTSTP`.
468
469## 4.0.1
470
471This is a production release that only adds one thing: flushing output when it
472is printed with a print statement.
473
474## 4.0.0
475
476This is a production release with many fixes, a new command-line option, and a
477big surprise:
478
479* A bug was fixed in `dc`'s `P` command where the item on the stack was *not*
480  popped.
481* Various bugs in the manuals have been fixed.
482* A known bug was fixed where history did not interact well with prompts printed
483  by user code without newlines.
484* A new command-line option, `-R` and `--no-read-prompt` was added to disable
485  just the prompt when using `read()` (`bc`) or `?` (`dc`).
486* And finally, **official support for Windows was added**.
487
488The last item is why this is a major version bump.
489
490Currently, only one set of build options (extra math and prompt enabled, history
491and NLS/locale support disabled, both calculators enabled) is supported on
492Windows. However, both debug and release builds are supported.
493
494In addition, Windows builds are supported for the the library (`bcl`).
495
496For more details about how to build on Windows, see the [README][5] or the
497[build manual][13].
498
499## 3.3.4
500
501This is a production release that fixes a small bug.
502
503The bug was that output was not flushed before a `read()` call, so prompts
504without a newline on the end were not flushed before the `read()` call.
505
506This is such a tiny bug that users only need to upgrade if they are affected.
507
508## 3.3.3
509
510This is a production release with one tweak and fixes for manuals.
511
512The tweak is that `length(0)` returns `1` instead of `0`. In `3.3.1`, I changed
513it so `length(0.x)`, where `x` could be any number of digits, returned the
514`scale`, but `length(0)` still returned `0` because I believe that `0` has `0`
515significant digits.
516
517After request of FreeBSD and considering the arguments of a mathematician,
518compatibility with other `bc`'s, and the expectations of users, I decided to
519make the change.
520
521The fixes for manuals fixed a bug where `--` was rendered as `-`.
522
523## 3.3.2
524
525This is a production release that fixes a divide-by-zero bug in `root()` in the
526[extended math library][16]. All previous versions with `root()` have the bug.
527
528## 3.3.1
529
530This is a production release that fixes a bug.
531
532The bug was in the reporting of number length when the value was 0.
533
534## 3.3.0
535
536This is a production release that changes one behavior and fixes documentation
537bugs.
538
539The changed behavior is the treatment of `-e` and `-f` when given through
540`BC_ENV_ARGS` or `DC_ENV_ARGS`. Now `bc` and `dc` do not exit when those options
541(or their equivalents) are given through those environment variables. However,
542`bc` and `dc` still exit when they or their equivalents are given on the
543command-line.
544
545## 3.2.7
546
547This is a production release that removes a small non-portable shell operation
548in `configure.sh`. This problem was only noticed on OpenBSD, not FreeBSD or
549Linux.
550
551Non-OpenBSD users do ***NOT*** need to upgrade, although NetBSD users may also
552need to upgrade.
553
554## 3.2.6
555
556This is a production release that fixes the build on FreeBSD.
557
558There was a syntax error in `configure.sh` that the Linux shell did not catch,
559and FreeBSD depends on the existence of `tests/all.sh`.
560
561All users that already upgraded to `3.2.5` should update to this release, with
562my apologies for the poor release of `3.2.5`. Other users should skip `3.2.5` in
563favor of this version.
564
565## 3.2.5
566
567This is a production release that fixes several bugs and adds a couple small
568things.
569
570The two most important bugs were bugs that causes `dc` to access memory
571out-of-bounds (crash in debug builds). This was found by upgrading to `afl++`
572from `afl`. Both were caused by a failure to distinguish between the same two
573cases.
574
575Another bug was the failure to put all of the licenses in the `LICENSE.md` file.
576
577Third, some warnings by `scan-build` were found and eliminated. This needed one
578big change: `bc` and `dc` now bail out as fast as possible on fatal errors
579instead of unwinding the stack.
580
581Fourth, the pseudo-random number now attempts to seed itself with `/dev/random`
582if `/dev/urandom` fails.
583
584Finally, this release has a few quality-of-life changes to the build system. The
585usage should not change at all; the only thing that changed was making sure the
586`Makefile.in` was written to rebuild properly when headers changed and to not
587rebuild when not necessary.
588
589## 3.2.4
590
591This is a production release that fixes a warning on `gcc` 6 or older, which
592does not have an attribute that is used.
593
594Users do ***NOT*** need to upgrade if they don't use `gcc` 6 or older.
595
596## 3.2.3
597
598This is a production release that fixes a bug in `gen/strgen.sh`. I recently
599changed `gen/strgen.c`, but I did not change `gen/strgen.sh`.
600
601Users that do not use `gen/strgen.sh` do not need to upgrade.
602
603## 3.2.2
604
605This is a production release that fixes a portability bug in `configure.sh`. The
606bug was using the GNU `find` extension `-wholename`.
607
608## 3.2.1
609
610This is a production release that has one fix for `bcl(3)`. It is technically
611not a bug fix since the behavior is undefined, but the `BclNumber`s that
612`bcl_divmod()` returns will be set to `BCL_ERROR_INVALID_NUM` if there is an
613error. Previously, they were not set.
614
615## 3.2.0
616
617This is a production release that has one bug fix and a major addition.
618
619The bug fix was a missing `auto` variable in the bessel `j()` function in the
620math library.
621
622The major addition is a way to build a version of `bc`'s math code as a library.
623This is done with the `-a` option to `configure.sh`. The API for the library can
624be read in `./manuals/bcl.3.md` or `man bcl` once the library is installed with
625`make install`.
626
627This library was requested by developers before I even finished version 1.0, but
628I could not figure out how to do it until now.
629
630If the library has API breaking changes, the major version of `bc` will be
631incremented.
632
633## 3.1.6
634
635This is a production release that fixes a new warning from Clang 12 for FreeBSD
636and also removes some possible undefined behavior found by UBSan that compilers
637did not seem to take advantage of.
638
639Users do ***NOT*** need to upgrade, if they do not want to.
640
641## 3.1.5
642
643This is a production release that fixes the Chinese locales (which caused `bc`
644to crash) and a crash caused by `bc` executing code when it should not have been
645able to.
646
647***ALL USERS SHOULD UPGRADE.***
648
649## 3.1.4
650
651This is a production release that fixes one bug, changes two behaviors, and
652removes one environment variable.
653
654The bug is like the one in the last release except it applies if files are being
655executed. I also made the fix more general.
656
657The behavior that was changed is that `bc` now exits when given `-e`, `-f`,
658`--expression` or `--file`. However, if the last one of those is `-f-` (using
659`stdin` as the file), `bc` does not exit. If `-f-` exists and is not the last of
660the `-e` and `-f` options (and equivalents), `bc` gives a fatal error and exits.
661
662Next, I removed the `BC_EXPR_EXIT` and `DC_EXPR_EXIT` environment variables
663since their use is not needed with the behavior change.
664
665Finally, I made it so `bc` does not print the header, though the `-q` and
666`--quiet` options were kept for compatibility with GNU `bc`.
667
668## 3.1.3
669
670This is a production release that fixes one minor bug: if `bc` was invoked like
671the following, it would error:
672
673```
674echo "if (1 < 3) 1" | bc
675```
676
677Unless users run into this bug, they do not need to upgrade, but it is suggested
678that they do.
679
680## 3.1.2
681
682This is a production release that adds a way to install *all* locales. Users do
683***NOT*** need to upgrade.
684
685For package maintainers wishing to make use of the change, just pass `-l` to
686`configure.sh`.
687
688## 3.1.1
689
690This is a production release that adds two Spanish locales. Users do ***NOT***
691need to upgrade, unless they want those locales.
692
693## 3.1.0
694
695This is a production release that adjusts one behavior, fixes eight bugs, and
696improves manpages for FreeBSD. Because this release fixes bugs, **users and
697package maintainers should update to this version as soon as possible**.
698
699The behavior that was adjusted was how code from the `-e` and `-f` arguments
700(and equivalents) were executed. They used to be executed as one big chunk, but
701in this release, they are now executed line-by-line.
702
703The first bug fix in how output to `stdout` was handled in `SIGINT`. If a
704`SIGINT` came in, the `stdout` buffer was not correctly flushed. In fact, a
705clean-up function was not getting called. This release fixes that bug.
706
707The second bug is in how `dc` handled input from `stdin`. This affected `bc` as
708well since it was a mishandling of the `stdin` buffer.
709
710The third fixed bug was that `bc` and `dc` could `abort()` (in debug mode) when
711receiving a `SIGTERM`. This one was a race condition with pushing and popping
712items onto and out of vectors.
713
714The fourth bug fixed was that `bc` could leave extra items on the stack and
715thus, not properly clean up some memory. (The memory would still get
716`free()`'ed, but it would not be `free()`'ed when it could have been.)
717
718The next two bugs were bugs in `bc`'s parser that caused crashes when executing
719the resulting code.
720
721The last two bugs were crashes in `dc` that resulted from mishandling of
722strings.
723
724The manpage improvement was done by switching from [ronn][20] to [Pandoc][21] to
725generate manpages. Pandoc generates much cleaner manpages and doesn't leave
726blank lines where they shouldn't be.
727
728## 3.0.3
729
730This is a production release that adds one new feature: specific manpages.
731
732Before this release, `bc` and `dc` only used one manpage each that referred to
733various build options. This release changes it so there is one manpage set per
734relevant build type. Each manual only has information about its particular
735build, and `configure.sh` selects the correct set for install.
736
737## 3.0.2
738
739This is a production release that adds `utf8` locale symlinks and removes an
740unused `auto` variable from the `ceil()` function in the [extended math
741library][16].
742
743Users do ***NOT*** need to update unless they want the locales.
744
745## 3.0.1
746
747This is a production release with two small changes. Users do ***NOT*** need to
748upgrade to this release; however, if they haven't upgraded to `3.0.0` yet, it
749may be worthwhile to upgrade to this release.
750
751The first change is fixing a compiler warning on FreeBSD with strict warnings
752on.
753
754The second change is to make the new implementation of `ceil()` in `lib2.bc`
755much more efficient.
756
757## 3.0.0
758
759*Notes for package maintainers:*
760
761*First, the `2.7.0` release series saw a change in the option parsing. This made
762me change one error message and add a few others. The error message that was
763changed removed one format specifier. This means that `printf()` will seqfault
764on old locale files. Unfortunately, `bc` cannot use any locale files except the
765global ones that are already installed, so it will use the previous ones while
766running tests during install. **If `bc` segfaults while running arg tests when
767updating, it is because the global locale files have not been replaced. Make
768sure to either prevent the test suite from running on update or remove the old
769locale files before updating.** (Removing the locale files can be done with
770`make uninstall` or by running the [`locale_uninstall.sh`][22] script.) Once
771this is done, `bc` should install without problems.*
772
773*Second, **the option to build without signal support has been removed**. See
774below for the reasons why.*
775
776This is a production release with some small bug fixes, a few improvements,
777three major bug fixes, and a complete redesign of `bc`'s error and signal
778handling. **Users and package maintainers should update to this version as soon
779as possible.**
780
781The first major bug fix was in how `bc` executed files. Previously, a whole file
782was parsed before it was executed, but if a function is defined *after* code,
783especially if the function definition was actually a redefinition, and the code
784before the definition referred to the previous function, this `bc` would replace
785the function before executing any code. The fix was to make sure that all code
786that existed before a function definition was executed.
787
788The second major bug fix was in `bc`'s `lib2.bc`. The `ceil()` function had a
789bug where a `0` in the decimal place after the truncation position, caused it to
790output the wrong numbers if there was any non-zero digit after.
791
792The third major bug is that when passing parameters to functions, if an
793expression included an array (not an array element) as a parameter, it was
794accepted, when it should have been rejected. It is now correctly rejected.
795
796Beyond that, this `bc` got several improvements that both sped it up, improved
797the handling of signals, and improved the error handling.
798
799First, the requirements for `bc` were pushed back to POSIX 2008. `bc` uses one
800function, `strdup()`, which is not in POSIX 2001, and it is in the X/Open System
801Interfaces group 2001. It is, however, in POSIX 2008, and since POSIX 2008 is
802old enough to be supported anywhere that I care, that should be the requirement.
803
804Second, the `BcVm` global variable was put into `bss`. This actually slightly
805reduces the size of the executable from a massive code shrink, and it will stop
806`bc` from allocating a large set of memory when `bc` starts.
807
808Third, the default Karatsuba length was updated from 64 to 32 after making the
809optimization changes below, since 32 is going to be better than 64 after the
810changes.
811
812Fourth, Spanish translations were added.
813
814Fifth, the interpreter received a speedup to make performance on non-math-heavy
815scripts more competitive with GNU `bc`. While improvements did, in fact, get it
816much closer (see the [benchmarks][19]), it isn't quite there.
817
818There were several things done to speed up the interpreter:
819
820First, several small inefficiencies were removed. These inefficiencies included
821calling the function `bc_vec_pop(v)` twice instead of calling
822`bc_vec_npop(v, 2)`. They also included an extra function call for checking the
823size of the stack and checking the size of the stack more than once on several
824operations.
825
826Second, since the current `bc` function is the one that stores constants and
827strings, the program caches pointers to the current function's vectors of
828constants and strings to prevent needing to grab the current function in order
829to grab a constant or a string.
830
831Third, `bc` tries to reuse `BcNum`'s (the internal representation of
832arbitary-precision numbers). If a `BcNum` has the default capacity of
833`BC_NUM_DEF_SIZE` (32 on 64-bit and 16 on 32-bit) when it is freed, it is added
834to a list of available `BcNum`'s. And then, when a `BcNum` is allocated with a
835capacity of `BC_NUM_DEF_SIZE` and any `BcNum`'s exist on the list of reusable
836ones, one of those ones is grabbed instead.
837
838In order to support these changes, the `BC_NUM_DEF_SIZE` was changed. It used to
839be 16 bytes on all systems, but it was changed to more closely align with the
840minimum allocation size on Linux, which is either 32 bytes (64-bit musl), 24
841bytes (64-bit glibc), 16 bytes (32-bit musl), or 12 bytes (32-bit glibc). Since
842these are the minimum allocation sizes, these are the sizes that would be
843allocated anyway, making it worth it to just use the whole space, so the value
844of `BC_NUM_DEF_SIZE` on 64-bit systems was changed to 32 bytes.
845
846On top of that, at least on 64-bit, `BC_NUM_DEF_SIZE` supports numbers with
847either 72 integer digits or 45 integer digits and 27 fractional digits. This
848should be more than enough for most cases since `bc`'s default `scale` values
849are 0 or 20, meaning that, by default, it has at most 20 fractional digits. And
85045 integer digits are *a lot*; it's enough to calculate the amount of mass in
851the Milky Way galaxy in kilograms. Also, 72 digits is enough to calculate the
852diameter of the universe in Planck lengths.
853
854(For 32-bit, these numbers are either 32 integer digits or 12 integer digits and
85520 fractional digits. These are also quite big, and going much bigger on a
85632-bit system seems a little pointless since 12 digits is just under a trillion
857and 20 fractional digits is still enough for about any use since `10^-20` light
858years is just under a millimeter.)
859
860All of this together means that for ordinary uses, and even uses in scientific
861work, the default number size will be all that is needed, which means that
862nearly all, if not all, numbers will be reused, relieving pressure on the system
863allocator.
864
865I did several experiments to find the changes that had the most impact,
866especially with regard to reusing `BcNum`'s. One was putting `BcNum`'s into
867buckets according to their capacity in powers of 2 up to 512. That performed
868worse than `bc` did in `2.7.2`. Another was putting any `BcNum` on the reuse
869list that had a capacity of `BC_NUM_DEF_SIZE * 2` and reusing them for `BcNum`'s
870that requested `BC_NUM_DEF_SIZE`. This did reduce the amount of time spent, but
871it also spent a lot of time in the system allocator for an unknown reason. (When
872using `strace`, a bunch more `brk` calls showed up.) Just reusing `BcNum`'s that
873had exactly `BC_NUM_DEF_SIZE` capacity spent the smallest amount of time in both
874user and system time. This makes sense, especially with the changes to make
875`BC_NUM_DEF_SIZE` bigger on 64-bit systems, since the vast majority of numbers
876will only ever use numbers with a size less than or equal to `BC_NUM_DEF_SIZE`.
877
878Last of all, `bc`'s signal handling underwent a complete redesign. (This is the
879reason that this version is `3.0.0` and not `2.8.0`.) The change was to move
880from a polling approach to signal handling to an interrupt-based approach.
881
882Previously, every single loop condition had a check for signals. I suspect that
883this could be expensive when in tight loops.
884
885Now, the signal handler just uses `longjmp()` (actually `siglongjmp()`) to start
886an unwinding of the stack until it is stopped or the stack is unwound to
887`main()`, which just returns. If `bc` is currently executing code that cannot be
888safely interrupted (according to POSIX), then signals are "locked." The signal
889handler checks if the lock is taken, and if it is, it just sets the status to
890indicate that a signal arrived. Later, when the signal lock is released, the
891status is checked to see if a signal came in. If so, the stack unwinding starts.
892
893This design eliminates polling in favor of maintaining a stack of `jmp_buf`'s.
894This has its own performance implications, but it gives better interaction. And
895the cost of pushing and popping a `jmp_buf` in a function is paid at most twice.
896Most functions do not pay that price, and most of the rest only pay it once.
897(There are only some 3 functions in `bc` that push and pop a `jmp_buf` twice.)
898
899As a side effect of this change, I had to eliminate the use of `stdio.h` in `bc`
900because `stdio` does not play nice with signals and `longjmp()`. I implemented
901custom I/O buffer code that takes a fraction of the size. This means that static
902builds will be smaller, but non-static builds will be bigger, though they will
903have less linking time.
904
905This change is also good because my history implementation was already bypassing
906`stdio` for good reasons, and unifying the architecture was a win.
907
908Another reason for this change is that my `bc` should *always* behave correctly
909in the presence of signals like `SIGINT`, `SIGTERM`, and `SIGQUIT`. With the
910addition of my own I/O buffering, I needed to also make sure that the buffers
911were correctly flushed even when such signals happened.
912
913For this reason, I **removed the option to build without signal support**.
914
915As a nice side effect of this change, the error handling code could be changed
916to take advantage of the stack unwinding that signals used. This means that
917signals and error handling use the same code paths, which means that the stack
918unwinding is well-tested. (Errors are tested heavily in the test suite.)
919
920It also means that functions do not need to return a status code that
921***every*** caller needs to check. This eliminated over 100 branches that simply
922checked return codes and then passed that return code up the stack if necessary.
923The code bloat savings from this is at least 1700 bytes on `x86_64`, *before*
924taking into account the extra code from removing `stdio.h`.
925
926## 2.7.2
927
928This is a production release with one major bug fix.
929
930The `length()` built-in function can take either a number or an array. If it
931takes an array, it returns the length of the array. Arrays can be passed by
932reference. The bug is that the `length()` function would not properly
933dereference arrays that were references. This is a bug that affects all users.
934
935**ALL USERS SHOULD UPDATE `bc`**.
936
937## 2.7.1
938
939This is a production release with fixes for new locales and fixes for compiler
940warnings on FreeBSD.
941
942## 2.7.0
943
944This is a production release with a bug fix for Linux, new translations, and new
945features.
946
947Bug fixes:
948
949* Option parsing in `BC_ENV_ARGS` was broken on Linux in 2.6.1 because `glibc`'s
950  `getopt_long()` is broken. To get around that, and to support long options on
951  every platform, an adapted version of [`optparse`][17] was added. Now, `bc`
952  does not even use `getopt()`.
953* Parsing `BC_ENV_ARGS` with quotes now works. It isn't the smartest, but it
954  does the job if there are spaces in file names.
955
956The following new languages are supported:
957
958* Dutch
959* Polish
960* Russian
961* Japanes
962* Simplified Chinese
963
964All of these translations were generated using [DeepL][18], so improvements are
965welcome.
966
967There is only one new feature: **`bc` now has a built-in pseudo-random number
968generator** (PRNG).
969
970The PRNG is seeded, making it useful for applications where
971`/dev/urandom` does not work because output needs to be reproducible. However,
972it also uses `/dev/urandom` to seed itself by default, so it will start with a
973good seed by default.
974
975It also outputs 32 bits on 32-bit platforms and 64 bits on 64-bit platforms, far
976better than the 15 bits of C's `rand()` and `bash`'s `$RANDOM`.
977
978In addition, the PRNG can take a bound, and when it gets a bound, it
979automatically adjusts to remove bias. It can also generate numbers of arbitrary
980size. (As of the time of release, the largest pseudo-random number generated by
981this `bc` was generated with a bound of `2^(2^20)`.)
982
983***IMPORTANT: read the [`bc` manual][9] and the [`dc` manual][10] to find out
984exactly what guarantees the PRNG provides. The underlying implementation is not
985guaranteed to stay the same, but the guarantees that it provides are guaranteed
986to stay the same regardless of the implementation.***
987
988On top of that, four functions were added to `bc`'s [extended math library][16]
989to make using the PRNG easier:
990
991* `frand(p)`: Generates a number between `[0,1)` to `p` decimal places.
992* `ifrand(i, p)`: Generates an integer with bound `i` and adds it to `frand(p)`.
993* `srand(x)`: Randomizes the sign of `x`. In other words, it flips the sign of
994  `x` with probability `0.5`.
995* `brand()`: Returns a random boolean value (either `0` or `1`).
996
997## 2.6.1
998
999This is a production release with a bug fix for FreeBSD.
1000
1001The bug was that when `bc` was built without long options, it would give a fatal
1002error on every run. This was caused by a mishandling of `optind`.
1003
1004## 2.6.0
1005
1006This release is a production release ***with no bugfixes***. If you do not want
1007to upgrade, you don't have to.
1008
1009No source code changed; the only thing that changed was `lib2.bc`.
1010
1011This release adds one function to the [extended math library][16]: `p(x, y)`,
1012which calculates `x` to the power of `y`, whether or not `y` is an integer. (The
1013`^` operator can only accept integer powers.)
1014
1015This release also includes a couple of small tweaks to the [extended math
1016library][16], mostly to fix returning numbers with too high of `scale`.
1017
1018## 2.5.3
1019
1020This release is a production release which addresses inconsistencies in the
1021Portuguese locales. No `bc` code was changed.
1022
1023The issues were that the ISO files used different naming, and also that the
1024files that should have been symlinks were not. I did not catch that because
1025GitHub rendered them the exact same way.
1026
1027## 2.5.2
1028
1029This release is a production release.
1030
1031No code was changed, but the build system was changed to allow `CFLAGS` to be
1032given to `CC`, like this:
1033
1034```
1035CC="gcc -O3 -march=native" ./configure.sh
1036```
1037
1038If this happens, the flags are automatically put into `CFLAGS`, and the compiler
1039is set appropriately. In the example above this means that `CC` will be "gcc"
1040and `CFLAGS` will be "-O3 -march=native".
1041
1042This behavior was added to conform to GNU autotools practices.
1043
1044## 2.5.1
1045
1046This is a production release which addresses portability concerns discovered
1047in the `bc` build system. No `bc` code was changed.
1048
1049* Support for Solaris SPARC and AIX were added.
1050* Minor documentations edits were performed.
1051* An option for `configure.sh` was added to disable long options if
1052  `getopt_long()` is missing.
1053
1054## 2.5.0
1055
1056This is a production release with new translations. No code changed.
1057
1058The translations were contributed by [bugcrazy][15], and they are for
1059Portuguese, both Portugal and Brazil locales.
1060
1061## 2.4.0
1062
1063This is a production release primarily aimed at improving `dc`.
1064
1065* A couple of copy and paste errors in the [`dc` manual][10] were fixed.
1066* `dc` startup was optimized by making sure it didn't have to set up `bc`-only
1067  things.
1068* The `bc` `&&` and `||` operators were made available to `dc` through the `M`
1069  and `m` commands, respectively.
1070* `dc` macros were changed to be tail call-optimized.
1071
1072The last item, tail call optimization, means that if the last thing in a macro
1073is a call to another macro, then the old macro is popped before executing the
1074new macro. This change was made to stop `dc` from consuming more and more memory
1075as macros are executed in a loop.
1076
1077The `q` and `Q` commands still respect the "hidden" macros by way of recording
1078how many macros were removed by tail call optimization.
1079
1080## 2.3.2
1081
1082This is a production release meant to fix warnings in the Gentoo `ebuild` by
1083making it possible to disable binary stripping. Other users do *not* need to
1084upgrade.
1085
1086## 2.3.1
1087
1088This is a production release. It fixes a bug that caused `-1000000000 < -1` to
1089return `0`. This only happened with negative numbers and only if the value on
1090the left was more negative by a certain amount. That said, this bug *is* a bad
1091bug, and needs to be fixed.
1092
1093**ALL USERS SHOULD UPDATE `bc`**.
1094
1095## 2.3.0
1096
1097This is a production release with changes to the build system.
1098
1099## 2.2.0
1100
1101This release is a production release. It only has new features and performance
1102improvements.
1103
11041.	The performance of `sqrt(x)` was improved.
11052.	The new function `root(x, n)` was added to the extended math library to
1106	calculate `n`th roots.
11073.	The new function `cbrt(x)` was added to the extended math library to
1108	calculate cube roots.
1109
1110## 2.1.3
1111
1112This is a non-critical release; it just changes the build system, and in
1113non-breaking ways:
1114
11151.	Linked locale files were changed to link to their sources with a relative
1116	link.
11172.	A bug in `configure.sh` that caused long option parsing to fail under `bash`
1118	was fixed.
1119
1120## 2.1.2
1121
1122This release is not a critical release.
1123
11241.	A few codes were added to history.
11252.	Multiplication was optimized a bit more.
11263.	Addition and subtraction were both optimized a bit more.
1127
1128## 2.1.1
1129
1130This release contains a fix for the test suite made for Linux from Scratch: now
1131the test suite prints `pass` when a test is passed.
1132
1133Other than that, there is no change in this release, so distros and other users
1134do not need to upgrade.
1135
1136## 2.1.0
1137
1138This release is a production release.
1139
1140The following bugs were fixed:
1141
11421.	A `dc` bug that caused stack mishandling was fixed.
11432.	A warning on OpenBSD was fixed.
11443.	Bugs in `ctrl+arrow` operations in history were fixed.
11454.	The ability to paste multiple lines in history was added.
11465.	A `bc` bug, mishandling of array arguments to functions, was fixed.
11476.	A crash caused by freeing the wrong pointer was fixed.
11487.	A `dc` bug where strings, in a rare case, were mishandled in parsing was
1149	fixed.
1150
1151In addition, the following changes were made:
1152
11531.	Division was slightly optimized.
11542.	An option was added to the build to disable printing of prompts.
11553.	The special case of empty arguments is now handled. This is to prevent
1156	errors in scripts that end up passing empty arguments.
11574.	A harmless bug was fixed. This bug was that, with the pop instructions
1158	(mostly) removed (see below), `bc` would leave extra values on its stack for
1159	`void` functions and in a few other cases. These extra items would not
1160	affect anything put on the stack and would not cause any sort of crash or
1161	even buggy behavior, but they would cause `bc` to take more memory than it
1162	needed.
1163
1164On top of the above changes, the following optimizations were added:
1165
11661.	The need for pop instructions in `bc` was removed.
11672.	Extra tests on every iteration of the interpreter loop were removed.
11683.	Updating function and code pointers on every iteration of the interpreter
1169	loop was changed to only updating them when necessary.
11704.	Extra assignments to pointers were removed.
1171
1172Altogether, these changes sped up the interpreter by around 2x.
1173
1174***NOTE***: This is the last release with new features because this `bc` is now
1175considered complete. From now on, only bug fixes and new translations will be
1176added to this `bc`.
1177
1178## 2.0.3
1179
1180This is a production, bug-fix release.
1181
1182Two bugs were fixed in this release:
1183
11841.	A rare and subtle signal handling bug was fixed.
11852.	A misbehavior on `0` to a negative power was fixed.
1186
1187The last bug bears some mentioning.
1188
1189When I originally wrote power, I did not thoroughly check its error cases;
1190instead, I had it check if the first number was `0` and then if so, just return
1191`0`. However, `0` to a negative power means that `1` will be divided by `0`,
1192which is an error.
1193
1194I caught this, but only after I stopped being cocky. You see, sometime later, I
1195had noticed that GNU `bc` returned an error, correctly, but I thought it was
1196wrong simply because that's not what my `bc` did. I saw it again later and had a
1197double take. I checked for real, finally, and found out that my `bc` was wrong
1198all along.
1199
1200That was bad on me. But the bug was easy to fix, so it is fixed now.
1201
1202There are two other things in this release:
1203
12041.	Subtraction was optimized by [Stefan Eßer][14].
12052.	Division was also optimized, also by Stefan Eßer.
1206
1207## 2.0.2
1208
1209This release contains a fix for a possible overflow in the signal handling. I
1210would be surprised if any users ran into it because it would only happen after 2
1211billion (`2^31-1`) `SIGINT`'s, but I saw it and had to fix it.
1212
1213## 2.0.1
1214
1215This release contains very few things that will apply to any users.
1216
12171.	A slight bug in `dc`'s interactive mode was fixed.
12182.	A bug in the test suite that was only triggered on NetBSD was fixed.
12193.	**The `-P`/`--no-prompt` option** was added for users that do not want a
1220	prompt.
12214.	A `make check` target was added as an alias for `make test`.
12225.	`dc` got its own read prompt: `?> `.
1223
1224## 2.0.0
1225
1226This release is a production release.
1227
1228This release is also a little different from previous releases. From here on
1229out, I do not plan on adding any more features to this `bc`; I believe that it
1230is complete. However, there may be bug fix releases in the future, if I or any
1231others manage to find bugs.
1232
1233This release has only a few new features:
1234
12351.	`atan2(y, x)` was added to the extended math library as both `a2(y, x)` and
1236	`atan2(y, x)`.
12372.	Locales were fixed.
12383.	A **POSIX shell-compatible script was added as an alternative to compiling
1239	`gen/strgen.c`** on a host machine. More details about making the choice
1240	between the two can be found by running `./configure.sh --help` or reading
1241	the [build manual][13].
12424.	Multiplication was optimized by using **diagonal multiplication**, rather
1243	than straight brute force.
12445.	The `locale_install.sh` script was fixed.
12456.	`dc` was given the ability to **use the environment variable
1246	`DC_ENV_ARGS`**.
12477.	`dc` was also given the ability to **use the `-i` or `--interactive`**
1248	options.
12498.	Printing the prompt was fixed so that it did not print when it shouldn't.
12509.	Signal handling was fixed.
125110.	**Handling of `SIGTERM` and `SIGQUIT`** was fixed.
125211.	The **built-in functions `maxibase()`, `maxobase()`, and `maxscale()`** (the
1253	commands `T`, `U`, `V` in `dc`, respectively) were added to allow scripts to
1254	query for the max allowable values of those globals.
125512.	Some incompatibilities with POSIX were fixed.
1256
1257In addition, this release is `2.0.0` for a big reason: the internal format for
1258numbers changed. They used to be a `char` array. Now, they are an array of
1259larger integers, packing more decimal digits into each integer. This has
1260delivered ***HUGE*** performance improvements, especially for multiplication,
1261division, and power.
1262
1263This `bc` should now be the fastest `bc` available, but I may be wrong.
1264
1265## 1.2.8
1266
1267This release contains a fix for a harmless bug (it is harmless in that it still
1268works, but it just copies extra data) in the [`locale_install.sh`][12] script.
1269
1270## 1.2.7
1271
1272This version contains fixes for the build on Arch Linux.
1273
1274## 1.2.6
1275
1276This release removes the use of `local` in shell scripts because it's not POSIX
1277shell-compatible, and also updates a man page that should have been updated a
1278long time ago but was missed.
1279
1280## 1.2.5
1281
1282This release contains some missing locale `*.msg` files.
1283
1284## 1.2.4
1285
1286This release contains a few bug fixes and new French translations.
1287
1288## 1.2.3
1289
1290This release contains a fix for a bug: use of uninitialized data. Such data was
1291only used when outputting an error message, but I am striving for perfection. As
1292Michelangelo said, "Trifles make perfection, and perfection is no trifle."
1293
1294## 1.2.2
1295
1296This release contains fixes for OpenBSD.
1297
1298## 1.2.1
1299
1300This release contains bug fixes for some rare bugs.
1301
1302## 1.2.0
1303
1304This is a production release.
1305
1306There have been several changes since `1.1.0`:
1307
13081.	The build system had some changes.
13092.	Locale support has been added. (Patches welcome for translations.)
13103.	**The ability to turn `ibase`, `obase`, and `scale` into stacks** was added
1311	with the `-g` command-line option. (See the [`bc` manual][9] for more
1312	details.)
13134.	Support for compiling on Mac OSX out of the box was added.
13145.	The extended math library got `t(x)`, `ceil(x)`, and some aliases.
13156.	The extended math library also got `r2d(x)` (for converting from radians to
1316	degrees) and `d2r(x)` (for converting from degrees to radians). This is to
1317	allow using degrees with the standard library.
13187.	Both calculators now accept numbers in **scientific notation**. See the
1319	[`bc` manual][9] and the [`dc` manual][10] for details.
13208.	Both calculators can **output in either scientific or engineering
1321	notation**. See the [`bc` manual][9] and the [`dc` manual][10] for details.
13229.	Some inefficiencies were removed.
132310.	Some bugs were fixed.
132411.	Some bugs in the extended library were fixed.
132512.	Some defects from [Coverity Scan][11] were fixed.
1326
1327## 1.1.4
1328
1329This release contains a fix to the build system that allows it to build on older
1330versions of `glibc`.
1331
1332## 1.1.3
1333
1334This release contains a fix for a bug in the test suite where `bc` tests and
1335`dc` tests could not be run in parallel.
1336
1337## 1.1.2
1338
1339This release has a fix for a history bug; the down arrow did not work.
1340
1341## 1.1.1
1342
1343This release fixes a bug in the `1.1.0` build system. The source is exactly the
1344same.
1345
1346The bug that was fixed was a failure to install if no `EXECSUFFIX` was used.
1347
1348## 1.1.0
1349
1350This is a production release. However, many new features were added since `1.0`.
1351
13521.	**The build system has been changed** to use a custom, POSIX
1353	shell-compatible configure script ([`configure.sh`][6]) to generate a POSIX
1354	make-compatible `Makefile`, which means that `bc` and `dc` now build out of
1355	the box on any POSIX-compatible system.
13562.	Out-of-memory and output errors now cause the `bc` to report the error,
1357	clean up, and die, rather than just reporting and trying to continue.
13583.	**Strings and constants are now garbage collected** when possible.
13594.	Signal handling and checking has been made more simple and more thorough.
13605.	`BcGlobals` was refactored into `BcVm` and `BcVm` was made global. Some
1361	procedure names were changed to reflect its difference to everything else.
13626.	Addition got a speed improvement.
13637.	Some common code for addition and multiplication was refactored into its own
1364	procedure.
13658.	A bug was removed where `dc` could have been selected, but the internal
1366	`#define` that returned `true` for a query about `dc` would not have
1367	returned `true`.
13689.	Useless calls to `bc_num_zero()` were removed.
136910.	**History support was added.** The history support is based off of a
1370	[UTF-8 aware fork][7] of [`linenoise`][8], which has been customized with
1371	`bc`'s own data structures and signal handling.
137211.	Generating C source from the math library now removes tabs from the library,
1373	shrinking the size of the executable.
137412.	The math library was shrunk.
137513.	Error handling and reporting was improved.
137614.	Reallocations were reduced by giving access to the request size for each
1377	operation.
137815.	**`abs()` (`b` command for `dc`) was added as a builtin.**
137916.	Both calculators were tested on FreeBSD.
138017.	Many obscure parse bugs were fixed.
138118.	Markdown and man page manuals were added, and the man pages are installed by
1382	`make install`.
138319.	Executable size was reduced, though the added features probably made the
1384	executable end up bigger.
138520.	**GNU-style array references were added as a supported feature.**
138621.	Allocations were reduced.
138722.	**New operators were added**: `$` (`$` for `dc`), `@` (`@` for `dc`), `@=`,
1388	`<<` (`H` for `dc`), `<<=`, `>>` (`h` for `dc`), and `>>=`. See the
1389	[`bc` manual][9] and the [`dc` manual][10] for more details.
139023.	**An extended math library was added.** This library contains code that
1391	makes it so I can replace my desktop calculator with this `bc`. See the
1392	[`bc` manual][3] for more details.
139324.	Support for all capital letters as numbers was added.
139425.	**Support for GNU-style void functions was added.**
139526.	A bug fix for improper handling of function parameters was added.
139627.	Precedence for the or (`||`) operator was changed to match GNU `bc`.
139728.	`dc` was given an explicit negation command.
139829.	`dc` was changed to be able to handle strings in arrays.
1399
1400## 1.1 Release Candidate 3
1401
1402This release is the eighth release candidate for 1.1, though it is the third
1403release candidate meant as a general release candidate. The new code has not
1404been tested as thoroughly as it should for release.
1405
1406## 1.1 Release Candidate 2
1407
1408This release is the seventh release candidate for 1.1, though it is the second
1409release candidate meant as a general release candidate. The new code has not
1410been tested as thoroughly as it should for release.
1411
1412## 1.1 FreeBSD Beta 5
1413
1414This release is the sixth release candidate for 1.1, though it is the fifth
1415release candidate meant specifically to test if `bc` works on FreeBSD. The new
1416code has not been tested as thoroughly as it should for release.
1417
1418## 1.1 FreeBSD Beta 4
1419
1420This release is the fifth release candidate for 1.1, though it is the fourth
1421release candidate meant specifically to test if `bc` works on FreeBSD. The new
1422code has not been tested as thoroughly as it should for release.
1423
1424## 1.1 FreeBSD Beta 3
1425
1426This release is the fourth release candidate for 1.1, though it is the third
1427release candidate meant specifically to test if `bc` works on FreeBSD. The new
1428code has not been tested as thoroughly as it should for release.
1429
1430## 1.1 FreeBSD Beta 2
1431
1432This release is the third release candidate for 1.1, though it is the second
1433release candidate meant specifically to test if `bc` works on FreeBSD. The new
1434code has not been tested as thoroughly as it should for release.
1435
1436## 1.1 FreeBSD Beta 1
1437
1438This release is the second release candidate for 1.1, though it is meant
1439specifically to test if `bc` works on FreeBSD. The new code has not been tested as
1440thoroughly as it should for release.
1441
1442## 1.1 Release Candidate 1
1443
1444This is the first release candidate for 1.1. The new code has not been tested as
1445thoroughly as it should for release.
1446
1447## 1.0
1448
1449This is the first non-beta release. `bc` is ready for production use.
1450
1451As such, a lot has changed since 0.5.
1452
14531.	`dc` has been added. It has been tested even more thoroughly than `bc` was
1454	for `0.5`. It does not have the `!` command, and for security reasons, it
1455	never will, so it is complete.
14562.	`bc` has been more thoroughly tested. An entire section of the test suite
1457	(for both programs) has been added to test for errors.
14583.	A prompt (`>>> `) has been added for interactive mode, making it easier to
1459	see inputs and outputs.
14604.	Interrupt handling has been improved, including elimination of race
1461	conditions (as much as possible).
14625.	MinGW and [Windows Subsystem for Linux][1] support has been added (see
1463	[xstatic][2] for binaries).
14646.	Memory leaks and errors have been eliminated (as far as ASan and Valgrind
1465	can tell).
14667.	Crashes have been eliminated (as far as [afl][3] can tell).
14678.	Karatsuba multiplication was added (and thoroughly) tested, speeding up
1468	multiplication and power by orders of magnitude.
14699.	Performance was further enhanced by using a "divmod" function to reduce
1470	redundant divisions and by removing superfluous `memset()` calls.
147110.	To switch between Karatsuba and `O(n^2)` multiplication, the config variable
1472	`BC_NUM_KARATSUBA_LEN` was added. It is set to a sane default, but the
1473	optimal number can be found with [`karatsuba.py`][4] (requires Python 3)
1474	and then configured through `make`.
147511.	The random math test generator script was changed to Python 3 and improved.
1476	`bc` and `dc` have together been run through 30+ million random tests.
147712.	All known math bugs have been fixed, including out of control memory
1478	allocations in `sine` and `cosine` (that was actually a parse bug), certain
1479	cases of infinite loop on square root, and slight inaccuracies (as much as
1480	possible; see the [README][5]) in transcendental functions.
148113.	Parsing has been fixed as much as possible.
148214.	Test coverage was improved to 94.8%. The only paths not covered are ones
1483	that happen when `malloc()` or `realloc()` fails.
148415.	An extension to get the length of an array was added.
148516.	The boolean not (`!`) had its precedence change to match negation.
148617.	Data input was hardened.
148718.	`bc` was made fully compliant with POSIX when the `-s` flag is used or
1488	`POSIXLY_CORRECT` is defined.
148919.	Error handling was improved.
149020.	`bc` now checks that files it is given are not directories.
1491
1492## 1.0 Release Candidate 7
1493
1494This is the seventh release candidate for 1.0. It fixes a few bugs in 1.0
1495Release Candidate 6.
1496
1497## 1.0 Release Candidate 6
1498
1499This is the sixth release candidate for 1.0. It fixes a few bugs in 1.0 Release
1500Candidate 5.
1501
1502## 1.0 Release Candidate 5
1503
1504This is the fifth release candidate for 1.0. It fixes a few bugs in 1.0 Release
1505Candidate 4.
1506
1507## 1.0 Release Candidate 4
1508
1509This is the fourth release candidate for 1.0. It fixes a few bugs in 1.0 Release
1510Candidate 3.
1511
1512## 1.0 Release Candidate 3
1513
1514This is the third release candidate for 1.0. It fixes a few bugs in 1.0 Release
1515Candidate 2.
1516
1517## 1.0 Release Candidate 2
1518
1519This is the second release candidate for 1.0. It fixes a few bugs in 1.0 Release
1520Candidate 1.
1521
1522## 1.0 Release Candidate 1
1523
1524This is the first Release Candidate for 1.0. `bc` is complete, with `dc`, but it
1525is not tested.
1526
1527## 0.5
1528
1529This beta release completes more features, but it is still not complete nor
1530tested as thoroughly as necessary.
1531
1532## 0.4.1
1533
1534This beta release fixes a few bugs in 0.4.
1535
1536## 0.4
1537
1538This is a beta release. It does not have the complete set of features, and it is
1539not thoroughly tested.
1540
1541[1]: https://docs.microsoft.com/en-us/windows/wsl/install-win10
1542[2]: https://pkg.musl.cc/bc/
1543[3]: http://lcamtuf.coredump.cx/afl/
1544[4]: ./scripts/karatsuba.py
1545[5]: ./README.md
1546[6]: ./configure.sh
1547[7]: https://github.com/rain-1/linenoise-mob
1548[8]: https://github.com/antirez/linenoise
1549[9]: ./manuals/bc/A.1.md
1550[10]: ./manuals/dc/A.1.md
1551[11]: https://scan.coverity.com/projects/gavinhoward-bc
1552[12]: ./scripts/locale_install.sh
1553[13]: ./manuals/build.md
1554[14]: https://github.com/stesser
1555[15]: https://github.com/bugcrazy
1556[16]: ./manuals/bc/A.1.md#extended-library
1557[17]: https://github.com/skeeto/optparse
1558[18]: https://www.deepl.com/translator
1559[19]: ./manuals/benchmarks.md
1560[20]: https://github.com/apjanke/ronn-ng
1561[21]: https://pandoc.org/
1562[22]: ./scripts/locale_uninstall.sh
1563