summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorH. Peter Anvin <hpa@zytor.com>2001-10-26 02:05:54 (GMT)
committerH. Peter Anvin <hpa@zytor.com>2001-10-26 02:05:54 (GMT)
commitaf538c1a2aa168d1c66e6e1c1fa3a3fb3e5b00b6 (patch)
tree87f586932523ffcccbd621384022ca33254a3ab9
parent4bd929b8e7ca1b8b7d4b2479216eb9120b8b7350 (diff)
downloadlpsm-af538c1a2aa168d1c66e6e1c1fa3a3fb3e5b00b6.zip
lpsm-af538c1a2aa168d1c66e6e1c1fa3a3fb3e5b00b6.tar.gz
lpsm-af538c1a2aa168d1c66e6e1c1fa3a3fb3e5b00b6.tar.bz2
lpsm-af538c1a2aa168d1c66e6e1c1fa3a3fb3e5b00b6.tar.xz
Further documentation cleanup.
-rw-r--r--README6
-rw-r--r--lpsm_checkpoint.3.in3
-rw-r--r--lpsm_recover.3.in6
-rw-r--r--lpsm_shutdown.3.in3
4 files changed, 11 insertions, 7 deletions
diff --git a/README b/README
index a4ec808..008b208 100644
--- a/README
+++ b/README
@@ -67,11 +67,17 @@ 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)
diff --git a/lpsm_checkpoint.3.in b/lpsm_checkpoint.3.in
index 62356d2..983cf79 100644
--- a/lpsm_checkpoint.3.in
+++ b/lpsm_checkpoint.3.in
@@ -102,9 +102,6 @@ checkpoint, and set to 1 when persistent memory is modified.
returns 0 after a successful synchronous operation,
.B "(pid_t)-1"
on failure, or the pid of the spawned asychronous process.
-.PP
-.B lpsm_shutdown()
-does not return a value.
.SH "ERRORS"
Due to the asynchronous nature of
.BR lpsm_checkpoint() ,
diff --git a/lpsm_recover.3.in b/lpsm_recover.3.in
index 8e6a9af..7171d61 100644
--- a/lpsm_recover.3.in
+++ b/lpsm_recover.3.in
@@ -12,7 +12,7 @@
.\" $Id$
.TH LPSM_RECOVER 3 "25 October 2001" "LPSM @@VERSION@@" "Linux Persistent Memory"
.SH NAME
-lpsm_recovery \- Perform offline recovery of an LPSM database
+lpsm_recover \- Perform offline recovery of an LPSM database
.SH SYNOPSIS
.nf
.B #include <lpsm.h>
@@ -30,10 +30,10 @@ is identical to the contents of the LPSM arena, and
is truncated to its minimum size.
.PP
It is safe to call
-.B lpsm_recovery()
+.B lpsm_recover()
while a different arena is mapped.
.SH "RETURN VALUES"
-.B lpsm_recovery()
+.B lpsm_recover()
returns 0 on success and -1 on failure; in the latter case
.I errno
is set to indicate the nature of the error.
diff --git a/lpsm_shutdown.3.in b/lpsm_shutdown.3.in
index 772e60d..35b5e84 100644
--- a/lpsm_shutdown.3.in
+++ b/lpsm_shutdown.3.in
@@ -50,6 +50,7 @@ arena to the last checkpointed state. This is a very slow operation.
does not return a value.
.SH "SEE ALSO"
.BR lpsm_init (3),
-.BR lpsm_arena_init (3).
+.BR lpsm_arena_init (3),
+.BR lpsm_checkpoint (3).
.SH BUGS
The persistent memory system is not currently thread-safe.