diff options
author | Jakub Kicinski <kuba@kernel.org> | 2020-11-17 14:15:05 -0800 |
---|---|---|
committer | Jakub Kicinski <kuba@kernel.org> | 2020-11-17 14:15:05 -0800 |
commit | 6997faa997ba95365cfe6f3a4b594f0eb6d25700 (patch) | |
tree | d6e0b655cb5c072e41f7b6404c6ee8f1371793c5 /tools/perf/scripts/python/export-to-postgresql.py | |
parent | 5cfa9a612836f06f14f8e4388a01576db558b771 (diff) | |
parent | 270f3385cddf5db3799b393459476bd9abff89f1 (diff) |
Merge branch 'fix-several-bad-kernel-doc-markups'
Mauro Carvalho Chehab says:
====================
Fix several bad kernel-doc markups
Kernel-doc has always be limited to a probably bad documented
rule:
The kernel-doc markups should appear *imediatelly before* the
function or data structure that it documents.
On other words, if a C file would contain something like this:
/**
* foo - function foo
* @args: foo args
*/
static inline void bar(int args);
/**
* bar - function bar
* @args: foo args
*/
static inline void foo(void *args);
The output (in ReST format) will be:
.. c:function:: void bar (int args)
function foo
**Parameters**
``int args``
foo args
.. c:function:: void foo (void *args)
function bar
**Parameters**
``void *args``
foo args
Which is clearly a wrong result. Before this changeset,
not even a warning is produced on such cases.
As placing such markups just before the documented
data is a common practice, on most cases this is fine.
However, as patches touch things, identifiers may be
renamed, and people may forget to update the kernel-doc
markups to follow such changes.
This has been happening for quite a while, as there are
lots of files with kernel-doc problems.
This series address those issues and add a file at the
end that will enforce that the identifier will match the
kernel-doc markup, avoiding this problem from
keep happening as time goes by.
====================
Link: https://lore.kernel.org/r/cover.1605521731.git.mchehab+huawei@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Diffstat (limited to 'tools/perf/scripts/python/export-to-postgresql.py')
0 files changed, 0 insertions, 0 deletions