diff options
author | imp <imp@FreeBSD.org> | 2016-05-17 17:08:13 +0000 |
---|---|---|
committer | imp <imp@FreeBSD.org> | 2016-05-17 17:08:13 +0000 |
commit | e933c7e5ffc8984e71b199997630da74abb191a7 (patch) | |
tree | e874d3648d5fa442ded69e5e12d1ee2877521735 /share | |
parent | dbae7943863e2022093c127cefd718f067729751 (diff) | |
download | FreeBSD-src-e933c7e5ffc8984e71b199997630da74abb191a7.zip FreeBSD-src-e933c7e5ffc8984e71b199997630da74abb191a7.tar.gz |
Per Ravi Pokala's suggestion, rewrite the g_reset_bio description to
be clearer. It also describes it with more nuance. Add missing MLINKS
noticed by trasz@. Bump the date.
Diffstat (limited to 'share')
-rw-r--r-- | share/man/man9/Makefile | 3 | ||||
-rw-r--r-- | share/man/man9/g_bio.9 | 30 |
2 files changed, 17 insertions, 16 deletions
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index 2731608..5288f03 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -787,7 +787,8 @@ MLINKS+=g_bio.9 g_alloc_bio.9 \ g_bio.9 g_destroy_bio.9 \ g_bio.9 g_duplicate_bio.9 \ g_bio.9 g_new_bio.9 \ - g_bio.9 g_print_bio.9 + g_bio.9 g_print_bio.9 \ + g_bio.9 g_reset_bio.9 MLINKS+=g_consumer.9 g_destroy_consumer.9 \ g_consumer.9 g_new_consumer.9 MLINKS+=g_data.9 g_read_data.9 \ diff --git a/share/man/man9/g_bio.9 b/share/man/man9/g_bio.9 index 34f8f94..5bfbd01 100644 --- a/share/man/man9/g_bio.9 +++ b/share/man/man9/g_bio.9 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd May 9, 2016 +.Dd May 17, 2016 .Dt G_BIO 9 .Os .Sh NAME @@ -213,27 +213,27 @@ The .Fn g_reset_bio function resets the given .Vt bio -for reuse. -Prior to -.Fx 11 -a -.Vt bio -was reset for reuse with -.Xr bzero 3 . +structure back to its initial state. .Fn g_reset_bio -preserves internal data structures, while resetting all -user visible values. -Its use is required for any +preserves internal data structures, while setting all +user visible fields to their initial values. +When reusing a .Vt bio -that has been returned by +obtained from .Fn g_new_bio , .Fn g_alloc_bio , .Fn g_clone_bio , or -.Fn g_duplicate_bio . -It may be used for a +.Fn g_duplicate_bio +for multiple transactions, +.Fn g_reset_bio +must be called between the transactions in lieu of +.Fn bzero . +While not strictly required for a .Vt bio -created in another way, but that is not required. +structure created by other means, +.Fn g_reset_bio +should be used to initialize it and between transactions. .Sh RETURN VALUES The .Fn g_new_bio |