Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

watch_queue: Drop references to /dev/watch_queue

The merged API doesn't use a watch_queue device, but instead relies on
pipes, so let the documentation reflect that.

Fixes: f7e47677e39a ("watch_queue: Add a key/keyring notification facility")
Signed-off-by: Gabriel Krisman Bertazi <krisman@collabora.com>
Signed-off-by: David Howells <dhowells@redhat.com>
Acked-by: Jarkko Sakkinen <jarkko@kernel.org>
Reviewed-by: Ben Boeckel <mathstuf@gmail.com>

authored by

Gabriel Krisman Bertazi and committed by
David Howells
8fe62e0c 796e46f9

+8 -8
+2 -2
Documentation/security/keys/core.rst
··· 1040 1040 1041 1041 "key" is the ID of the key to be watched. 1042 1042 1043 - "queue_fd" is a file descriptor referring to an open "/dev/watch_queue" 1044 - which manages the buffer into which notifications will be delivered. 1043 + "queue_fd" is a file descriptor referring to an open pipe which 1044 + manages the buffer into which notifications will be delivered. 1045 1045 1046 1046 "filter" is either NULL to remove a watch or a filter specification to 1047 1047 indicate what events are required from the key.
+1 -1
samples/Kconfig
··· 210 210 depends on CC_CAN_LINK 211 211 212 212 config SAMPLE_WATCH_QUEUE 213 - bool "Build example /dev/watch_queue notification consumer" 213 + bool "Build example watch_queue notification API consumer" 214 214 depends on CC_CAN_LINK && HEADERS_INSTALL 215 215 help 216 216 Build example userspace program to use the new mount_notify(),
+1 -1
samples/watch_queue/watch_test.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0 2 - /* Use /dev/watch_queue to watch for notifications. 2 + /* Use watch_queue API to watch for notifications. 3 3 * 4 4 * Copyright (C) 2020 Red Hat, Inc. All Rights Reserved. 5 5 * Written by David Howells (dhowells@redhat.com)
+4 -4
security/keys/Kconfig
··· 119 119 bool "Provide key/keyring change notifications" 120 120 depends on KEYS && WATCH_QUEUE 121 121 help 122 - This option provides support for getting change notifications on keys 123 - and keyrings on which the caller has View permission. This makes use 124 - of the /dev/watch_queue misc device to handle the notification 125 - buffer and provides KEYCTL_WATCH_KEY to enable/disable watches. 122 + This option provides support for getting change notifications 123 + on keys and keyrings on which the caller has View permission. 124 + This makes use of pipes to handle the notification buffer and 125 + provides KEYCTL_WATCH_KEY to enable/disable watches.