aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorH. Peter Anvin <hpa@zytor.com>2001-10-26 02:39:45 +0000
committerH. Peter Anvin <hpa@zytor.com>2001-10-26 02:39:45 +0000
commitd259839a66ea956f9752ce92082fa264d9ab3f3e (patch)
tree41919fbed23ee44b8fa4267ce3dcc5c1f3dfdc58 /README
parentd5cfcf4d16630bd5961157fb66f6a9d9d288c063 (diff)
downloadlpsm-d259839a66ea956f9752ce92082fa264d9ab3f3e.tar.gz
lpsm-d259839a66ea956f9752ce92082fa264d9ab3f3e.tar.xz
lpsm-d259839a66ea956f9752ce92082fa264d9ab3f3e.zip
Remove stuff from README that is now in lpsm(7), add stuff from
README that belong in lpsm(7) into the latter.
Diffstat (limited to 'README')
-rw-r--r--README47
1 files changed, 1 insertions, 46 deletions
diff --git a/README b/README
index 008b208..5e97688 100644
--- a/README
+++ b/README
@@ -35,49 +35,4 @@ IMPORTANT: I cannot at this stage guarantee that future versions of
the LPSM will be binary compatible. These are test releases. Use at
your own risk.
-LPSM DATABASES ARE NOT PORTABLE. This is pretty much inherent in the
-fact that the LPSM library does not attach any meaning to the data it
-stores. Therefore it is imperative that your application allows a way
-to dump its database contents in a portable form.
-
-Currently the persistent memory database is not sharable nor
-thread-safe. I'm hoping to resolve at least the latter condition in
-due time.
-
-Because the persistent memory is mapped into memory at a fixed address
-(which varies with architecture) it is not possible to have more than
-one LPSM database mapped at any one time.
-
-
-** Functionality description:
-
-The persistent memory store can be used in two modes: managed and
-unmanaged. Unmanaged provides a flat chunk (arena) of memory without
-any further management support; managed provides management via
-malloc/free/realloc.
-
-All of these use a pair of files as backing store: a datafile, which
-is equivalent in size to the managed memory, and a logfile, which is
-used for the commit log.
-
-The LPSM library installs a signal handler for SIGSEGV.
-
-Please see the following man pages included with this distribution:
-
-Unmanaged mode:
-
- lpsm_arena_init(3)
- lpsm_checkpoint(3)
- lpsm_extend(3)
- lpsm_shutdown(3)
- lpsm_recover(3)
-
-Managed mode:
-
- lpsm_init(3)
- lpsm_recover(3)
- lpsm_checkpoint(3)
- lpsm_shutdown(3)
- lpsm_malloc(3)
- lpsm_arena_stats(3)
- lpsm_recover(3)
+Please see the included man page lpsm(7) for usage details.