[PATCH 4/7] docs: Get the struct cmbdata kernel doc from the right file

From	Jonathan Corbet <corbet@lwn.net>
Newsgroups	linux.kernel
Subject	[PATCH 4/7] docs: Get the struct cmbdata kernel doc from the right file
Date	2017-07-17 23:10 +0200
Message-ID	<u4lrc-1Mq-15@gated-at.bofh.it> (permalink)
References	<u4lrc-1Mq-9@gated-at.bofh.it>
Organization	linux.* mail to news gateway

Show all headers | View raw

Back in 2012, commit 9807f75955ea (UAPI: (Scripted) Disintegrate
arch/s390/include/asm) moved struct cmbdata (and its kerneldoc comments) to
another file, but did not update the docs to match.  The result is this
warning:

    ./arch/s390/include/asm/cmb.h:1: warning: no structured comments found

...and no documentation for that structure.  Update the docs to get the
information from the right place.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 Documentation/driver-api/s390-drivers.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/driver-api/s390-drivers.rst b/Documentation/driver-api/s390-drivers.rst
index 7060da136095..ecf8851d3565 100644
--- a/Documentation/driver-api/s390-drivers.rst
+++ b/Documentation/driver-api/s390-drivers.rst
@@ -75,7 +75,7 @@ The channel-measurement facility provides a means to collect measurement
 data which is made available by the channel subsystem for each channel
 attached device.
 
-.. kernel-doc:: arch/s390/include/asm/cmb.h
+.. kernel-doc:: arch/s390/include/uapi/asm/cmb.h
    :internal:
 
 .. kernel-doc:: drivers/s390/cio/cmf.c
-- 
2.9.4

Back to linux.kernel | Previous | Next | Find similar | Unroll thread

Thread

[PATCH 4/7] docs: Get the struct cmbdata kernel doc from the right file Jonathan Corbet <corbet@lwn.net> - 2017-07-17 23:10 +0200

csiph-web