[gmpy-commits] CVS: gmpy/doc gmpydoc.txt, 1.6, 1.7 index.html, 1.6, 1.7

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 454-5900

Update of /cvsroot/gmpy/gmpy/doc
In directory sc8-pr-cvs2.sourceforge.net:/tmp/cvs-serv19239/doc

Modified Files:
	gmpydoc.txt index.html 
Log Message:
Further minor cleanups

Index: gmpydoc.txt
===================================================================
RCS file: /cvsroot/gmpy/gmpy/doc/gmpydoc.txt,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** gmpydoc.txt	13 Nov 2005 01:27:12 -0000	1.6
--- gmpydoc.txt	24 Feb 2007 00:16:27 -0000	1.7
***************
*** 36,39 ****
--- 36,40 ----
  Minor editing for version 1.01 (2005/11/12);
  maintainer's preferred email changed to al...@gm... .
+ Minor editing for version 1.02 (2007/02/19).

***************
*** 56,59 ****
--- 57,63 ----
  the Windows binary installers for gmpy 1.01.

+ Chip Turner and Daniel Lord helped with the changes leading to version
+ 1.02, so, thanks to them as well!
+ 

  *Installation and testing*
***************
*** 63,73 ****
  though gmpy doesn't yet expose any GMP4-only functionality and
  presumably "should" build OK with GMP 3.  No support nor bugfixes
! planned for older releases of either Python or GMP.

! To build gmpy from sources, unpack the sources zipfile
! (gmpy-sources-101.zip, for example, for release 1.01) into a new,
! dedicated directory; cd to that directory (from any shell on
! Unix/Linux, from a 'Dos box' aka 'command box' on Windows, from
! Terminal on Mac OS X, etc), and run the command:

      python setup.py install
--- 67,78 ----
  though gmpy doesn't yet expose any GMP4-only functionality and
  presumably "should" build OK with GMP 3.  No support nor bugfixes
! are planned for older releases of either Python or GMP.

