diff options
| author |   Steffen Maier <maier@linux.ibm.com> | 2019-07-03 12:19:48 +0200 |
|---|---|---|
| committer |   Vasily Gorbik <gor@linux.ibm.com> | 2019-07-05 13:42:22 +0200 |
| commit | 0328e519a726ff6e4abacba838eb00415171c34b (patch) | |
| tree | e87a0a680524cee2aab229c7fe7b52b09a698d52 /Documentation/s390 | |
| parent | docs: s390: restore important non-kdoc parts of s390dbf.rst (diff) | |
| download | wireguard-linux-0328e519a726ff6e4abacba838eb00415171c34b.tar.xz wireguard-linux-0328e519a726ff6e4abacba838eb00415171c34b.zip | |
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>
Diffstat (limited to 'Documentation/s390')
| -rw-r--r-- | Documentation/s390/s390dbf.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/Documentation/s390/s390dbf.rst b/Documentation/s390/s390dbf.rst index 01d66251643d..be42892b159e 100644 --- a/Documentation/s390/s390dbf.rst +++ b/Documentation/s390/s390dbf.rst @@ -107,6 +107,7 @@ will stay deactivated. Kernel Interfaces: ------------------ +.. kernel-doc:: arch/s390/kernel/debug.c .. kernel-doc:: arch/s390/include/asm/debug.h Predefined views: |