Messages in this thread |  | | Date | Sat, 6 Jan 2018 11:09:08 -0700 | From | Jonathan Corbet <> | Subject | Re: [PATCH] Documentation: security/credentials.rst: explain need to sort group_list |
| |
On Tue, 2 Jan 2018 13:04:31 -0800 Matthew Wilcox <willy@infradead.org> wrote:
> > +When replacing the group list, the new list must be sorted before it > > +is added to the credential, as a binary search is used to test for > > +membership. In practice, this means ``groups_sort()`` should be > > For a .rst file, shouldn't we be using :c:func:`groups_sort` instead of > ``groups_sort()``?
There is value in using the c:func syntax, as it will generate cross-references to the kerneldoc comments for those functions. In this case, it would appear that these comments exist, but nobody has pulled them into the docs yet. I took the liberty of adding :c:func: references to this patch on its way into docs-next so that things will Just Work on that happy day when somebody adds the function documentation.
Thanks,
jon
|  |