]> git.baikalelectronics.ru Git - kernel.git/commit
docs: s390: unify and update s390dbf kdocs at debug.c
authorSteffen Maier <maier@linux.ibm.com>
Wed, 3 Jul 2019 10:19:48 +0000 (12:19 +0200)
committerVasily Gorbik <gor@linux.ibm.com>
Fri, 5 Jul 2019 11:42:22 +0000 (13:42 +0200)
commit9905b0f55fbeace2e5661000098469d955199724
treee87a0a680524cee2aab229c7fe7b52b09a698d52
parented17af56b218a68050b66993554168cc93422b29
docs: s390: unify and update s390dbf kdocs at debug.c

For non-static-inlines, debug.c already had non-compliant function
header docs. So move the pure prototype kdocs of
("s390: include/asm/debug.h add kerneldoc markups")
from debug.h to debug.c and merge them with the old function docs.
Also, I had the impression that kdoc typically is at the implementation
in the compile unit rather than at the prototype in the header file.

While at it, update the short kdoc description to distinguish the
different functions. And a few more consistency cleanups.

Added a new kdoc for debug_set_critical() since debug.h comments it
as part of the API.

Signed-off-by: Steffen Maier <maier@linux.ibm.com>
Acked-by: Christian Borntraeger <borntraeger@de.ibm.com>
Message-Id: <1562149189-1417-3-git-send-email-maier@linux.ibm.com>
Signed-off-by: Vasily Gorbik <gor@linux.ibm.com>
Documentation/s390/s390dbf.rst
arch/s390/include/asm/debug.h
arch/s390/kernel/debug.c