watch_queue: Drop references to /dev/watch_queue
authorGabriel Krisman Bertazi <krisman@collabora.com>
Tue, 24 Nov 2020 20:28:02 +0000 (15:28 -0500)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 4 Mar 2021 10:37:59 +0000 (11:37 +0100)
[ Upstream commit 8fe62e0c0e2efa5437f3ee81b65d69e70a45ecd2 ]

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>
Signed-off-by: Sasha Levin <sashal@kernel.org>
Documentation/security/keys/core.rst
samples/Kconfig
samples/watch_queue/watch_test.c
security/keys/Kconfig

index aa00816..b3ed5c5 100644 (file)
@@ -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.
index 0ed6e4d..e76cdfc 100644 (file)
@@ -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(),
index 46e618a..8c6cb57 100644 (file)
@@ -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 (dhowells@redhat.com)
index 83bc234..c161642 100644 (file)
@@ -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.