[pygccxml-commit] SF.net SVN: pygccxml: [1217] pyplusplus_dev/docs/documentation

[<rom...@us...>]

Revision: 1217
          http://pygccxml.svn.sourceforge.net/pygccxml/?rev=1217&view=rev
Author:   roman_yakovenko
Date:     2008-01-03 04:25:07 -0800 (Thu, 03 Jan 2008)

Log Message:
-----------
updating docs

Modified Paths:
--------------
    pyplusplus_dev/docs/documentation/how_to.rest
    pyplusplus_dev/docs/documentation/split_module.rest

Modified: pyplusplus_dev/docs/documentation/how_to.rest
===================================================================
--- pyplusplus_dev/docs/documentation/how_to.rest	2008-01-03 10:23:45 UTC (rev 1216)
+++ pyplusplus_dev/docs/documentation/how_to.rest	2008-01-03 12:25:07 UTC (rev 1217)
@@ -376,6 +376,35 @@
 The nice thing about this approach is that now `Python`_ users have "normal"
 class name and you have short file name.
 
+-------------------
+Full\relative paths
+-------------------
+
+Consider next file layout:
+::
+
+  boost/
+    date_time/
+      ptime.hpp
+      time_duration.hpp
+      date_time.hpp //main header, which include all other header files
+
+Py++ currently does not handle relative paths as input very well, so it is 
+recommended that you use ``os.path.abspath()`` to transform the header file to 
+be processed into an absolute path:
+  
+.. code-block:: Python
+    
+   #Next code will expose nothing
+   mb = module_builder( [ 'date_time/date_time.hpp' ], ... ) 
+   mb.split_module( ... )
+
+   #while this one will work as expected
+   import os
+   mb = module_builder( [ os.path.abspath('date_time/date_time.hpp') ], ... ) 
+   mb.split_module( ... )
+
+
 .. _`Py++` : ./../pyplusplus.html
 .. _`Boost.Python`: http://www.boost.org/libs/python/doc/index.html
 .. _`Python`: http://www.python.org

Modified: pyplusplus_dev/docs/documentation/split_module.rest
===================================================================
--- pyplusplus_dev/docs/documentation/split_module.rest	2008-01-03 10:23:45 UTC (rev 1216)
+++ pyplusplus_dev/docs/documentation/split_module.rest	2008-01-03 12:25:07 UTC (rev 1217)
@@ -209,11 +209,23 @@
   * ``huge_classes`` - list of names of huge classes
   * ``on_unused_file_found`` - callable object, which is called every time
     `Py++`_ found that previously generated file is not in use anymore.
-  * ``use_files_sum_repository`` - Py++ can generate file, which will contain md5 
-    sum of every generated file. Next time you generate code, md5sum will be loaded 
-    from the file and compared. This could speed-up code generation process by 10-15%
-    on big projects.
+  * ``use_files_sum_repository``
+    `Py++`_ is able to store md5 sum of the generated files in a file. Next 
+    time you will generate code, Py++ will compare generated file content 
+    against the sum, instead of loading the content of the previously generated
+    file from the disk and comparing against it. 
 
+    "<your module name>.md5.sum" is the file, that will be generated in the
+    ``dir_name`` directory.
+
+    Enabling this functionality should give you 10-15% of performance boost.
+
+    Warning: If you changed manually some of the files - don't forget to delete
+    the relevant line from "md5.sum" file. You can also delete the whole file. 
+    If the file is missing, Py++ will use old plain method of comparing content 
+    of the files. It will not re-write "unchanged" files and you will not be 
+    forced to recompile the whole project.
+
 *  
   .. code-block:: Python
 
@@ -227,9 +239,6 @@
   * ``number_of_files`` - the desired number of generated source files
   
 
-
-
-
 .. _`Py++` : ./../pyplusplus.html
 .. _`pygccxml` : ./../../pygccxml/pygccxml.html
 .. _`Boost.Python`: http://www.boost.org/libs/python/doc/index.html


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