summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Maidanski <ivmai@mail.ru>2021-11-01 22:37:06 +0300
committerIvan Maidanski <ivmai@mail.ru>2021-11-01 23:17:15 +0300
commit0b9ad5bc9ae331c7b4bb4564d8aa3de6a9275189 (patch)
tree541c4e57aff7f962c2ad86c74bd262ab4a8b0ed2
parent7a98b9e7e9f12408037121516049f7a092b8699d (diff)
downloadlibatomic_ops-0b9ad5bc9ae331c7b4bb4564d8aa3de6a9275189.tar.gz
Move all README and license files to the top folder
The rationale: all relative links (in README.md) should remain valid after docs installation. * doc/LICENSING.txt: Move to the base folder. * doc/README_details.txt: Likewise. * doc/README_malloc.txt: Likewise. * doc/README_stack.txt: Likewise. * doc/README_win32.txt: Likewise. * Makefile.am (SUBDIRS): Remove doc item. * Makefile.am [ENABLE_DOCS] (dist_doc_DATA): Add comment and items from doc/Makefile.am. * README.md (Overview): Replace reference to doc with the links to the existing README_*.txt files (except for README_win32.txt). * README.md (Installation and Usage): Add link to LICENSING.txt. * README.md (Platform Specific Notes): Add link to README_win32.txt. * README.md (Copyright & Warranty): Adjust link to LICENSING.txt (after moving to the base folder). * configure.ac (AC_CONFIG_FILES): Remove doc/Makefile item. * doc/Makefile.am: Remove file. * src/atomic_ops_malloc.h: Update path to LICENSING.txt in comment.
-rw-r--r--LICENSING.txt (renamed from doc/LICENSING.txt)0
-rw-r--r--Makefile.am6
-rw-r--r--README.md18
-rw-r--r--README_details.txt (renamed from doc/README_details.txt)0
-rw-r--r--README_malloc.txt (renamed from doc/README_malloc.txt)0
-rw-r--r--README_stack.txt (renamed from doc/README_stack.txt)0
-rw-r--r--README_win32.txt (renamed from doc/README_win32.txt)0
-rw-r--r--configure.ac1
-rw-r--r--doc/Makefile.am7
-rw-r--r--src/atomic_ops_malloc.h2
10 files changed, 18 insertions, 16 deletions
diff --git a/doc/LICENSING.txt b/LICENSING.txt
index dca21d7..dca21d7 100644
--- a/doc/LICENSING.txt
+++ b/LICENSING.txt
diff --git a/Makefile.am b/Makefile.am
index f71cf20..7039a23 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = src doc tests
+SUBDIRS = src tests
ACLOCAL_AMFLAGS = -I m4
@@ -6,8 +6,10 @@ pkgconfigdir = $(libdir)/pkgconfig
pkgconfig_DATA = pkgconfig/atomic_ops.pc
noinst_DATA = pkgconfig/atomic_ops-uninstalled.pc
+# Installed documentation.
if ENABLE_DOCS
-dist_doc_DATA = COPYING README.md
+dist_doc_DATA = COPYING LICENSING.txt README.md README_details.txt \
+ README_malloc.txt README_stack.txt README_win32.txt
endif
EXTRA_DIST = autogen.sh
diff --git a/README.md b/README.md
index 9b67c68..3a539d7 100644
--- a/README.md
+++ b/README.md
@@ -44,8 +44,15 @@ allow you to write code:
* To experiment with new and much better thread programming paradigms, etc.
-For details and licensing restrictions see the files in the "doc"
-subdirectory.
+Please see other README files for the details:
+
+* [README_details.txt](README_details.txt) - details about atomic_ops.h
+
+* [README_malloc.txt](README_malloc.txt) - a simple almost-lock-free malloc
+ implementation
+
+* [README_stack.txt](README_stack.txt) - an almost lock-free LIFO linked
+ lists (stack) implementation
## Installation and Usage
@@ -62,7 +69,7 @@ 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 for more details about the licensing.
+ See [LICENSING.txt](LICENSING.txt) for more details about the licensing.
* `libatomic_ops_gpl.a` contains some higher level facilities. This code is
currently covered by the GPL. The contents currently correspond to
@@ -73,7 +80,8 @@ However, two small libraries are built and installed:
Win32/64: src/Makefile.msft contains a very simple Makefile for building
and running tests and building the gpl library. The core `libatomic_ops`
-implementation is entirely in header files.
+implementation is entirely in header files. More information is provided in
+[README_win32.txt](README_win32.txt) file.
HP-UX/PA-RISC: `aCC -Ae` won't work as a C compiler, since it doesn't support
inline assembly code. Use cc.
@@ -131,4 +139,4 @@ The file gcc/sh.h is
* Copyright (c) 2009 by Takashi YOSHII. All rights reserved.
Please be aware of the dual nature of the license of libatomic_ops,
-see [LICENSING.txt](doc/LICENSING.txt) for the details.
+see [LICENSING.txt](LICENSING.txt) for the details.
diff --git a/doc/README_details.txt b/README_details.txt
index 8f5c137..8f5c137 100644
--- a/doc/README_details.txt
+++ b/README_details.txt
diff --git a/doc/README_malloc.txt b/README_malloc.txt
index c3e9c30..c3e9c30 100644
--- a/doc/README_malloc.txt
+++ b/README_malloc.txt
diff --git a/doc/README_stack.txt b/README_stack.txt
index 0c1bba6..0c1bba6 100644
--- a/doc/README_stack.txt
+++ b/README_stack.txt
diff --git a/doc/README_win32.txt b/README_win32.txt
index 174de57..174de57 100644
--- a/doc/README_win32.txt
+++ b/README_win32.txt
diff --git a/configure.ac b/configure.ac
index d8e77fc..e55ab0c 100644
--- a/configure.ac
+++ b/configure.ac
@@ -231,7 +231,6 @@ AM_CONDITIONAL(NEED_ASM, test x$need_asm = xtrue)
AC_CONFIG_FILES([
Makefile
- doc/Makefile
src/Makefile
tests/Makefile
pkgconfig/atomic_ops.pc
diff --git a/doc/Makefile.am b/doc/Makefile.am
deleted file mode 100644
index 571b52b..0000000
--- a/doc/Makefile.am
+++ /dev/null
@@ -1,7 +0,0 @@
-# installed documentation
-#
-
-if ENABLE_DOCS
-dist_doc_DATA = LICENSING.txt README_details.txt README_stack.txt \
- README_malloc.txt README_win32.txt
-endif
diff --git a/src/atomic_ops_malloc.h b/src/atomic_ops_malloc.h
index f9ed900..68806d3 100644
--- a/src/atomic_ops_malloc.h
+++ b/src/atomic_ops_malloc.h
@@ -21,7 +21,7 @@
*/
/* Almost lock-free malloc implementation based on stack implementation. */
-/* See doc/README_malloc.txt file for detailed usage rules. */
+/* See README_malloc.txt file for detailed usage rules. */
#ifndef AO_MALLOC_H
#define AO_MALLOC_H