[Teem-commit] SF.net SVN: teem:[7122] teem/trunk/python/cffi/cdef/00-README.txt

[<kin...@us...>]

Revision: 7122
          http://sourceforge.net/p/teem/code/7122
Author:   kindlmann
Date:     2023-07-17 15:43:00 +0000 (Mon, 17 Jul 2023)
Log Message:
-----------
about these files

Added Paths:
-----------
    teem/trunk/python/cffi/cdef/00-README.txt

Added: teem/trunk/python/cffi/cdef/00-README.txt
===================================================================
--- teem/trunk/python/cffi/cdef/00-README.txt	                        (rev 0)
+++ teem/trunk/python/cffi/cdef/00-README.txt	2023-07-17 15:43:00 UTC (rev 7122)
@@ -0,0 +1,12 @@
+The *.h header files in here document Teem's C API for the sake of Python's
+CFFI. They are created by ../build_teem.py (run periodically to stay in synch
+with Teem source), and read by ../exult.py, which passes their contents to
+cffi.ffi.cdef(), so that CFFI can compile its bridge between Python and C.
+
+They differ from the real teem/*.h header files because CFFI's reader does not
+handle #include, most #define's, or most anything else that hinges on the
+pre-processor.
+
+There is no value in editing these files by hand - it will only cause confusion
+by having a mismatch between the real headers and these for declaring the
+Python bindings.

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