keys: sparse: Fix kdoc mismatches

Fix some kdoc argument description mismatches reported by sparse and give
keyring_restrict() a description.

Signed-off-by: David Howells <dhowells@redhat.com>
Reviewed-by: James Morris <jamorris@linux.microsoft.com>
cc: Mat Martineau <mathew.j.martineau@linux.intel.com>
This commit is contained in:
David Howells 2019-05-22 13:30:56 +01:00
parent 7936d16df9
commit 9fd165379e
2 changed files with 8 additions and 4 deletions

View File

@ -520,7 +520,7 @@ EXPORT_SYMBOL(keyring_alloc);
* @keyring: The keyring being added to.
* @type: The type of key being added.
* @payload: The payload of the key intended to be added.
* @data: Additional data for evaluating restriction.
* @restriction_key: Keys providing additional data for evaluating restriction.
*
* Reject the addition of any links to a keyring. It can be overridden by
* passing KEY_ALLOC_BYPASS_RESTRICTION to key_instantiate_and_link() when
@ -976,9 +976,13 @@ static bool keyring_detect_restriction_cycle(const struct key *dest_keyring,
/**
* keyring_restrict - Look up and apply a restriction to a keyring
*
* @keyring: The keyring to be restricted
* @keyring_ref: The keyring to be restricted
* @type: The key type that will provide the restriction checker.
* @restriction: The restriction options to apply to the keyring
*
* Look up a keyring and apply a restriction to it. The restriction is managed
* by the specific key type, but can be configured by the options specified in
* the restriction string.
*/
int keyring_restrict(key_ref_t keyring_ref, const char *type,
const char *restriction)

View File

@ -24,7 +24,7 @@
/**
* complete_request_key - Complete the construction of a key.
* @auth_key: The authorisation key.
* @authkey: The authorisation key.
* @error: The success or failute of the construction.
*
* Complete the attempt to construct a key. The key will be negated