[Spread-cvs] commit: r491 - libspreadutil/trunk/docs

[jonathan at spread.org]

Author: jonathan
Date: 2012-03-06 00:26:18 -0500 (Tue, 06 Mar 2012)
New Revision: 491

Modified:
   libspreadutil/trunk/docs/Readme.txt
Log:
Add conversion instructions to the Readme.txt file for existing applications.

Modified: libspreadutil/trunk/docs/Readme.txt
===================================================================
--- libspreadutil/trunk/docs/Readme.txt	2012-03-06 01:38:43 UTC (rev 490)
+++ libspreadutil/trunk/docs/Readme.txt	2012-03-06 05:26:18 UTC (rev 491)
@@ -72,6 +72,33 @@
 The detailed changes in this first release (from the internal code in Spread)
 can be found in the Changelog file. 
 
+STEPS TO CONVERT APPLICATION USING PREVIOUS CODE TO NEW LIBRARY:
+----------------------------------------------------------------
+
+For an application that previously used alarm.c, data_link.c, events.c or memory.c, 
+these are the suggested changes to make the application compatible with using the
+same APIs via this new library. 
+
+1) Fix build:
+   - Change configure.in in application to call subconfigure for libspread-util package
+   - Change top level Makefile.in to add libspread-util as a subdirectory to build (and install if using shared libraries)
+
+2) Integrate with svn to allow customization
+   - Import libspread-util release into vendor branch. Then merge into subdirectory in main package. 
+   This allows local changes to be made to application's version of the library. 
+
+3) Add application specific memory types to libspread-util/include/spu_objects_local.h
+
+4) Fix any usage of the previous APIs that have changed in the new release. These include:
+   - Fix any callers of Alarm_enable_precise_timestamps() to use new function for high_res alarm formats. 
+   - Fix all callers of Mem_init_object() to add the 'obj_name' parameter to the calls. 
+   - Change all #include of the headers to use the new header names of spu_*
+   - Compare local copies of memory.h objects.h alarm.h and make sure the defined types match those in the standard library, or modify the objects_local.h and alarm_types.h files to match the app. 
+   - Change all use of SPLOG_PRINT_NODATE to new feature flag SPLOG_NODATE along with correct main type like SPLOG_PRINT.
+   - Consider changing all application use of "spu_objects.h" to "spu_objects_local.h" as most applications do not need anything from objects.h.
+
+
+
 SOURCE INSTALL:
 ---------------