Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.kernel > #1689476

[PATCH 7/7] docs: Use :internal: for include/drm/drm_syncobj.h

From Jonathan Corbet <corbet@lwn.net>
Newsgroups linux.kernel
Subject [PATCH 7/7] docs: Use :internal: for include/drm/drm_syncobj.h
Date 2017-07-17 23:10 +0200
Message-ID <u4lre-1Mq-57@gated-at.bofh.it> (permalink)
References <u4lrc-1Mq-9@gated-at.bofh.it>
Organization linux.* mail to news gateway

Show all headers | View raw


Documentation/gpu/drm-mm.rst includes from include/drm/drm_syncobj.h with
:export:, but this is a header file without export directives.  That
results in this warning:

    ./include/drm/drm_syncobj.h:1: warning: no structured comments found

...and a failure to obtain the documentation from that file.  Switch to
:internal: instead to make both problems go away.

Cc: dri-devel@lists.freedesktop.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 Documentation/gpu/drm-mm.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst
index 9412798645c1..300898298bf6 100644
--- a/Documentation/gpu/drm-mm.rst
+++ b/Documentation/gpu/drm-mm.rst
@@ -492,7 +492,7 @@ DRM Sync Objects
    :doc: Overview
 
 .. kernel-doc:: include/drm/drm_syncobj.h
-   :export:
+   :internal:
 
 .. kernel-doc:: drivers/gpu/drm/drm_syncobj.c
    :export:
-- 
2.9.4

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


Thread

[PATCH 7/7] docs: Use :internal: for include/drm/drm_syncobj.h Jonathan Corbet <corbet@lwn.net> - 2017-07-17 23:10 +0200

csiph-web