Additional notes regarding supporting additional platforms and testing

Signed-off-by: Alex Kent Hajnal <software@alephnull.net>

1 files changed, 28 insertions, 3 deletions

diff --git a/tdeio/tdeio/README.xattr b/tdeio/tdeio/README.xattr
index 0c7d32d21..8761702d2 100644
--- a/tdeio/tdeio/README.xattr
+++ b/tdeio/tdeio/README.xattr
@@ -21,9 +21,9 @@ words, even if it only runs on Linux in its current state there is no loss of
 functionality on any other platforms (just a lack of a gaining a feature).  In 
 addition, determining the proper location to insert the library call was the 
 hard part with the actual implementation being quite straightforward.  Adding 
-additional backends for other platforms should be pretty easy.
+additional backends for other platforms should be pretty easy[7].
 
-To test the code build and install it[7] then run the following from the 
+To test the code build and install it[8] then run the following from the 
 commandline in e.g. Konsole:
 
   $ cd PATH_SUPPORTING_USER_XATTRS_AT_THE_FILESYSTEM_LEVEL
@@ -72,6 +72,31 @@ Enjoy!
     in /etc/xattr.conf; other platforms may need special handling.
     (source: File::ExtAttr(3pm), personal testing)
 
-[7] Instead of doing a full install one can simply copy the updated library:
+[7] These files in the tdelibs repository need to be updated when adding 
+    support for a new platform (search for DO_USER_XATTR_COPYING):
+    
+    CMakeLists.txt
+        Add test for any external library used; the library to be linked must 
+        be given in USER_XATTR_LIBRARIES.
+    
+    tdeio.tdeio/CMakeLists.txt
+        Add the new C preprocessor definition (after the existing one for 
+        HAVE_ATTR__ATTR_COPY_FILE).
+    
+    tdeio/tdeio/job.cpp
+        Add new boilerplate code and attribute copy function call (both wrapped 
+        in a conditional checking for the definition set above).
+    
+    tdeio/tdeio/README.xattr  (this file)
+        Add additional notes as appropriate.
+    
+    Also add any distribution-specific library requirements to the tde-packaging
+    repository.
+
+[8] Instead of doing a full install one can simply copy the updated library:
     
     cp -va "BUILD_DIR/tdeio/libtdeio.so.14.0.0" /opt/trinity/lib/ && ldconfig
+    
+    One may also need to run:
+    
+    killall tdeio_file