! To build gmpy from sources, get the sources from svn (or a sources
! zipfile, such as gmpy-sources-101.zip for release 1.01; old versions are
! at http://gmpy.sourceforge.net, new ones at
! http://code.google.com/p/gmpy/source) into a new, dedicated directory;
! cd to that directory (from any shell on Unix/Linux, from a 'Dos box' aka
! 'command box' on Windows, from Terminal on Mac OS X, etc), and run:

      python setup.py install
***************
*** 82,86 ****
  http://www.cs.nyu.edu/exact/core/gmp/ .  Take care, when
  installing GMP 4, that an older GMP 3 doesn't keep being used
! instead, e.g. on Linux, if you have a system-installed GMP 3 in
  /usr/lib and install the newer GMP 4 using GMP's default settings
  (it then goes into /usr/local/lib, and depending on various
--- 87,91 ----
  http://www.cs.nyu.edu/exact/core/gmp/ .  Take care, when
  installing GMP 4, that an older GMP 3 doesn't keep being used
! instead; e.g. on Linux, if you have a system-installed GMP 3 in
  /usr/lib and install the newer GMP 4 using GMP's default settings
  (it then goes into /usr/local/lib, and depending on various
***************
*** 93,97 ****
  *addition* to the gmpy-sources-101.zip zipfile (which is in any
  case recommended, since it contains all of gmpy's docs, tests and
! examples, as well as gmpy's soruces).

  The sources zipfile also contains this file (gmpydoc.txt), an
--- 98,103 ----
  *addition* to the gmpy-sources-101.zip zipfile (which is in any
  case recommended, since it contains all of gmpy's docs, tests and
! examples, as well as gmpy's soruces).  These old installers are, at
! the time of this writing, only available at gmpy.sourceforge.net.

  The sources zipfile also contains this file (gmpydoc.txt), an
***************
*** 115,134 ****

  """
! Unit tests for gmpy 1.01 release candidate
!     on Python 2.4.1 (#1, Apr 21 2005, 11:14:17)
! [GCC 3.2.2 20030222 (Red Hat Linux 3.2.2-5)]
! Testing gmpy 1.01 (GMP 4.1.2), default caching (20, 20, -2..11)
! gmpy_test_cvr 262 tests, 0 failures
  gmpy_test_rnd  26 tests, 0 failures
! gmpy_test_mpf 154 tests, 0 failures
! gmpy_test_mpq 260 tests, 0 failures
! gmpy_test_mpz 370 tests, 0 failures
! 6 items had no tests:
!     gmpy_test_cvr._test
      [[ snip snip ]]
! 28 items passed all tests:
      [[ snip snip ]]
! 1072 tests in 34 items.
! 1072 passed and 0 failed.
  Test passed.
  """
--- 121,140 ----

  """
! Unit tests for gmpy 1.02 release candidate
!     on Python 2.5 (r25:51918, Sep 19 2006, 08:49:13) 
! [GCC 4.0.1 (Apple Computer, Inc. build 5341)]
! Testing gmpy 1.02 (GMP 4.2), default caching (20, 20, -2..11)
! gmpy_test_cvr 270 tests, 0 failures
  gmpy_test_rnd  26 tests, 0 failures
! gmpy_test_mpf 155 tests, 0 failures
! gmpy_test_mpq 264 tests, 0 failures
! gmpy_test_mpz 386 tests, 0 failures
! gmpy_test_dec  16 tests, 0 failures
! 7 items had no tests:
      [[ snip snip ]]
! 31 items passed all tests:
      [[ snip snip ]]
! 1117 tests in 38 items.
! 1117 passed and 0 failed.
  Test passed.
  """
***************
*** 145,158 ****
  the key issue is the 'Test passed' line at the end of each run!

! *PLEASE* report any failures to gmpy's maintainers, with all
! details you can supply on your machine, on your OS, and on your
! installation of GMP 4, gmpy 1.01, Python 2.3 or 2.4, and any other
! relevant issue (your C/C++ compiler & libraries, &c).  *THANKS* in
! advance -- bug reporting and feedback is your key contribution to
! the gmpy project!  (Reports of any _successful_ installations will
! also be welcome, if it's accompanied by enough details -- again,
! THANKS in advance!).  The best way to report bugs (including
! unit-test failures) is via the SF bug tracker, specifically
! https://sourceforge.net/tracker/?group_id=13335&atid=113335 .

--- 151,163 ----
  the key issue is the 'Test passed' line at the end of each run!

! *PLEASE* report any failures to gmpy's maintainers, with all details you
! can supply on your machine, on your OS, and on your installation of GMP
! 4, gmpy 1.02, Python 2.3, 2.4, or 2.5, and any other relevant issue
! (your C/C++ compiler & libraries, &c).  *THANKS* in advance -- bug
! reporting and feedback is your key contribution to the gmpy project!
! (Reports of any _successful_ installations will also be welcome, if it's
! accompanied by enough details -- again, THANKS in advance!).  The best
! way to report bugs (including unit-test failures) is via the Google Code
! issue tracker.

***************
*** 198,204 ****
  it's of a floating type, in which case the .mpz object is coerced
  to that floating type instead (or mpq, or complex, ditto).
! However, gmpy currently does not support coercion of ANY of its
! types to/from the decimal.Decimal class introduced in the standard
! library in Python 2.4.

--- 203,212 ----
  it's of a floating type, in which case the .mpz object is coerced
  to that floating type instead (or mpq, or complex, ditto).
! gmpy currently offers experimental support for coercion to its
! types from the decimal.Decimal class introduced in the standard
! library in Python 2.4; however, that support is experimental
! because it's done by "monkey patching" the Decimal class on the
! fly, and therefore it could stop working any time (e.g., if Decimal is
! made into a C-coded type in some future version of Python).

Index: index.html
===================================================================
RCS file: /cvsroot/gmpy/gmpy/doc/index.html,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** index.html	12 Nov 2005 00:04:45 -0000	1.6
--- index.html	24 Feb 2007 00:16:27 -0000	1.7
***************
*** 3,9 ****
--- 3,12 ----
  <TITLE>Welcome to General Multiprecision PYthon
  </TITLE>
+ 
+ <!--
  <LINK rel="stylesheet"
      href="http://sourceforge.net/sourceforge.css"
      type="text/css">
+ -->

  <STYLE>
***************
*** 14,22 ****
  <BODY>
  <FONT SIZE=-1>
! Last updated on: 2005, Nov 12;
! for GMPY release: 1.01 beta
! <A href="http://sourceforge.net">
! <IMG src="http://sourceforge.net/sflogo.php?group_id=13335&type=1"
! width="88" height="31" border="0" alt="Go to main SourceForge page"></A>
  <br>
  </FONT>
--- 17,25 ----
  <BODY>
  <FONT SIZE=-1>
! Last updated on: 2007, Feb 19;
! for GMPY release: 1.2 release candidate
! <A href="http://code.google.com/p/gmpy/">
! <IMG src="http://code.google.com/images/code_sm.png"
! width="88" height="31" border="0" alt="Go to Google Code gmpy page"></A>
  <br>
  </FONT>
***************
*** 43,54 ****
  <H1>The GMPY Module</H1>
  <P>
! Existing Python modules expose a subset of the integral-MP
! (MPZ) functionality of earlier releases of the GMP library.
! The first GMPY goal is to develop this module into a complete
! exposure of MPZ, MPF (floating-point), and MPQ (rational)
! functionality of current GMP (release 4), that will fully
! support current Python releases (2.2, 2.3, 2.4) and the 'distutils'
! (and also support a "C API" allowing some level of interoperation
! with other C-written extension modules for Python).
  <p>
  <b>Note</b>: the module's ability to be used as a "drop-in
--- 46,60 ----
  <H1>The GMPY Module</H1>
  <P>
! Python modules older than GMPY exposes a subset of the integral-MP
! (MPZ) functionality of earlier releases of the GMP library.  The
! first GMPY goal (currently nearly reached) was to develop the gmpy
! module into a complete exposure of MPZ, MPF (floating-point), and
! MPQ (rational) functionality of current GMP (release 4), as well
! as auxiliary functionality such as random number generation, with
! full support for current Python releases (2.3 and up) and the
! Python 'distutils' (and also support for a "C API" allowing some
! level of interoperation with other C-written extension modules for
! Python).
! 
  <p>
  <b>Note</b>: the module's ability to be used as a "drop-in
***************
*** 59,63 ****
  to support it.
  <P>
! This first module is called <b>gmpy</b>, just like the whole project.
  <P>
  The extended MP floating-point facilities of
--- 65,70 ----
  to support it.
  <P>
! This first GMPY
! module is called <b>gmpy</b>, just like the whole project.
  <P>
  The extended MP floating-point facilities of
***************
*** 65,70 ****
  will later also be considered for inclusion in gmpy (either within
  the same module, or as a further, separate add-on module).
! Rooting for MPFR to be merged with GMP so we can avoid some
! awkwardness (but seeing no movement on this front so far).

  <H2>Mutability... but <u>not</u> for now</H2>
--- 72,77 ----
  will later also be considered for inclusion in gmpy (either within
  the same module, or as a further, separate add-on module).
! [[ Rooting for MPFR to be merged with GMP so we can avoid some
! awkwardness (but seeing no movement on this front so far) ]].

  <H2>Mutability... but <u>not</u> for now</H2>
***************
*** 90,96 ****

  <H1>Project Status and near-future plans</H1>
! The gmpy module's beta release (latest current release
! as of 2005/11/12: 1.01) is available for download in both
! source and Windows-binary form.  It exposes all of the mpz, mpq
  and mpf functionality that was already available in GMP 3.1, and 
  most of the random-number generation functionality (there are no
--- 97,112 ----

  <H1>Project Status and near-future plans</H1>
! The gmpy module's release-candidate release (latest current release
! as of 2007/02/18: 1.01) is available for download in both
! source and Windows-binary form
! 
! [[TODO: make the downloadable tarball and binary releases of 1.02
! for Windows and MacOSX available on code.google.com: currently,
! 1.02 exists only in the SVN source repository on code.google.com,
! and binary tarballs and releases exist only for older releases,
! 1.01 and back, on the project's previous home, gmpy.sf.net, and
! are not maintained any more]].
! 
! gmpy 1.02 exposes all of the mpz, mpq
  and mpf functionality that was already available in GMP 3.1, and 
  most of the random-number generation functionality (there are no
***************
*** 155,159 ****
  (mostly provided for the specific use of PySymbolic, and intended to be
  tested by that package).  We'll have to do better, eventually, but, for
! now, this can be considered OK for a beta-release.
  <p>
  In the attempt to make gmpy as useful as can be for both stand-alone
--- 171,175 ----
  (mostly provided for the specific use of PySymbolic, and intended to be
  tested by that package).  We'll have to do better, eventually, but, for
! now, this can be considered OK.
  <p>
  In the attempt to make gmpy as useful as can be for both stand-alone
***************
*** 172,186 ****
  proven unnecessary.  All relevant GMP 4 functionality will be exposed.
  <p>
! No predictions on timing, though.  gmpy 1.01 meets all current needs
  of the main author, so his motivation to work more on it is low:-).
  So, don't hold your breath (pitching in and helping it happen, on the
  other hand, _might_ be advisable, and will surely yield results:-).
  <p>
! <A HREF="http://sourceforge.net/projects/gmpy/">Project
! Summary, downloads, &amp;tc</A>
! 
! <A href="http://sourceforge.net/projects/gmpy/">
! <IMG src="http://sourceforge.net/sflogo.php?group_id=13335&type=1"
! width="88" height="31" border="0" alt="Project Summary Page"></A>
  </BODY>
  </HTML>
--- 188,201 ----
  proven unnecessary.  All relevant GMP 4 functionality will be exposed.
  <p>
! No predictions on timing, though.  gmpy 1.02 meets all current needs
  of the main author, so his motivation to work more on it is low:-).
  So, don't hold your breath (pitching in and helping it happen, on the
  other hand, _might_ be advisable, and will surely yield results:-).
  <p>
! <A HREF="http://code.google.com/p/gmpy/">Project page on
! code.google.com</A>
! <A href="http://code.google.com/p/gmpy/">
! <IMG src="http://code.google.com/images/code_sm.png"
! width="88" height="31" border="0" alt="Go to Google Code gmpy page"></A>
  </BODY>
  </HTML>