kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers'
authorChangbin Du <changbin.du@gmail.com>
Thu, 31 Oct 2019 13:52:45 +0000 (21:52 +0800)
committerJonathan Corbet <corbet@lwn.net>
Thu, 7 Nov 2019 20:17:25 +0000 (13:17 -0700)
commit36bc683dde0af61c6e677e5832ad4380771380d3
treed6295d5ff7a5514c2fa281f497e84b942a7aec16
parente80d89380c5a8553f208d002ee0f7877ed08eb6c
kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers'

The 'functions' directive is not only for functions, but also works for
structs/unions. So the name is misleading. This patch renames it to
'identifiers', which specific the functions/types to be included in
documentation. We keep the old name as an alias of the new one before
all documentation are updated.

Signed-off-by: Changbin Du <changbin.du@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/doc-guide/kernel-doc.rst
Documentation/sphinx/kerneldoc.py