request_key.2: Change argument name 'keyring' to 'dest_keyring'

Using 'dest_keyring' is more meaningful.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2016-10-28 17:27:52 +02:00
parent 53705ead37
commit f3ff1d07b4
1 changed files with 8 additions and 8 deletions

View File

@ -19,7 +19,7 @@ request_key \- request a key from the kernel's key management facility
.sp
.BI "key_serial_t request_key(const char *" type ", const char *" description ,
.BI " const char *" callout_info ,
.BI " key_serial_t " keyring ");"
.BI " key_serial_t " dest_keyring ");"
.fi
No glibc wrapper is provided for this system call; see NOTES.
@ -32,8 +32,8 @@ with a description (name) that matches the specified
If such a key could not be found, then the key is optionally created.
If the key is found or created,
.BR request_key ()
attaches it to the nominated
.I keyring
attaches it to the keyring whose ID is specified in
.I dest_keyring
and returns the key's serial number.
.P
.BR request_key ()
@ -73,7 +73,7 @@ program to instantiate the key.
The details are given below.
The
.I keyring
.I dest_keyring
serial number may be that of a valid keyring for which the caller has
.I write
permission, or it may be one of the following special keyring IDs:
@ -216,8 +216,8 @@ If these steps are unsuccessful, then an
.BR ENOKEY
error will be returned to the caller of
.BR request_key ()
and a temporary negative key will be installed in the nominated
.IR keyring .
and a temporary negative key will be installed in the keyring specified by
.IR dest_keyring .
.\" FIXME Is 'keyring' allowed to be NULL? Reading the source, it appears so,
.\" with the result that the key is linked into a default keyring
.\" as specified by KEYCTL_SET_REQKEY_KEYRING.
@ -228,8 +228,8 @@ to fail until it does.
If a key is created, then\(emregardless of whether it is a valid key or
a negative key\(emit will displace any other key with
the same type and description from the destination
.IR keyring .
the same type and description from the keyring specified in
.IR dest_keyring .
.SH RETURN VALUE
On success,
.BR request_key ()