[Gc] Resurrection of INSTALL notes

Petter Urkedal urkedal at nbi.dk
Wed Sep 30 10:50:20 PDT 2009


The hand-edited INSTALL document under libatomic_ops was overwritten by
Automake recently.  That can be avoided by
"AM_INIT_AUTOMAKE([foreign])", but how about adding the info into the
README instead?

Attached is a patch.  Please note that I edited the text a bit.  The old
version can be found at

http://bdwgc.cvs.sourceforge.net/viewvc/bdwgc/bdwgc/libatomic_ops-1.2/INSTALL?hideattic=0&revision=1.2&view=markup

for your reference.
-------------- next part --------------
diff --git a/libatomic_ops/README b/libatomic_ops/README
index 81aa8b7..8a3416e 100755
--- a/libatomic_ops/README
+++ b/libatomic_ops/README
@@ -1,3 +1,6 @@
+Synopsis
+========
+
 This package provides semi-portable access to hardware provided
 atomic memory operations.  These might allow you to write code:
 
@@ -11,3 +14,33 @@ atomic memory operations.  These might allow you to write code:
 
 For details and licensing restrictions see the files in the doc
 subdirectory.
+
+
+Installation and Usage
+======================
+
+The configuration and build scripts for this package were generated by
+Automake/Autoconf.  "./configure --prefix=<install dir>; make; make install"
+in this directory should work.  For a more customized build, see "INSTALL"
+and the output of "./configure --help".
+
+Note that much of the content of this library is in the header files.
+However, two small libraries are built and installed:
+
+- libatomic_ops.a is a support library, which is not needed on some platforms.
+  This is intended to be usable, under some mild restrictions, in free or
+  proprietary code, as are all the header files.  See doc/LICENSING.txt.
+- libatomic_ops_gpl.a contains some higher level facilities.  This code is
+  currently covered by the GPL.  The contents currently correspond to
+  the headers atomic_ops_stack.h and atomic_ops_malloc.h.
+
+
+Platform Specific Notes
+=======================
+
+Win32/64: src/Makefile.msft contains a very simple Makefile for building
+and running tests and building the gpl library.  The core atomic_ops
+implementation is entirely in header files.
+
+HP-UX/PA-RISC: aCC -Ae won't work as a C compiler, since it doesn't support
+inline assembly code.  Use cc.


More information about the Gc mailing list