Fixed a typo in documentation + added a warning and a tip about GCC 4.2 on a Mac dev
authorDmitriy Morozov <dmitriy@mrzv.org>
Tue, 20 Oct 2009 22:05:23 -0700
branchdev
changeset 169 c0bf4675697c
parent 168 3b0665eb35bc
child 170 e8b6706cedfc
Fixed a typo in documentation + added a warning and a tip about GCC 4.2 on a Mac
doc/get-build-install.rst
doc/tutorial.rst
--- a/doc/get-build-install.rst	Mon Aug 31 13:45:28 2009 -0700
+++ b/doc/get-build-install.rst	Tue Oct 20 22:05:23 2009 -0700
@@ -37,10 +37,18 @@
   :Boost_:              C++ utilities (version :math:`\geq` 1.36; including Boost.Python used to create
                         Python bindings)
 
-There also seems to be a dependence on the version of GCC, although I don't
-entirely understand it. GCC :math:`\geq` 4.3 definitely works, but some versions
-below that seem not to. There were some major changes in 4.3, so it's not
-entirely surprising, but I don't understand all the subtleties.
+.. warning::
+
+    There also seems to be a dependence on the version of GCC, although I don't
+    entirely understand it. GCC 4.3 and above definitely work, but some versions
+    below that seem not to.
+
+    One particular catch is that the default compiler on many current Mac OS X
+    is GCC 4.0 that has a well-known bug making Dionysus unusable. Fortunately
+    the problem is easy to solve by using GCC 4.2 that is often available on a
+    Mac under the name ``gcc-4.2``.
+
+    One can check the compiler version with ``g++ --version`` command.
 
 Optional dependencies:
 
@@ -70,6 +78,11 @@
   cmake ..
   make
 
+.. tip::
+
+   To use GCC 4.2 on a Mac one can try ``CXX=g++-4.2 cmake ..`` instead of
+   ``cmake ..``.
+
 Instead of ``cmake``, one can run ``ccmake`` for a curses interface. The
 following configuration options are available. One can set them either through
 the curses interface or by passing a flag of the form ``-Doptimize:bool=on`` to
--- a/doc/tutorial.rst	Mon Aug 31 13:45:28 2009 -0700
+++ b/doc/tutorial.rst	Tue Oct 20 22:05:23 2009 -0700
@@ -141,7 +141,7 @@
     complex = {}
     zz = ZigzagPersistence()
     for s in simplices:
-        i,d = zz.add([complex[sb] for sb in s.boundary, (s.dimension(), s.data))
+        i,d = zz.add([complex[sb] for sb in s.boundary], (s.dimension(), s.data))
         complex[s] = i
         if d is not None:                   # we have a death
             dimension, birth = d            # we previously stored the (dimension, data) pair