| Message ID | 20201122054700.1499338-1-krisman@collabora.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | [RESEND] watch_queue: Drop references to /dev/watch_queue | expand |
On Sun, Nov 22, 2020 at 12:47:00AM -0500, Gabriel Krisman Bertazi wrote: > Hi, > > I sent this a while ago and I haven't seen it pop-up in any trees yet. > I'm sorry if I missed it somewhere. > > Otherwise, gently ping. > > -- >8 -- > > The merged API doesn't use a watch_queue device, but instead relies on > pipes, so let the documentation reflect that. > > Cc: David Howells <dhowells@redhat.com> > Signed-off-by: Gabriel Krisman Bertazi <krisman@collabora.com> > --- Shouldn't this have a fixes tag? Otherwise, looks good. > Documentation/security/keys/core.rst | 4 ++-- > samples/Kconfig | 2 +- > samples/watch_queue/watch_test.c | 2 +- > security/keys/Kconfig | 8 ++++---- > 4 files changed, 8 insertions(+), 8 deletions(-) > > diff --git a/Documentation/security/keys/core.rst b/Documentation/security/keys/core.rst > index aa0081685ee1..b3ed5c581034 100644 > --- a/Documentation/security/keys/core.rst > +++ b/Documentation/security/keys/core.rst > @@ -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. > diff --git a/samples/Kconfig b/samples/Kconfig > index 0ed6e4d71d87..e76cdfc50e25 100644 > --- a/samples/Kconfig > +++ b/samples/Kconfig > @@ -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(), > diff --git a/samples/watch_queue/watch_test.c b/samples/watch_queue/watch_test.c > index 46e618a897fe..8c6cb57d5cfc 100644 > --- a/samples/watch_queue/watch_test.c > +++ b/samples/watch_queue/watch_test.c > @@ -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) > diff --git a/security/keys/Kconfig b/security/keys/Kconfig > index 83bc23409164..c161642a8484 100644 > --- a/security/keys/Kconfig > +++ b/security/keys/Kconfig > @@ -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. > -- > 2.29.2 > > /Jarkko
diff --git a/Documentation/security/keys/core.rst b/Documentation/security/keys/core.rst index aa0081685ee1..b3ed5c581034 100644 --- a/Documentation/security/keys/core.rst +++ b/Documentation/security/keys/core.rst @@ -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. diff --git a/samples/Kconfig b/samples/Kconfig index 0ed6e4d71d87..e76cdfc50e25 100644 --- a/samples/Kconfig +++ b/samples/Kconfig @@ -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(), diff --git a/samples/watch_queue/watch_test.c b/samples/watch_queue/watch_test.c index 46e618a897fe..8c6cb57d5cfc 100644 --- a/samples/watch_queue/watch_test.c +++ b/samples/watch_queue/watch_test.c @@ -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) diff --git a/security/keys/Kconfig b/security/keys/Kconfig index 83bc23409164..c161642a8484 100644 --- a/security/keys/Kconfig +++ b/security/keys/Kconfig @@ -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.
Hi, I sent this a while ago and I haven't seen it pop-up in any trees yet. I'm sorry if I missed it somewhere. Otherwise, gently ping. -- >8 -- The merged API doesn't use a watch_queue device, but instead relies on pipes, so let the documentation reflect that. Cc: David Howells <dhowells@redhat.com> Signed-off-by: Gabriel Krisman Bertazi <krisman@collabora.com> --- Documentation/security/keys/core.rst | 4 ++-- samples/Kconfig | 2 +- samples/watch_queue/watch_test.c | 2 +- security/keys/Kconfig | 8 ++++---- 4 files changed, 8 insertions(+), 8 deletions(-)