xref: /freebsd/contrib/bc/NEWS.md (revision 5ac01ce026aa871e24065f931b5b5c36024c96f9)
1# News
2
3## 3.1.5
4
5This is a production release that fixes the Chinese locales (which caused `bc`
6to crash) and a crash caused by `bc` executing code when it should not have been
7able to.
8
9***ALL USERS SHOULD UPGRADE.***
10
11## 3.1.4
12
13This is a production release that fixes one bug, changes two behaviors, and
14removes one environment variable.
15
16The bug is like the one in the last release except it applies if files are being
17executed. I also made the fix more general.
18
19The behavior that was changed is that `bc` now exits when given `-e`, `-f`,
20`--expression` or `--file`. However, if the last one of those is `-f-` (using
21`stdin` as the file), `bc` does not exit. If `-f-` exists and is not the last of
22the `-e` and `-f` options (and equivalents), `bc` gives a fatal error and exits.
23
24Next, I removed the `BC_EXPR_EXIT` and `DC_EXPR_EXIT` environment variables
25since their use is not needed with the behavior change.
26
27Finally, I made it so `bc` does not print the header, though the `-q` and
28`--quiet` options were kept for compatibility with GNU `bc`.
29
30## 3.1.3
31
32This is a production release that fixes one minor bug: if `bc` was invoked like
33the following, it would error:
34
35```
36echo "if (1 < 3) 1" | bc
37```
38
39Unless users run into this bug, they do not need to upgrade, but it is suggested
40that they do.
41
42## 3.1.2
43
44This is a production release that adds a way to install *all* locales. Users do
45***NOT*** need to upgrade.
46
47For package maintainers wishing to make use of the change, just pass `-l` to
48`configure.sh`.
49
50## 3.1.1
51
52This is a production release that adds two Spanish locales. Users do ***NOT***
53need to upgrade, unless they want those locales.
54
55## 3.1.0
56
57This is a production release that adjusts one behavior, fixes eight bugs, and
58improves manpages for FreeBSD. Because this release fixes bugs, **users and
59package maintainers should update to this version as soon as possible**.
60
61The behavior that was adjusted was how code from the `-e` and `-f` arguments
62(and equivalents) were executed. They used to be executed as one big chunk, but
63in this release, they are now executed line-by-line.
64
65The first bug fix in how output to `stdout` was handled in `SIGINT`. If a
66`SIGINT` came in, the `stdout` buffer was not correctly flushed. In fact, a
67clean-up function was not getting called. This release fixes that bug.
68
69The second bug is in how `dc` handled input from `stdin`. This affected `bc` as
70well since it was a mishandling of the `stdin` buffer.
71
72The third fixed bug was that `bc` and `dc` could `abort()` (in debug mode) when
73receiving a `SIGTERM`. This one was a race condition with pushing and popping
74items onto and out of vectors.
75
76The fourth bug fixed was that `bc` could leave extra items on the stack and
77thus, not properly clean up some memory. (The memory would still get
78`free()`'ed, but it would not be `free()`'ed when it could have been.)
79
80The next two bugs were bugs in `bc`'s parser that caused crashes when executing
81the resulting code.
82
83The last two bugs were crashes in `dc` that resulted from mishandling of
84strings.
85
86The manpage improvement was done by switching from [ronn][20] to [Pandoc][21] to
87generate manpages. Pandoc generates much cleaner manpages and doesn't leave
88blank lines where they shouldn't be.
89
90## 3.0.3
91
92This is a production release that adds one new feature: specific manpages.
93
94Before this release, `bc` and `dc` only used one manpage each that referred to
95various build options. This release changes it so there is one manpage set per
96relevant build type. Each manual only has information about its particular
97build, and `configure.sh` selects the correct set for install.
98
99## 3.0.2
100
101This is a production release that adds `utf8` locale symlinks and removes an
102unused `auto` variable from the `ceil()` function in the [extended math
103library][16].
104
105Users do ***NOT*** need to update unless they want the locales.
106
107## 3.0.1
108
109This is a production release with two small changes. Users do ***NOT*** need to
110upgrade to this release; however, if they haven't upgraded to `3.0.0` yet, it
111may be worthwhile to upgrade to this release.
112
113The first change is fixing a compiler warning on FreeBSD with strict warnings
114on.
115
116The second change is to make the new implementation of `ceil()` in `lib2.bc`
117much more efficient.
118
119## 3.0.0
120
121*Notes for package maintainers:*
122
123*First, the `2.7.0` release series saw a change in the option parsing. This made
124me change one error message and add a few others. The error message that was
125changed removed one format specifier. This means that `printf()` will seqfault
126on old locale files. Unfortunately, `bc` cannot use any locale files except the
127global ones that are already installed, so it will use the previous ones while
128running tests during install. **If `bc` segfaults while running arg tests when
129updating, it is because the global locale files have not been replaced. Make
130sure to either prevent the test suite from running on update or remove the old
131locale files before updating.** (Removing the locale files can be done with
132`make uninstall` or by running the `locale_uninstall.sh` script.) Once this is
133done, `bc` should install without problems.*
134
135*Second, **the option to build without signal support has been removed**. See
136below for the reasons why.*
137
138This is a production release with some small bug fixes, a few improvements,
139three major bug fixes, and a complete redesign of `bc`'s error and signal
140handling. **Users and package maintainers should update to this version as soon
141as possible.**
142
143The first major bug fix was in how `bc` executed files. Previously, a whole file
144was parsed before it was executed, but if a function is defined *after* code,
145especially if the function definition was actually a redefinition, and the code
146before the definition referred to the previous function, this `bc` would replace
147the function before executing any code. The fix was to make sure that all code
148that existed before a function definition was executed.
149
150The second major bug fix was in `bc`'s `lib2.bc`. The `ceil()` function had a
151bug where a `0` in the decimal place after the truncation position, caused it to
152output the wrong numbers if there was any non-zero digit after.
153
154The third major bug is that when passing parameters to functions, if an
155expression included an array (not an array element) as a parameter, it was
156accepted, when it should have been rejected. It is now correctly rejected.
157
158Beyond that, this `bc` got several improvements that both sped it up, improved
159the handling of signals, and improved the error handling.
160
161First, the requirements for `bc` were pushed back to POSIX 2008. `bc` uses one
162function, `strdup()`, which is not in POSIX 2001, and it is in the X/Open System
163Interfaces group 2001. It is, however, in POSIX 2008, and since POSIX 2008 is
164old enough to be supported anywhere that I care, that should be the requirement.
165
166Second, the BcVm global variable was put into `bss`. This actually slightly
167reduces the size of the executable from a massive code shrink, and it will stop
168`bc` from allocating a large set of memory when `bc` starts.
169
170Third, the default Karatsuba length was updated from 64 to 32 after making the
171optimization changes below, since 32 is going to be better than 64 after the
172changes.
173
174Fourth, Spanish translations were added.
175
176Fifth, the interpreter received a speedup to make performance on non-math-heavy
177scripts more competitive with GNU `bc`. While improvements did, in fact, get it
178much closer (see the [benchmarks][19]), it isn't quite there.
179
180There were several things done to speed up the interpreter:
181
182First, several small inefficiencies were removed. These inefficiencies included
183calling the function `bc_vec_pop(v)` twice instead of calling
184`bc_vec_npop(v, 2)`. They also included an extra function call for checking the
185size of the stack and checking the size of the stack more than once on several
186operations.
187
188Second, since the current `bc` function is the one that stores constants and
189strings, the program caches pointers to the current function's vectors of
190constants and strings to prevent needing to grab the current function in order
191to grab a constant or a string.
192
193Third, `bc` tries to reuse `BcNum`'s (the internal representation of
194arbitary-precision numbers). If a `BcNum` has the default capacity of
195`BC_NUM_DEF_SIZE` (32 on 64-bit and 16 on 32-bit) when it is freed, it is added
196to a list of available `BcNum`'s. And then, when a `BcNum` is allocated with a
197capacity of `BC_NUM_DEF_SIZE` and any `BcNum`'s exist on the list of reusable
198ones, one of those ones is grabbed instead.
199
200In order to support these changes, the `BC_NUM_DEF_SIZE` was changed. It used to
201be 16 bytes on all systems, but it was changed to more closely align with the
202minimum allocation size on Linux, which is either 32 bytes (64-bit musl), 24
203bytes (64-bit glibc), 16 bytes (32-bit musl), or 12 bytes (32-bit glibc). Since
204these are the minimum allocation sizes, these are the sizes that would be
205allocated anyway, making it worth it to just use the whole space, so the value
206of `BC_NUM_DEF_SIZE` on 64-bit systems was changed to 32 bytes.
207
208On top of that, at least on 64-bit, `BC_NUM_DEF_SIZE` supports numbers with
209either 72 integer digits or 45 integer digits and 27 fractional digits. This
210should be more than enough for most cases since `bc`'s default `scale` values
211are 0 or 20, meaning that, by default, it has at most 20 fractional digits. And
21245 integer digits are *a lot*; it's enough to calculate the amount of mass in
213the Milky Way galaxy in kilograms. Also, 72 digits is enough to calculate the
214diameter of the universe in Planck lengths.
215
216(For 32-bit, these numbers are either 32 integer digits or 12 integer digits and
21720 fractional digits. These are also quite big, and going much bigger on a
21832-bit system seems a little pointless since 12 digits in just under a trillion
219and 20 fractional digits is still enough for about any use since `10^-20` light
220years is just under a millimeter.)
221
222All of this together means that for ordinary uses, and even uses in scientific
223work, the default number size will be all that is needed, which means that
224nearly all, if not all, numbers will be reused, relieving pressure on the system
225allocator.
226
227I did several experiments to find the changes that had the most impact,
228especially with regard to reusing `BcNum`'s. One was putting `BcNum`'s into
229buckets according to their capacity in powers of 2 up to 512. That performed
230worse than `bc` did in `2.7.2`. Another was putting any `BcNum` on the reuse
231list that had a capacity of `BC_NUM_DEF_SIZE * 2` and reusing them for `BcNum`'s
232that requested `BC_NUM_DEF_SIZE`. This did reduce the amount of time spent, but
233it also spent a lot of time in the system allocator for an unknown reason. (When
234using `strace`, a bunch more `brk` calls showed up.) Just reusing `BcNum`'s that
235had exactly `BC_NUM_DEF_SIZE` capacity spent the smallest amount of time in both
236user and system time. This makes sense, especially with the changes to make
237`BC_NUM_DEF_SIZE` bigger on 64-bit systems, since the vast majority of numbers
238will only ever use numbers with a size less than or equal to `BC_NUM_DEF_SIZE`.
239
240Last of all, `bc`'s signal handling underwent a complete redesign. (This is the
241reason that this version is `3.0.0` and not `2.8.0`.) The change was to move
242from a polling approach to signal handling to an interrupt-based approach.
243
244Previously, every single loop condition had a check for signals. I suspect that
245this could be expensive when in tight loops.
246
247Now, the signal handler just uses `longjmp()` (actually `siglongjmp()`) to start
248an unwinding of the stack until it is stopped or the stack is unwound to
249`main()`, which just returns. If `bc` is currently executing code that cannot be
250safely interrupted (according to POSIX), then signals are "locked." The signal
251handler checks if the lock is taken, and if it is, it just sets the status to
252indicate that a signal arrived. Later, when the signal lock is released, the
253status is checked to see if a signal came in. If so, the stack unwinding starts.
254
255This design eliminates polling in favor of maintaining a stack of `jmp_buf`'s.
256This has its own performance implications, but it gives better interaction. And
257the cost of pushing and popping a `jmp_buf` in a function is paid at most twice.
258Most functions do not pay that price, and most of the rest only pay it once.
259(There are only some 3 functions in `bc` that push and pop a `jmp_buf` twice.)
260
261As a side effect of this change, I had to eliminate the use of `stdio.h` in `bc`
262because `stdio` does not play nice with signals and `longjmp()`. I implemented
263custom I/O buffer code that takes a fraction of the size. This means that static
264builds will be smaller, but non-static builds will be bigger, though they will
265have less linking time.
266
267This change is also good because my history implementation was already bypassing
268`stdio` for good reasons, and unifying the architecture was a win.
269
270Another reason for this change is that my `bc` should *always* behave correctly
271in the presence of signals like `SIGINT`, `SIGTERM`, and `SIGQUIT`. With the
272addition of my own I/O buffering, I needed to also make sure that the buffers
273were correctly flushed even when such signals happened.
274
275For this reason, I **removed the option to build without signal support**.
276
277As a nice side effect of this change, the error handling code could be changed
278to take advantage of the stack unwinding that signals used. This means that
279signals and error handling use the same code paths, which means that the stack
280unwinding is well-tested. (Errors are tested heavily in the test suite.)
281
282It also means that functions do not need to return a status code that
283***every*** caller needs to check. This eliminated over 100 branches that simply
284checked return codes and then passed that return code up the stack if necessary.
285The code bloat savings from this is at least 1700 bytes on `x86_64`, *before*
286taking into account the extra code from removing `stdio.h`.
287
288## 2.7.2
289
290This is a production release with one major bug fix.
291
292The `length()` built-in function can take either a number or an array. If it
293takes an array, it returns the length of the array. Arrays can be passed by
294reference. The bug is that the `length()` function would not properly
295dereference arrays that were references. This is a bug that affects all users.
296
297**ALL USERS SHOULD UPDATE `bc`**.
298
299## 2.7.1
300
301This is a production release with fixes for new locales and fixes for compiler
302warnings on FreeBSD.
303
304## 2.7.0
305
306This is a production release with a bug fix for Linux, new translations, and new
307features.
308
309Bug fixes:
310
311* Option parsing in `BC_ENV_ARGS` was broken on Linux in 2.6.1 because `glibc`'s
312  `getopt_long()` is broken. To get around that, and to support long options on
313  every platform, an adapted version of [`optparse`][17] was added. Now, `bc`
314  does not even use `getopt()`.
315* Parsing `BC_ENV_ARGS` with quotes now works. It isn't the smartest, but it
316  does the job if there are spaces in file names.
317
318The following new languages are supported:
319
320* Dutch
321* Polish
322* Russian
323* Japanes
324* Simplified Chinese
325
326All of these translations were generated using [DeepL][18], so improvements are
327welcome.
328
329There is only one new feature: **`bc` now has a built-in pseudo-random number
330generator** (PRNG).
331
332The PRNG is seeded, making it useful for applications where
333`/dev/urandom` does not work because output needs to be reproducible. However,
334it also uses `/dev/urandom` to seed itself by default, so it will start with a
335good seed by default.
336
337It also outputs 32 bits on 32-bit platforms and 64 bits on 64-bit platforms, far
338better than the 15 bits of C's `rand()` and `bash`'s `$RANDOM`.
339
340In addition, the PRNG can take a bound, and when it gets a bound, it
341automatically adjusts to remove bias. It can also generate numbers of arbitrary
342size. (As of the time of release, the largest pseudo-random number generated by
343this `bc` was generated with a bound of `2^(2^20)`.)
344
345***IMPORTANT: read the [`bc` manual][9] and the [`dc` manual][10] to find out
346exactly what guarantees the PRNG provides. The underlying implementation is not
347guaranteed to stay the same, but the guarantees that it provides are guaranteed
348to stay the same regardless of the implementation.***
349
350On top of that, four functions were added to `bc`'s [extended math library][16]
351to make using the PRNG easier:
352
353* `frand(p)`: Generates a number between `[0,1)` to `p` decimal places.
354* `ifrand(i, p)`: Generates an integer with bound `i` and adds it to `frand(p)`.
355* `srand(x)`: Randomizes the sign of `x`. In other words, it flips the sign of
356  `x` with probability `0.5`.
357* `brand()`: Returns a random boolean value (either `0` or `1`).
358
359## 2.6.1
360
361This is a production release with a bug fix for FreeBSD.
362
363The bug was that when `bc` was built without long options, it would give a fatal
364error on every run. This was caused by a mishandling of `optind`.
365
366## 2.6.0
367
368This release is a production release ***with no bugfixes***. If you do not want
369to upgrade, you don't have to.
370
371No source code changed; the only thing that changed was `lib2.bc`.
372
373This release adds one function to the [extended math library][16]: `p(x, y)`,
374which calculates `x` to the power of `y`, whether or not `y` is an integer. (The
375`^` operator can only accept integer powers.)
376
377This release also includes a couple of small tweaks to the [extended math
378library][16], mostly to fix returning numbers with too high of `scale`.
379
380## 2.5.3
381
382This release is a production release which addresses inconsistencies in the
383Portuguese locales. No `bc` code was changed.
384
385The issues were that the ISO files used different naming, and also that the
386files that should have been symlinks were not. I did not catch that because
387GitHub rendered them the exact same way.
388
389## 2.5.2
390
391This release is a production release.
392
393No code was changed, but the build system was changed to allow `CFLAGS` to be
394given to `CC`, like this:
395
396```
397CC="gcc -O3 -march=native" ./configure.sh
398```
399
400If this happens, the flags are automatically put into `CFLAGS`, and the compiler
401is set appropriately. In the example above this means that `CC` will be "gcc"
402and `CFLAGS` will be "-O3 -march=native".
403
404This behavior was added to conform to GNU autotools practices.
405
406## 2.5.1
407
408This is a production release which addresses portability concerns discovered
409in the `bc` build system. No `bc` code was changed.
410
411* Support for Solaris SPARC and AIX were added.
412* Minor documentations edits were performed.
413* An option for `configure.sh` was added to disable long options if
414  `getopt_long()` is missing.
415
416## 2.5.0
417
418This is a production release with new translations. No code changed.
419
420The translations were contributed by [bugcrazy][15], and they are for
421Portuguese, both Portugal and Brazil locales.
422
423## 2.4.0
424
425This is a production release primarily aimed at improving `dc`.
426
427* A couple of copy and paste errors in the [`dc` manual][10] were fixed.
428* `dc` startup was optimized by making sure it didn't have to set up `bc`-only
429  things.
430* The `bc` `&&` and `||` operators were made available to `dc` through the `M`
431  and `m` commands, respectively.
432* `dc` macros were changed to be tail call-optimized.
433
434The last item, tail call optimization, means that if the last thing in a macro
435is a call to another macro, then the old macro is popped before executing the
436new macro. This change was made to stop `dc` from consuming more and more memory
437as macros are executed in a loop.
438
439The `q` and `Q` commands still respect the "hidden" macros by way of recording
440how many macros were removed by tail call optimization.
441
442## 2.3.2
443
444This is a production release meant to fix warnings in the Gentoo `ebuild` by
445making it possible to disable binary stripping. Other users do *not* need to
446upgrade.
447
448## 2.3.1
449
450This is a production release. It fixes a bug that caused `-1000000000 < -1` to
451return `0`. This only happened with negative numbers and only if the value on
452the left was more negative by a certain amount. That said, this bug *is* a bad
453bug, and needs to be fixed.
454
455**ALL USERS SHOULD UPDATE `bc`**.
456
457## 2.3.0
458
459This is a production release with changes to the build system.
460
461## 2.2.0
462
463This release is a production release. It only has new features and performance
464improvements.
465
4661.	The performance of `sqrt(x)` was improved.
4672.	The new function `root(x, n)` was added to the extended math library to
468	calculate `n`th roots.
4693.	The new function `cbrt(x)` was added to the extended math library to
470	calculate cube roots.
471
472## 2.1.3
473
474This is a non-critical release; it just changes the build system, and in
475non-breaking ways:
476
4771.	Linked locale files were changed to link to their sources with a relative
478	link.
4792.	A bug in `configure.sh` that caused long option parsing to fail under `bash`
480	was fixed.
481
482## 2.1.2
483
484This release is not a critical release.
485
4861.	A few codes were added to history.
4872.	Multiplication was optimized a bit more.
4883.	Addition and subtraction were both optimized a bit more.
489
490## 2.1.1
491
492This release contains a fix for the test suite made for Linux from Scratch: now
493the test suite prints `pass` when a test is passed.
494
495Other than that, there is no change in this release, so distros and other users
496do not need to upgrade.
497
498## 2.1.0
499
500This release is a production release.
501
502The following bugs were fixed:
503
5041.	A `dc` bug that caused stack mishandling was fixed.
5052.	A warning on OpenBSD was fixed.
5063.	Bugs in `ctrl+arrow` operations in history were fixed.
5074.	The ability to paste multiple lines in history was added.
5085.	A `bc` bug, mishandling of array arguments to functions, was fixed.
5096.	A crash caused by freeing the wrong pointer was fixed.
5107.	A `dc` bug where strings, in a rare case, were mishandled in parsing was
511	fixed.
512
513In addition, the following changes were made:
514
5151.	Division was slightly optimized.
5162.	An option was added to the build to disable printing of prompts.
5173.	The special case of empty arguments is now handled. This is to prevent
518	errors in scripts that end up passing empty arguments.
5194.	A harmless bug was fixed. This bug was that, with the pop instructions
520	(mostly) removed (see below), `bc` would leave extra values on its stack for
521	`void` functions and in a few other cases. These extra items would not
522	affect anything put on the stack and would not cause any sort of crash or
523	even buggy behavior, but they would cause `bc` to take more memory than it
524	needed.
525
526On top of the above changes, the following optimizations were added:
527
5281.	The need for pop instructions in `bc` was removed.
5292.	Extra tests on every iteration of the interpreter loop were removed.
5303.	Updating function and code pointers on every iteration of the interpreter
531	loop was changed to only updating them when necessary.
5324.	Extra assignments to pointers were removed.
533
534Altogether, these changes sped up the interpreter by around 2x.
535
536***NOTE***: This is the last release with new features because this `bc` is now
537considered complete. From now on, only bug fixes and new translations will be
538added to this `bc`.
539
540## 2.0.3
541
542This is a production, bug-fix release.
543
544Two bugs were fixed in this release:
545
5461.	A rare and subtle signal handling bug was fixed.
5472.	A misbehavior on `0` to a negative power was fixed.
548
549The last bug bears some mentioning.
550
551When I originally wrote power, I did not thoroughly check its error cases;
552instead, I had it check if the first number was `0` and then if so, just return
553`0`. However, `0` to a negative power means that `1` will be divided by `0`,
554which is an error.
555
556I caught this, but only after I stopped being cocky. You see, sometime later, I
557had noticed that GNU `bc` returned an error, correctly, but I thought it was
558wrong simply because that's not what my `bc` did. I saw it again later and had a
559double take. I checked for real, finally, and found out that my `bc` was wrong
560all along.
561
562That was bad on me. But the bug was easy to fix, so it is fixed now.
563
564There are two other things in this release:
565
5661.	Subtraction was optimized by [Stefan Eßer][14].
5672.	Division was also optimized, also by Stefan Eßer.
568
569## 2.0.2
570
571This release contains a fix for a possible overflow in the signal handling. I
572would be surprised if any users ran into it because it would only happen after 2
573billion (`2^31-1`) `SIGINT`'s, but I saw it and had to fix it.
574
575## 2.0.1
576
577This release contains very few things that will apply to any users.
578
5791.	A slight bug in `dc`'s interactive mode was fixed.
5802.	A bug in the test suite that was only triggered on NetBSD was fixed.
5813.	**The `-P`/`--no-prompt` option** was added for users that do not want a
582	prompt.
5834.	A `make check` target was added as an alias for `make test`.
5845.	`dc` got its own read prompt: `?> `.
585
586## 2.0.0
587
588This release is a production release.
589
590This release is also a little different from previous releases. From here on
591out, I do not plan on adding any more features to this `bc`; I believe that it
592is complete. However, there may be bug fix releases in the future, if I or any
593others manage to find bugs.
594
595This release has only a few new features:
596
5971.	`atan2(y, x)` was added to the extended math library as both `a2(y, x)` and
598	`atan2(y, x)`.
5992.	Locales were fixed.
6003.	A **POSIX shell-compatible script was added as an alternative to compiling
601	`gen/strgen.c`** on a host machine. More details about making the choice
602	between the two can be found by running `./configure.sh --help` or reading
603	the [build manual][13].
6044.	Multiplication was optimized by using **diagonal multiplication**, rather
605	than straight brute force.
6065.	The `locale_install.sh` script was fixed.
6076.	`dc` was given the ability to **use the environment variable
608	`DC_ENV_ARGS`**.
6097.	`dc` was also given the ability to **use the `-i` or `--interactive`**
610	options.
6118.	Printing the prompt was fixed so that it did not print when it shouldn't.
6129.	Signal handling was fixed.
61310.	**Handling of `SIGTERM` and `SIGQUIT`** was fixed.
61411.	The **built-in functions `maxibase()`, `maxobase()`, and `maxscale()`** (the
615	commands `T`, `U`, `V` in `dc`, respectively) were added to allow scripts to
616	query for the max allowable values of those globals.
61712.	Some incompatibilities with POSIX were fixed.
618
619In addition, this release is `2.0.0` for a big reason: the internal format for
620numbers changed. They used to be a `char` array. Now, they are an array of
621larger integers, packing more decimal digits into each integer. This has
622delivered ***HUGE*** performance improvements, especially for multiplication,
623division, and power.
624
625This `bc` should now be the fastest `bc` available, but I may be wrong.
626
627## 1.2.8
628
629This release contains a fix for a harmless bug (it is harmless in that it still
630works, but it just copies extra data) in the [`locale_install.sh`][12] script.
631
632## 1.2.7
633
634This version contains fixes for the build on Arch Linux.
635
636## 1.2.6
637
638This release removes the use of `local` in shell scripts because it's not POSIX
639shell-compatible, and also updates a man page that should have been updated a
640long time ago but was missed.
641
642## 1.2.5
643
644This release contains some missing locale `*.msg` files.
645
646## 1.2.4
647
648This release contains a few bug fixes and new French translations.
649
650## 1.2.3
651
652This release contains a fix for a bug: use of uninitialized data. Such data was
653only used when outputting an error message, but I am striving for perfection. As
654Michelangelo said, "Trifles make perfection, and perfection is no trifle."
655
656## 1.2.2
657
658This release contains fixes for OpenBSD.
659
660## 1.2.1
661
662This release contains bug fixes for some rare bugs.
663
664## 1.2.0
665
666This is a production release.
667
668There have been several changes since `1.1.0`:
669
6701.	The build system had some changes.
6712.	Locale support has been added. (Patches welcome for translations.)
6723.	**The ability to turn `ibase`, `obase`, and `scale` into stacks** was added
673	with the `-g` command-line option. (See the [`bc` manual][9] for more
674	details.)
6754.	Support for compiling on Mac OSX out of the box was added.
6765.	The extended math library got `t(x)`, `ceil(x)`, and some aliases.
6776.	The extended math library also got `r2d(x)` (for converting from radians to
678	degrees) and `d2r(x)` (for converting from degrees to radians). This is to
679	allow using degrees with the standard library.
6807.	Both calculators now accept numbers in **scientific notation**. See the
681	[`bc` manual][9] and the [`dc` manual][10] for details.
6828.	Both calculators can **output in either scientific or engineering
683	notation**. See the [`bc` manual][9] and the [`dc` manual][10] for details.
6849.	Some inefficiencies were removed.
68510.	Some bugs were fixed.
68611.	Some bugs in the extended library were fixed.
68712.	Some defects from [Coverity Scan][11] were fixed.
688
689## 1.1.4
690
691This release contains a fix to the build system that allows it to build on older
692versions of `glibc`.
693
694## 1.1.3
695
696This release contains a fix for a bug in the test suite where `bc` tests and
697`dc` tests could not be run in parallel.
698
699## 1.1.2
700
701This release has a fix for a history bug; the down arrow did not work.
702
703## 1.1.1
704
705This release fixes a bug in the `1.1.0` build system. The source is exactly the
706same.
707
708The bug that was fixed was a failure to install if no `EXECSUFFIX` was used.
709
710## 1.1.0
711
712This is a production release. However, many new features were added since `1.0`.
713
7141.	**The build system has been changed** to use a custom, POSIX
715	shell-compatible configure script ([`configure.sh`][6]) to generate a POSIX
716	make-compatible `Makefile`, which means that `bc` and `dc` now build out of
717	the box on any POSIX-compatible system.
7182.	Out-of-memory and output errors now cause the `bc` to report the error,
719	clean up, and die, rather than just reporting and trying to continue.
7203.	**Strings and constants are now garbage collected** when possible.
7214.	Signal handling and checking has been made more simple and more thorough.
7225.	`BcGlobals` was refactored into `BcVm` and `BcVm` was made global. Some
723	procedure names were changed to reflect its difference to everything else.
7246.	Addition got a speed improvement.
7257.	Some common code for addition and multiplication was refactored into its own
726	procedure.
7278.	A bug was removed where `dc` could have been selected, but the internal
728	`#define` that returned `true` for a query about `dc` would not have
729	returned `true`.
7309.	Useless calls to `bc_num_zero()` were removed.
73110.	**History support was added.** The history support is based off of a
732	[UTF-8 aware fork][7] of [`linenoise`][8], which has been customized with
733	`bc`'s own data structures and signal handling.
73411.	Generating C source from the math library now removes tabs from the library,
735	shrinking the size of the executable.
73612.	The math library was shrunk.
73713.	Error handling and reporting was improved.
73814.	Reallocations were reduced by giving access to the request size for each
739	operation.
74015.	**`abs()` (`b` command for `dc`) was added as a builtin.**
74116.	Both calculators were tested on FreeBSD.
74217.	Many obscure parse bugs were fixed.
74318.	Markdown and man page manuals were added, and the man pages are installed by
744	`make install`.
74519.	Executable size was reduced, though the added features probably made the
746	executable end up bigger.
74720.	**GNU-style array references were added as a supported feature.**
74821.	Allocations were reduced.
74922.	**New operators were added**: `$` (`$` for `dc`), `@` (`@` for `dc`), `@=`,
750	`<<` (`H` for `dc`), `<<=`, `>>` (`h` for `dc`), and `>>=`. See the
751	[`bc` manual][9] and the [`dc` manual][10] for more details.
75223.	**An extended math library was added.** This library contains code that
753	makes it so I can replace my desktop calculator with this `bc`. See the
754	[`bc` manual][3] for more details.
75524.	Support for all capital letters as numbers was added.
75625.	**Support for GNU-style void functions was added.**
75726.	A bug fix for improper handling of function parameters was added.
75827.	Precedence for the or (`||`) operator was changed to match GNU `bc`.
75928.	`dc` was given an explicit negation command.
76029.	`dc` was changed to be able to handle strings in arrays.
761
762## 1.1 Release Candidate 3
763
764This release is the eighth release candidate for 1.1, though it is the third
765release candidate meant as a general release candidate. The new code has not
766been tested as thoroughly as it should for release.
767
768## 1.1 Release Candidate 2
769
770This release is the seventh release candidate for 1.1, though it is the second
771release candidate meant as a general release candidate. The new code has not
772been tested as thoroughly as it should for release.
773
774## 1.1 FreeBSD Beta 5
775
776This release is the sixth release candidate for 1.1, though it is the fifth
777release candidate meant specifically to test if `bc` works on FreeBSD. The new
778code has not been tested as thoroughly as it should for release.
779
780## 1.1 FreeBSD Beta 4
781
782This release is the fifth release candidate for 1.1, though it is the fourth
783release candidate meant specifically to test if `bc` works on FreeBSD. The new
784code has not been tested as thoroughly as it should for release.
785
786## 1.1 FreeBSD Beta 3
787
788This release is the fourth release candidate for 1.1, though it is the third
789release candidate meant specifically to test if `bc` works on FreeBSD. The new
790code has not been tested as thoroughly as it should for release.
791
792## 1.1 FreeBSD Beta 2
793
794This release is the third release candidate for 1.1, though it is the second
795release candidate meant specifically to test if `bc` works on FreeBSD. The new
796code has not been tested as thoroughly as it should for release.
797
798## 1.1 FreeBSD Beta 1
799
800This release is the second release candidate for 1.1, though it is meant
801specifically to test if `bc` works on FreeBSD. The new code has not been tested as
802thoroughly as it should for release.
803
804## 1.1 Release Candidate 1
805
806This is the first release candidate for 1.1. The new code has not been tested as
807thoroughly as it should for release.
808
809## 1.0
810
811This is the first non-beta release. `bc` is ready for production use.
812
813As such, a lot has changed since 0.5.
814
8151.	`dc` has been added. It has been tested even more thoroughly than `bc` was
816	for `0.5`. It does not have the `!` command, and for security reasons, it
817	never will, so it is complete.
8182.	`bc` has been more thoroughly tested. An entire section of the test suite
819	(for both programs) has been added to test for errors.
8203.	A prompt (`>>> `) has been added for interactive mode, making it easier to
821	see inputs and outputs.
8224.	Interrupt handling has been improved, including elimination of race
823	conditions (as much as possible).
8245.	MinGW and [Windows Subsystem for Linux][1] support has been added (see
825	[xstatic][2] for binaries).
8266.	Memory leaks and errors have been eliminated (as far as ASan and Valgrind
827	can tell).
8287.	Crashes have been eliminated (as far as [afl][3] can tell).
8298.	Karatsuba multiplication was added (and thoroughly) tested, speeding up
830	multiplication and power by orders of magnitude.
8319.	Performance was further enhanced by using a "divmod" function to reduce
832	redundant divisions and by removing superfluous `memset()` calls.
83310.	To switch between Karatsuba and `O(n^2)` multiplication, the config variable
834	`BC_NUM_KARATSUBA_LEN` was added. It is set to a sane default, but the
835	optimal number can be found with [`karatsuba.py`][4] (requires Python 3)
836	and then configured through `make`.
83711.	The random math test generator script was changed to Python 3 and improved.
838	`bc` and `dc` have together been run through 30+ million random tests.
83912.	All known math bugs have been fixed, including out of control memory
840	allocations in `sine` and `cosine` (that was actually a parse bug), certain
841	cases of infinite loop on square root, and slight inaccuracies (as much as
842	possible; see the [README][5]) in transcendental functions.
84313.	Parsing has been fixed as much as possible.
84414.	Test coverage was improved to 94.8%. The only paths not covered are ones
845	that happen when `malloc()` or `realloc()` fails.
84615.	An extension to get the length of an array was added.
84716.	The boolean not (`!`) had its precedence change to match negation.
84817.	Data input was hardened.
84918.	`bc` was made fully compliant with POSIX when the `-s` flag is used or
850	`POSIXLY_CORRECT` is defined.
85119.	Error handling was improved.
85220.	`bc` now checks that files it is given are not directories.
853
854## 1.0 Release Candidate 7
855
856This is the seventh release candidate for 1.0. It fixes a few bugs in 1.0
857Release Candidate 6.
858
859## 1.0 Release Candidate 6
860
861This is the sixth release candidate for 1.0. It fixes a few bugs in 1.0 Release
862Candidate 5.
863
864## 1.0 Release Candidate 5
865
866This is the fifth release candidate for 1.0. It fixes a few bugs in 1.0 Release
867Candidate 4.
868
869## 1.0 Release Candidate 4
870
871This is the fourth release candidate for 1.0. It fixes a few bugs in 1.0 Release
872Candidate 3.
873
874## 1.0 Release Candidate 3
875
876This is the third release candidate for 1.0. It fixes a few bugs in 1.0 Release
877Candidate 2.
878
879## 1.0 Release Candidate 2
880
881This is the second release candidate for 1.0. It fixes a few bugs in 1.0 Release
882Candidate 1.
883
884## 1.0 Release Candidate 1
885
886This is the first Release Candidate for 1.0. `bc` is complete, with `dc`, but it
887is not tested.
888
889## 0.5
890
891This beta release completes more features, but it is still not complete nor
892tested as thoroughly as necessary.
893
894## 0.4.1
895
896This beta release fixes a few bugs in 0.4.
897
898## 0.4
899
900This is a beta release. It does not have the complete set of features, and it is
901not thoroughly tested.
902
903[1]: https://docs.microsoft.com/en-us/windows/wsl/install-win10
904[2]: https://pkg.musl.cc/bc/
905[3]: http://lcamtuf.coredump.cx/afl/
906[4]: ./karatsuba.py
907[5]: ./README.md
908[6]: ./configure.sh
909[7]: https://github.com/rain-1/linenoise-mob
910[8]: https://github.com/antirez/linenoise
911[9]: ./manuals/bc/A.1.md
912[10]: ./manuals/dc/A.1.md
913[11]: https://scan.coverity.com/projects/gavinhoward-bc
914[12]: ./locale_install.sh
915[13]: ./manuals/build.md
916[14]: https://github.com/stesser
917[15]: https://github.com/bugcrazy
918[16]: ./manuals/bc/A.1.md#extended-library
919[17]: https://github.com/skeeto/optparse
920[18]: https://www.deepl.com/translator
921[19]: ./manuals/benchmarks.md
922[20]: https://github.com/apjanke/ronn-ng
923[21]: https://pandoc.org/
924