[pygccxml-commit] SF.net SVN: pygccxml:[1693] pyplusplus_dev/docs/history

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 1693
          http://pygccxml.svn.sourceforge.net/pygccxml/?rev=1693&view=rev
Author:   roman_yakovenko
Date:     2009-02-19 10:54:51 +0000 (Thu, 19 Feb 2009)

Log Message:
-----------
update documentation

Modified Paths:
--------------
    pygccxml_dev/docs/download.rest
    pygccxml_dev/docs/history/history.rest
    pyplusplus_dev/docs/documentation/containers.rest
    pyplusplus_dev/docs/history/history.rest

Modified: pygccxml_dev/docs/download.rest
===================================================================

--- pygccxml_dev/docs/download.rest	2009-02-18 21:17:50 UTC (rev 1692)
+++ pygccxml_dev/docs/download.rest	2009-02-19 10:54:51 UTC (rev 1693)
@@ -44,14 +44,10 @@
 
 .. _`instructions` : http://gccxml.org/HTML/Install.html
 
-3. You can use `GCC-XML`_ installer created by me. Go to `download page`_ and get
-   `"gccxml_installer.zip"`_ file. You will find installation instructions within
-   the file. The setup is basically small Python script, which installs `GCC-XML`_
-   to the specified directory. It works pretty well for me on Linux and Windows.
-   You don't have to download CMake build system or anything else.
+3. You can use `GCC-XML`_ installer built by me, from the CVS. Go to `download page`_
+   and download "gccxml-setup".
 
-.. _`download page` : http://sourceforge.net/project/showfiles.php?group_id=118209&package_id=146545
-.. _`"gccxml_installer.zip"` : http://sourceforge.net/project/showfiles.php?group_id=118209&package_id=146545
+.. _`download page` : http://sourceforge.net/project/showfiles.php?group_id=118209
 
 pygccxml
 --------

Modified: pygccxml_dev/docs/history/history.rest
===================================================================
--- pygccxml_dev/docs/history/history.rest	2009-02-18 21:17:50 UTC (rev 1692)
+++ pygccxml_dev/docs/history/history.rest	2009-02-19 10:54:51 UTC (rev 1693)
@@ -22,7 +22,6 @@
 * Ben Schleimer
 * Gustavo Carneiro
 
-
 -----------
 Version 1.1
 -----------
@@ -38,6 +37,12 @@
 4. From now on, :doc:`pygccxml <../pygccxml>` will use `Sphinx <http://sphinx.pocoo.org/>`_
    for all documentation.
 
+5. From now on, `pygccxml` will provide convenient setup for latest `GCC-XML`_
+   version (CVS). See :doc:`download <../download>` document.
+
+6. Bug `[ 2431993 ] pygccxml parses const volatile variable args as just const <http://sourceforge.net/tracker/index.php?func=detail&aid=2431993&group_id=118209&atid=684318>`_
+   was fixed.
+
 -----------
 Version 1.0
 -----------

Modified: pyplusplus_dev/docs/documentation/containers.rest
===================================================================
--- pyplusplus_dev/docs/documentation/containers.rest	2009-02-18 21:17:50 UTC (rev 1692)
+++ pyplusplus_dev/docs/documentation/containers.rest	2009-02-19 10:54:51 UTC (rev 1693)
@@ -63,12 +63,58 @@
 How does it work?
 -----------------
 
-In both cases, :doc:`Py++ <../pyplusplus>` provides almost "hands free" solution. :doc:`Py++ <../pyplusplus>`
-keeps track of all exported functions and variables, and if it sees that there is
-a usage of stl container, it exports the container. In both cases, :doc:`Py++ <../pyplusplus>`
-analyzes the container ``value_type`` ( or in case of mapping container
-``mapped_type`` ), in order to set reasonable defaults, when it generates the code.
+In both cases, :doc:`Py++ <../pyplusplus>` provides almost "hands free" solution.
+:doc:`Py++ <../pyplusplus>` keeps track of all exported functions and variables,
+and if it sees that there is a usage of stl container, it exports the container.
+In both cases, :doc:`Py++ <../pyplusplus>` analyzes the container ``value_type``
+( or in case of mapping container ``mapped_type`` ), in order to set reasonable
+defaults, when it generates the code.
 
+-------------------------------------
+Indexing suite version 2 installation
+-------------------------------------
+
+None :-)
+
+`Py++` version 1.1, introduceds few breaking changes to this indexing suite:
+
+* the suite implements all functionality in the header files only. Few `.cpp` files
+  were dropped
+
+* header files include directive was changed from
+
+  .. code-block:: c++
+
+     #include "boost/python/suite/indexing/..."
+
+  to
+
+  .. code-block:: c++
+
+     #include "indexing_suite/..."
+
+The change was done to simplify the indexing suite installation and redistribution.
+The gain list:
+
+   * no need to deal with patching and rebuilding Boost
+
+   * it is possible to use Boost libraries, which comes with your system
+
+   * you can put the library anywhere you want - just update the include paths in
+     your build script
+
+   * it is easier to redistribute it - just include the library with your sources
+
+   * If you are a happy :doc:`Py++ <../pyplusplus>` user:
+
+        + :doc:`Py++ <../pyplusplus>` will generate the indexing suite source files
+          in the "generated code" directory, under `indexing_suite` directory.
+
+        + :doc:`Py++ <../pyplusplus>` will take care to upgrade the files
+
+The bottom line: :doc:`Py++ <../pyplusplus>` makes C++ STL containers handling fully
+transparent for its users.
+
 -------------------
 Indexing suites API
 -------------------

Modified: pyplusplus_dev/docs/history/history.rest
===================================================================
--- pyplusplus_dev/docs/history/history.rest	2009-02-18 21:17:50 UTC (rev 1692)
+++ pyplusplus_dev/docs/history/history.rest	2009-02-19 10:54:51 UTC (rev 1693)
@@ -1,6 +1,6 @@
-========================
-Py++ development history
-========================
+===================
+Development history
+===================
 
 ------------
 Contributors
@@ -26,21 +26,28 @@
 * Carsten( spom.spom )
 
 -----------
-SVN Version
+Version 1.1
 -----------
 
 1. The bug related to exposing free operators was fixed. Many thanks to Andrei Vermel.
 
 2. Few bugs were fixed for 64Bit platform. Many thanks to Carsten.
 
-3. `ctypes`_ backend was introduced - :doc:`Py++ <../pyplusplus>` is able to generate
-   Python code, which uses `ctypes`_ package to call functions in DLLs or shared libraries.
+3. :mod:`ctypes` backend was introduced - :doc:`Py++ <../pyplusplus>` is able to
+   generate Python code, which uses :mod:`ctypes` package to call functions in
+   DLLs or shared libraries.
 
+   Massive refactoring, which preserve backward compatibility to previous releases,
+   was done.
+
 4. From now on, :doc:`Py++ <../pyplusplus>` will use `Sphinx <http://sphinx.pocoo.org/>`_
    for all documentation.
 
+5. :doc:`Indexing Suite V2 <../documentation/indexing_suite_v2.html>` introduces
+   few backward compatibility changes. The indexing suite became "headers only"
+   library and doesn't requier Boost.Python library patching.
+   See ":doc:`../documentation/containers`" document for more information.
 
-.. _`ctypes` : http://docs.python.org/library/ctypes.html
 
 -----------
 Version 1.0


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


