From e8a812866579ecf525b4a1c5f722414b97052575 Mon Sep 17 00:00:00 2001 From: Peter Kokot Date: Sat, 20 Apr 2019 22:41:00 +0200 Subject: [PATCH] Refactor docs files for bcmath library --- ext/bcmath/libbcmath/AUTHORS | 1 - ext/bcmath/libbcmath/ChangeLog | 9 ------- ext/bcmath/libbcmath/FAQ | 20 --------------- ext/bcmath/libbcmath/NEWS | 3 --- ext/bcmath/libbcmath/README | 9 ------- ext/bcmath/libbcmath/README.md | 45 ++++++++++++++++++++++++++++++++++ 6 files changed, 45 insertions(+), 42 deletions(-) delete mode 100644 ext/bcmath/libbcmath/AUTHORS delete mode 100644 ext/bcmath/libbcmath/ChangeLog delete mode 100644 ext/bcmath/libbcmath/FAQ delete mode 100644 ext/bcmath/libbcmath/NEWS delete mode 100644 ext/bcmath/libbcmath/README create mode 100644 ext/bcmath/libbcmath/README.md diff --git a/ext/bcmath/libbcmath/AUTHORS b/ext/bcmath/libbcmath/AUTHORS deleted file mode 100644 index f2d831cf652c2..0000000000000 --- a/ext/bcmath/libbcmath/AUTHORS +++ /dev/null @@ -1 +0,0 @@ -Phil Nelson wrote bcmath library. diff --git a/ext/bcmath/libbcmath/ChangeLog b/ext/bcmath/libbcmath/ChangeLog deleted file mode 100644 index eea6b016e2b53..0000000000000 --- a/ext/bcmath/libbcmath/ChangeLog +++ /dev/null @@ -1,9 +0,0 @@ -Wed Jun 7 09:39:02 2000 Phil Nelson - - * configure.in and many others: version number now at 0.2. - Many other changes/additions for getting a distribution - to work. - -2000-05-21 Phil Nelson - - * Initial setup of bcmath library., calling it version 0.1. diff --git a/ext/bcmath/libbcmath/FAQ b/ext/bcmath/libbcmath/FAQ deleted file mode 100644 index 423600ac76fe0..0000000000000 --- a/ext/bcmath/libbcmath/FAQ +++ /dev/null @@ -1,20 +0,0 @@ -BCMATH FAQ: - -1) Why BCMATH? - -The math routines of GNU bc become more generally useful in a -library form. By separating the BCMATH library from GNU bc, -GNU bc can be under the GPL and BCMATH can be under the LGPL. - -2) Why BCMATH when GMP exists? - -GMP has "integers" (no digits after a decimal), "rational numbers" -(stored as 2 integers) and "floats". None of these will correctly -represent a POSIX BC number. Floats are the closest, but will not -behave correctly for many computations. For example, BC numbers have -a "scale" that represent the number of digits to represent after the -decimal point. The multiplying two of these numbers requires one to -calculate an exact number of digits after the decimal point regardless -of the number of digits in the integer part. GMP floats have a -"fixed, but arbitrary" mantissa and so multiplying two floats will end -up dropping digits BC must calculate. diff --git a/ext/bcmath/libbcmath/NEWS b/ext/bcmath/libbcmath/NEWS deleted file mode 100644 index 431d7b315d17f..0000000000000 --- a/ext/bcmath/libbcmath/NEWS +++ /dev/null @@ -1,3 +0,0 @@ -NEWS for bcmath library: - - May 2000: The library is created. diff --git a/ext/bcmath/libbcmath/README b/ext/bcmath/libbcmath/README deleted file mode 100644 index cae5e5dc431d7..0000000000000 --- a/ext/bcmath/libbcmath/README +++ /dev/null @@ -1,9 +0,0 @@ -This is bcmath, a library of arbitrary precision math routines. -These routines, in a different form, are the routines that to -the arbitrary precision calculations for GNU bc and GNU dc. - -This library is provided to make these routines useful in a -larger context with less restrictions on the use of them. - -These routines do not duplicate functionality of the GNU gmp -library. gmp is similar, but the actual computation is different. diff --git a/ext/bcmath/libbcmath/README.md b/ext/bcmath/libbcmath/README.md new file mode 100644 index 0000000000000..aceebf940396e --- /dev/null +++ b/ext/bcmath/libbcmath/README.md @@ -0,0 +1,45 @@ +# The bcmath library + +This is a fork of the bcmath library initially created by Phil Nelson in May +2010. + +Bcmath is a library of arbitrary precision math routines. These routines, in a +different form, are the routines that to the arbitrary precision calculations +for GNU bc and GNU dc. + +This library is provided to make these routines useful in a larger context with +less restrictions on the use of them. + +These routines do not duplicate functionality of the GNU gmp library. The gmp +library is similar, but the actual computation is different. + +Initial library (version 0.1) has been created in 2000-05-21 and then forked and +bundled into PHP with version 0.2 released in 2000-06-07. + +## FAQ + +* Why BCMATH? + + The math routines of GNU bc become more generally useful in a library form. By + separating the BCMATH library from GNU bc, GNU bc can be under the GPL and + BCMATH can be under the LGPL. + +* Why BCMATH when GMP exists? + + GMP has "integers" (no digits after a decimal), "rational numbers" (stored as + 2 integers) and "floats". None of these will correctly represent a POSIX BC + number. Floats are the closest, but will not behave correctly for many + computations. For example, BC numbers have a "scale" that represent the number + of digits to represent after the decimal point. The multiplying two of these + numbers requires one to calculate an exact number of digits after the decimal + point regardless of the number of digits in the integer part. GMP floats have + a "fixed, but arbitrary" mantissa and so multiplying two floats will end up + dropping digits BC must calculate. + +## Credits + +Phil Nelson (philnelson@acm.org) wrote bcmath library. + +## License + +The bcmath library is released under the GNU Lesser General Public License v2.1.