]> www.infradead.org Git - users/dwmw2/linux.git/commit
projects / users / dwmw2 / linux.git / commit
summary | shortlog | log | commit | commitdiff | tree
(parent: 1613e60) | patch
doc-guide: kernel-doc: document Returns: spelling
authorRandy Dunlap <rdunlap@infradead.org>
Wed, 22 May 2024 22:47:26 +0000 (15:47 -0700)
committerJonathan Corbet <corbet@lwn.net>
Thu, 30 May 2024 19:35:07 +0000 (13:35 -0600)
commit23a0bc28515934ed081169257f5b76167f07df4a
tree1beed9679516282aa68b4976984c4351dba8fcddtree
parent1613e604df0cd359cf2a7fbd9be7a0bcfacfabd0commit | diff
doc-guide: kernel-doc: document Returns: spelling

scripts/kernel-doc accepts "Return:" or "Returns:" for describing the
return value of a function or function-like macro, so document this
alternative spelling and use it in an example.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Suggested-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240522224726.10498-1-rdunlap@infradead.org
Documentation/doc-guide/kernel-doc.rst diff | blob | history
Unnamed repository; edit this file 'description' to name the repository.