[CalendarServer-changes] [15212] OSXFrameworks/trunk/README

source_changes at macosforge.org source_changes at macosforge.org
Thu Oct 22 14:49:54 PDT 2015


Revision: 15212
          http://trac.calendarserver.org//changeset/15212
Author:   cdaboo at apple.com
Date:     2015-10-22 14:49:54 -0700 (Thu, 22 Oct 2015)
Log Message:
-----------
Documentation update.

Modified Paths:
--------------
    OSXFrameworks/trunk/README

Modified: OSXFrameworks/trunk/README
===================================================================
--- OSXFrameworks/trunk/README	2015-10-22 21:41:51 UTC (rev 15211)
+++ OSXFrameworks/trunk/README	2015-10-22 21:49:54 UTC (rev 15212)
@@ -3,7 +3,30 @@
 
 This is a python library that wraps a number of useful OS X frameworks.
 
+Develop
+=======
+cffi wrappers for various frameworks live in the osx.frameworks modules. Run
+the osx._corefoundation_cffi_build module to create the osx._corefoundation.so
+module. That contains the cffi extension module for the wrappers. Each time
+changes are made to the wrapper modules, re-run the cffi build.
 
+The other modules in osx are Python objects that wrap various CoreFoundation
+objects to provide implicit CFRetain/CFRelease behavior and also simple
+data conversion APIs between the CF types and Python types. For example to
+turn a Python string "s" into a CFStringRef:
+
+	cfstr = CFStringRef.fromString(s)
+	
+The base Python CFObjectRef class assumes ownership of the underlying CF object
+and will always release it. If the CF object being passed in has not already been
+retained, then set the "owned" argument to False.
+
+Install
+=======
+
+python setup.py build
+
+
 Copyright and License
 =====================
 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20151022/6dc62d88/attachment-0001.html>


More information about the calendarserver-changes mailing list