Skip to content

Commit

Permalink
watch_queue: Drop references to /dev/watch_queue
Browse files Browse the repository at this point in the history
The merged API doesn't use a watch_queue device, but instead relies on
pipes, so let the documentation reflect that.

Fixes: f7e4767 ("watch_queue: Add a key/keyring notification facility")
Signed-off-by: Gabriel Krisman Bertazi <[email protected]>
Signed-off-by: David Howells <[email protected]>
Acked-by: Jarkko Sakkinen <[email protected]>
Reviewed-by: Ben Boeckel <[email protected]>
  • Loading branch information
krisman-at-collabora authored and dhowells committed Jan 21, 2021
1 parent 796e46f commit 8fe62e0
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions Documentation/security/keys/core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1040,8 +1040,8 @@ The keyctl syscall functions are:

"key" is the ID of the key to be watched.

"queue_fd" is a file descriptor referring to an open "/dev/watch_queue"
which manages the buffer into which notifications will be delivered.
"queue_fd" is a file descriptor referring to an open pipe which
manages the buffer into which notifications will be delivered.

"filter" is either NULL to remove a watch or a filter specification to
indicate what events are required from the key.
Expand Down
2 changes: 1 addition & 1 deletion samples/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ config SAMPLE_WATCHDOG
depends on CC_CAN_LINK

config SAMPLE_WATCH_QUEUE
bool "Build example /dev/watch_queue notification consumer"
bool "Build example watch_queue notification API consumer"
depends on CC_CAN_LINK && HEADERS_INSTALL
help
Build example userspace program to use the new mount_notify(),
Expand Down
2 changes: 1 addition & 1 deletion samples/watch_queue/watch_test.c
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0
/* Use /dev/watch_queue to watch for notifications.
/* Use watch_queue API to watch for notifications.
*
* Copyright (C) 2020 Red Hat, Inc. All Rights Reserved.
* Written by David Howells ([email protected])
Expand Down
8 changes: 4 additions & 4 deletions security/keys/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ config KEY_NOTIFICATIONS
bool "Provide key/keyring change notifications"
depends on KEYS && WATCH_QUEUE
help
This option provides support for getting change notifications on keys
and keyrings on which the caller has View permission. This makes use
of the /dev/watch_queue misc device to handle the notification
buffer and provides KEYCTL_WATCH_KEY to enable/disable watches.
This option provides support for getting change notifications
on keys and keyrings on which the caller has View permission.
This makes use of pipes to handle the notification buffer and
provides KEYCTL_WATCH_KEY to enable/disable watches.

0 comments on commit 8fe62e0

Please sign in to comment.