]> www.infradead.org Git - users/sagi/libnvme.git/commit
projects / users / sagi / libnvme.git / commit
summary | shortlog | log | commit | commitdiff | tree
(parent: e33cc17) | patch
doc: Add a kdoc test for API docs
authorJeremy Kerr <jk@codeconstruct.com.au>
Wed, 6 Jul 2022 06:31:41 +0000 (14:31 +0800)
committerJeremy Kerr <jk@codeconstruct.com.au>
Mon, 11 Jul 2022 10:11:32 +0000 (18:11 +0800)
commit8a446cbd20a86f75867e1686851ea64789729ad8
tree053a48412cc21811e2c0e46aaf7b3a34a3ed2d3ftree
parente33cc1782a01cb96ecbbfdf913047b52ab429984commit | diff
doc: Add a kdoc test for API docs

Even when we're not building docs, it would be handy to have an easy
check that the kernel-doc comments do not produce warnings or errors.

This change adds a test() defintion to docs/, which calls a simple
script, kernel-doc-check. This script invokes kernel-doc, looking for
error and/or warning output.

Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au>
doc/kernel-doc-check [new file with mode: 0644] blob
doc/meson.build diff | blob | history
Unnamed repository; edit this file 'description' to name the repository.