[src/trunk]: src/share/man/man9 Clear up documentation for crypto_unregister(...

[pgoyette <pgoyette%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/c65ab889ed01
branches:  trunk
changeset: 325597:c65ab889ed01
user:      pgoyette <pgoyette%NetBSD.org@localhost>
date:      Tue Dec 31 01:55:05 2013 +0000

description:
Clear up documentation for crypto_unregister() vs crypto_unregister_all()
since there is no definition of CRYPTO_ALGORITHM_ALL!

XXX The description of the arguments for crypto_register() needs further
updates, too, but that will be left for another day.

diffstat:

 share/man/man9/opencrypto.9 |  25 ++++++++++++-------------
 1 files changed, 12 insertions(+), 13 deletions(-)

diffs (69 lines):

diff -r 50c17a5bff99 -r c65ab889ed01 share/man/man9/opencrypto.9
--- a/share/man/man9/opencrypto.9       Tue Dec 31 00:25:17 2013 +0000
+++ b/share/man/man9/opencrypto.9       Tue Dec 31 01:55:05 2013 +0000
@@ -1,5 +1,5 @@
 .\"    $OpenBSD: crypto.9,v 1.25 2003/07/11 13:47:41 jmc Exp $
-.\"    $NetBSD: opencrypto.9,v 1.13 2013/07/20 21:39:59 wiz Exp $
+.\"    $NetBSD: opencrypto.9,v 1.14 2013/12/31 01:55:05 pgoyette Exp $
 .\"
 .\" The author of this man page is Angelos D. Keromytis (angelos%cis.upenn.edu@localhost)
 .\"
@@ -16,7 +16,7 @@
 .\" MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
 .\" PURPOSE.
 .\"
-.Dd September 17, 2011
+.Dd December 30, 2013
 .Dt OPENCRYPTO 9
 .Os
 .Sh NAME
@@ -25,6 +25,7 @@
 .Nm crypto_register ,
 .Nm crypto_kregister ,
 .Nm crypto_unregister ,
+.Nm crypto_unregister_all ,
 .Nm crypto_done ,
 .Nm crypto_kdone ,
 .Nm crypto_newsession ,
@@ -44,6 +45,8 @@
 .Fn crypto_kregister "u_int32_t" "int" "u_int32_t" "int (*)(void *, struct cryptkop *, int)" "void *"
 .Ft int
 .Fn crypto_unregister "u_int32_t" "int"
+.Ft int
+.Fn crypto_unregister_all "u_int32_t"
 .Ft void
 .Fn crypto_done "struct cryptop *"
 .Ft void
@@ -475,6 +478,7 @@
 .Fn crypto_register ,
 .Fn crypto_kregister ,
 .Fn crypto_unregister ,
+.Fn crypto_unregister_all ,
 and
 .Fn crypto_done
 routines are used by drivers that provide support for cryptographic
@@ -500,18 +504,13 @@
 .Fn crypto_unregister
 is called by drivers that wish to withdraw support for an algorithm.
 The two arguments are the driver and algorithm identifiers, respectively.
-Typically, drivers for
-.Xr pcmcia 4
-crypto cards that are being ejected will invoke this routine for all
 algorithms supported by the card.
-If called with
-.Dv CRYPTO_ALGORITHM_ALL ,
-all algorithms registered for a driver will be unregistered in one go
-and the driver will be disabled (no new sessions will be allocated on
-that driver, and any existing sessions will be migrated to other
-drivers).
-The same will be done if all algorithms associated with a driver are
-unregistered one by one.
+If all algorithms associated with a driver are unregistered, the
+driver will be disabled (no new sessions will be allocated on that
+driver, and any existing sessions will be migrated to other drivers).
+.Fn crypto_unregister_all
+will unregister all registered algorithms, disable the driver,
+and migrate existing sessions to other drivers.
 .Pp
 The calling convention for the three driver-supplied routines is:
 .Bd -literal