Commit 8fe62e0c authored by Gabriel Krisman Bertazi's avatar Gabriel Krisman Bertazi Committed by David Howells
Browse files

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: f7e47677 ("watch_queue: Add a key/keyring notification facility")
Signed-off-by: default avatarGabriel Krisman Bertazi <krisman@collabora.com>
Signed-off-by: default avatarDavid Howells <dhowells@redhat.com>
Acked-by: default avatarJarkko Sakkinen <jarkko@kernel.org>
Reviewed-by: default avatarBen Boeckel <mathstuf@gmail.com>
parent 796e46f9

Documentation/security/keys/core.rst

+2 −2
Original line number Diff line number Diff line
@@ -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.

samples/Kconfig

+1 −1
Original line number Diff line number Diff line
@@ -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(),

samples/watch_queue/watch_test.c

+1 −1
Original line number Diff line number Diff line 
// 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 (dhowells@redhat.com)

security/keys/Kconfig

+4 −4
Original line number Diff line number Diff line
@@ -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.