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

Groups > linux.kernel > #1689483 > unrolled thread

[PATCH 0/7] Documentation warning reduction

Back to article view | Back to linux.kernel

Contents

  [PATCH 0/7] Documentation warning reduction Jonathan Corbet <corbet@lwn.net> - 2017-07-17 23:10 +0200
    [PATCH 5/7] docs: Do not include from drivers/scsi/constants.c Jonathan Corbet <corbet@lwn.net> - 2017-07-17 23:10 +0200

#1689483 — [PATCH 0/7] Documentation warning reduction

I've come to the conclusion that we really need to make the docs build
quieter.  Here's a small step in that direction: getting rid of all of the
"no structured comments found" warnings.  Such warnings are usually the
result of kerneldoc comments being moved elsewhere, so this took a bit of
git archeology to do; hopefully I got it right.

Each patch stands alone, so if the DRM folks want to carry the last two
themselves, that's fine, just let me know.

Jonathan Corbet (7):
  docs: Get module_init() docs from module.h
  docs: Do not include kerneldoc comments from kernel/sys.c
  docs: Do not include from .../seqno-fence.c
  docs: Get the struct cmbdata kernel doc from the right file
  docs: Do not include from drivers/scsi/constants.c
  docs: Do not include from include/drm/drm_color_mgmt.h
  docs: Use :internal: for include/drm/drm_syncobj.h

 Documentation/driver-api/basics.rst       | 5 +----
 Documentation/driver-api/dma-buf.rst      | 3 ---
 Documentation/driver-api/s390-drivers.rst | 2 +-
 Documentation/driver-api/scsi.rst         | 8 --------
 Documentation/gpu/drm-kms.rst             | 3 ---
 Documentation/gpu/drm-mm.rst              | 2 +-
 6 files changed, 3 insertions(+), 20 deletions(-)

-- 
2.9.4

[toc] | [next] | [standalone]

#1689485 — [PATCH 5/7] docs: Do not include from drivers/scsi/constants.c

The only function of interest in that file was scsi_print_status().  That
function was removed in commit 7ac7076344d9 (scsi: remove
scsi_print_status()) but the docs were not changed to match, yielding this
warning:

    ./drivers/scsi/constants.c:1: warning: no structured comments found

There's nothing there anymore, so just remove that section from the docs.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 Documentation/driver-api/scsi.rst | 8 --------
 1 file changed, 8 deletions(-)

diff --git a/Documentation/driver-api/scsi.rst b/Documentation/driver-api/scsi.rst
index 859fb672319f..5a2aa7a377d9 100644
--- a/Documentation/driver-api/scsi.rst
+++ b/Documentation/driver-api/scsi.rst
@@ -224,14 +224,6 @@ mid to lowlevel SCSI driver interface
 .. kernel-doc:: drivers/scsi/hosts.c
    :export:
 
-drivers/scsi/constants.c
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-mid to lowlevel SCSI driver interface
-
-.. kernel-doc:: drivers/scsi/constants.c
-   :export:
-
 Transport classes
 -----------------
 
-- 
2.9.4

[toc] | [prev] | [standalone]

Back to top | Article view | linux.kernel

csiph-web