From 147988d9b950026c2468eeb1af9b35af83d2fee5 Mon Sep 17 00:00:00 2001 From: Ivan Maidanski Date: Thu, 12 Sep 2013 09:35:59 +0400 Subject: Convert README to Markdown format * README: Rename to README.md; adjust formatting to follow Markdown syntax. --- README | 55 ------------------------------------------------------- README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+), 55 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 9c7678a..0000000 --- a/README +++ /dev/null @@ -1,55 +0,0 @@ -== Synopsis == - -This package provides semi-portable access to hardware provided -atomic memory operations. These might allow you to write code: - -- That does more interesting things in signal handlers. -- Makes more effective use of multiprocessors by allowing you to write - clever lock-free code. Note that such code is very difficult to get - right, and will unavoidably be less portable than lock-based code. It - is also not always faster than lock-based code. But it may occasionally - be a large performance win. -- To experiment with new and much better thread programming paradigms, etc. - -For details and licensing restrictions see the files in the doc -subdirectory. - -This is version 7.3alpha3 of libatomic_ops. - -You might find a more recent version of this at - -http://www.hpl.hp.com/personal/Hans_Boehm/gc - -or - -http://www.hpl.hp.com/research/linux/atomic_ops/ - -Please address bug reports to gc@linux.hpl.hp.com - - -== Installation and Usage == - -The configuration and build scripts for this package were generated by -Automake/Autoconf. "./configure --prefix=; make; make install" -in this directory should work. For a more customized build, see 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8eb257b --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# The atomic_ops library (libatomic_ops) + +This is version (release) 7.3alpha3 of libatomic_ops. + +You might find a more recent version +[here](http://www.hpl.hp.com/personal/Hans_Boehm/gc), or +[here](http://www.hpl.hp.com/research/linux/atomic_ops/). + + +## Overview + +This package provides semi-portable access to hardware-provided +atomic memory update operations on a number architectures. These might +allow you to write code: + +* That does more interesting things in signal handlers. + +* Makes more effective use of multiprocessors by allowing you to write + clever lock-free code. Note that such code is very difficult to get + right, and will unavoidably be less portable than lock-based code. It + is also not always faster than lock-based code. But it may occasionally + be a large performance win. + +* To experiment with new and much better thread programming paradigms, etc. + +For details and licensing restrictions see the files in the "doc" +subdirectory. + +Please address bug reports [here](mailto:gc@linux.hpl.hp.com). + + +## Installation and Usage + +The configuration and build scripts for this package were generated by +Automake/Autoconf. "./configure; make; sudo make install" in this +directory should work. For a more customized build, see 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. + + +## Copyright & Warranty + +See doc/LICENSING.txt file. -- cgit v1.2.3