summaryrefslogtreecommitdiff
path: root/share/man
diff options
context:
space:
mode:
authorDavid Gwynne <dlg@cvs.openbsd.org>2019-07-05 04:41:24 +0000
committerDavid Gwynne <dlg@cvs.openbsd.org>2019-07-05 04:41:24 +0000
commit34f55987906b59a4ab800effb42ca19bfc614a71 (patch)
treea23a028ab48ed6a7302a13b8fcf8bd3b82c5486c /share/man
parent41cf431ad9df9c0b63cd76846aa62158b2e5a0fb (diff)
Xr between all the different smr pages.
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man9/SMR_LIST_INIT.96
-rw-r--r--share/man/man9/SMR_PTR_GET.97
-rw-r--r--share/man/man9/smr_call.913
3 files changed, 16 insertions, 10 deletions
diff --git a/share/man/man9/SMR_LIST_INIT.9 b/share/man/man9/SMR_LIST_INIT.9
index 6b21abf5644..19c586b8c56 100644
--- a/share/man/man9/SMR_LIST_INIT.9
+++ b/share/man/man9/SMR_LIST_INIT.9
@@ -1,4 +1,4 @@
-.\" $OpenBSD: SMR_LIST_INIT.9,v 1.1 2019/02/26 14:28:20 visa Exp $
+.\" $OpenBSD: SMR_LIST_INIT.9,v 1.2 2019/07/05 04:41:23 dlg Exp $
.\"
.\" Copyright (c) 2019 Visa Hankala
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: February 26 2019 $
+.Dd $Mdocdate: July 5 2019 $
.Dt SMR_LIST_INIT 9
.Os
.Sh NAME
@@ -325,7 +325,7 @@ can be used from writer context.
.Sh SEE ALSO
.Xr queue 3 ,
.Xr smr_call 9 ,
-.Xr smr_read_enter 9
+.Xr SMR_PTR_GET 9
.Sh HISTORY
The SMR list macros first appeared in
.Ox 6.5 .
diff --git a/share/man/man9/SMR_PTR_GET.9 b/share/man/man9/SMR_PTR_GET.9
index b607891e85f..34520f08825 100644
--- a/share/man/man9/SMR_PTR_GET.9
+++ b/share/man/man9/SMR_PTR_GET.9
@@ -1,4 +1,4 @@
-.\" $OpenBSD: SMR_PTR_GET.9,v 1.1 2019/02/26 14:28:20 visa Exp $
+.\" $OpenBSD: SMR_PTR_GET.9,v 1.2 2019/07/05 04:41:23 dlg Exp $
.\"
.\" Copyright (c) 2019 Visa Hankala
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: February 26 2019 $
+.Dd $Mdocdate: July 5 2019 $
.Dt SMR_PTR_GET 9
.Os
.Sh NAME
@@ -63,7 +63,8 @@ and
.Fn SMR_PTR_SET_LOCKED
can be used from writer context.
.Sh SEE ALSO
-.Xr smr_read_enter 9
+.Xr smr_read_enter 9 ,
+.Xr SMR_LIST_INIT 9
.Sh HISTORY
The SMR_PTR macros first appeared in
.Ox 6.5 .
diff --git a/share/man/man9/smr_call.9 b/share/man/man9/smr_call.9
index fac24666075..f1b6be30090 100644
--- a/share/man/man9/smr_call.9
+++ b/share/man/man9/smr_call.9
@@ -1,4 +1,4 @@
-.\" $OpenBSD: smr_call.9,v 1.1 2019/02/26 14:28:20 visa Exp $
+.\" $OpenBSD: smr_call.9,v 1.2 2019/07/05 04:41:23 dlg Exp $
.\"
.\" Copyright (c) 2019 Visa Hankala
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: February 26 2019 $
+.Dd $Mdocdate: July 5 2019 $
.Dt SMR_CALL 9
.Os
.Sh NAME
@@ -53,7 +53,10 @@ The mechanism guarantees that SMR-protected objects are not destroyed
while readers are using them.
However, it does not control how these objects are modified.
.Pp
-Readers access SMR-protected objects inside SMR read-side critical section.
+Readers access SMR-protected objects inside an SMR read-side critical section
+using
+.Xr SMR_PTR_GET 9 .
+.\" or with a higher level API built on top of it.
The section is entered with
.Fn smr_read_enter ,
and exited with
@@ -118,7 +121,9 @@ and
can be called during autoconf, or from process context.
.Sh SEE ALSO
.Xr mutex 9 ,
-.Xr rwlock 9
+.Xr rwlock 9 ,
+.Xr SMR_LIST_INIT 9 ,
+.Xr SMR_PTR_GET 9
.Sh HISTORY
The SMR API first appeared in
.Ox 6.5 .