Merge tag 'docs-4.15' of git://git.lwn.net/linux

Pull documentation updates from Jonathan Corbet:
 "A relatively calm cycle for the docs tree again.

  - The old driver statement has been added to the kernel docs.

  - We have a couple of new helper scripts. find-unused-docs.sh from
    Sayli Karnic will point out kerneldoc comments that are not actually
    used in the documentation. Jani Nikula's
    documentation-file-ref-check finds references to non-existing files.

  - A new ftrace document from Steve Rostedt.

  - Vinod Koul converted the dmaengine docs to RST

  Beyond that, it's mostly simple fixes.

  This set reaches outside of Documentation/ a bit more than most. In
  all cases, the changes are to comment docs, mostly from Randy, in
  places where there didn't seem to be anybody better to take them"

* tag 'docs-4.15' of git://git.lwn.net/linux: (52 commits)
  documentation: fb: update list of available compiled-in fonts
  MAINTAINERS: update DMAengine documentation location
  dmaengine: doc: ReSTize pxa_dma doc
  dmaengine: doc: ReSTize dmatest doc
  dmaengine: doc: ReSTize client API doc
  dmaengine: doc: ReSTize provider doc
  dmaengine: doc: Add ReST style dmaengine document
  ftrace/docs: Add documentation on how to use ftrace from within the kernel
  bug-hunting.rst: Fix an example and a typo in a Sphinx tag
  scripts: Add a script to find unused documentation
  samples: Convert timers to use timer_setup()
  documentation: kernel-api: add more info on bitmap functions
  Documentation: fix selftests related file refs
  Documentation: fix ref to power basic-pm-debugging
  Documentation: fix ref to trace stm content
  Documentation: fix ref to coccinelle content
  Documentation: fix ref to workqueue content
  Documentation: fix ref to sphinx/kerneldoc.py
  Documentation: fix locking rt-mutex doc refs
  docs: dev-tools: correct Coccinelle version number
  ...

3 files changed, 90 insertions, 4 deletions

diff --git a/scripts/documentation-file-ref-check b/scripts/documentation-file-ref-check
new file mode 100755
index 000000000000..bc1659900e89
--- /dev/null
+++ b/scripts/documentation-file-ref-check
@@ -0,0 +1,15 @@
+#!/bin/sh
+# Treewide grep for references to files under Documentation, and report
+# non-existing files in stderr.
+
+for f in $(git ls-files); do
+        for ref in $(grep -ho "Documentation/[A-Za-z0-9_.,~/*+-]*" "$f"); do
+                # presume trailing . and , are not part of the name
+                ref=${ref%%[.,]}
+
+                # use ls to handle wildcards
+                if ! ls $ref >/dev/null 2>&1; then
+                        echo "$f: $ref" >&2
+                fi
+        done
+done
diff --git a/scripts/find-unused-docs.sh b/scripts/find-unused-docs.sh
new file mode 100755
index 000000000000..3f46f8977dc4
--- /dev/null
+++ b/scripts/find-unused-docs.sh
@@ -0,0 +1,62 @@
+#!/bin/bash
+# (c) 2017, Jonathan Corbet <corbet@lwn.net>
+#           sayli karnik <karniksayli1995@gmail.com>
+#
+# This script detects files with kernel-doc comments for exported functions
+# that are not included in documentation.
+#
+# usage: Run 'scripts/find-unused-docs.sh directory' from top level of kernel
+#        tree.
+#
+# example: $scripts/find-unused-docs.sh drivers/scsi
+#
+# Licensed under the terms of the GNU GPL License
+
+if ! [ -d "Documentation" ]; then
+        echo "Run from top level of kernel tree"
+        exit 1
+fi
+
+if [ "$#" -ne 1 ]; then
+        echo "Usage: scripts/find-unused-docs.sh directory"
+        exit 1
+fi
+
+if ! [ -d "$1" ]; then
+        echo "Directory $1 doesn't exist"
+        exit 1
+fi
+
+cd "$( dirname "${BASH_SOURCE[0]}" )"
+cd ..
+
+cd Documentation/
+
+echo "The following files contain kerneldoc comments for exported functions \
+that are not used in the formatted documentation"
+
+# FILES INCLUDED
+
+files_included=($(grep -rHR ".. kernel-doc" --include \*.rst | cut -d " " -f 3))
+
+declare -A FILES_INCLUDED
+
+for each in "${files_included[@]}"; do
+        FILES_INCLUDED[$each]="$each"
+        done
+
+cd ..
+
+# FILES NOT INCLUDED
+
+for file in `find $1 -name '*.c'`; do
+
+        if [[ ${FILES_INCLUDED[$file]+_} ]]; then
+        continue;
+        fi
+        str=$(scripts/kernel-doc -text -export "$file" 2>/dev/null)
+        if [[ -n "$str" ]]; then
+        echo "$file"
+        fi
+        done
+
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 9d3eafea58f0..67d051edd615 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -2168,7 +2168,7 @@ sub dump_struct($$) {
     my $nested;
 
     if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) {
-        #my $decl_type = $1;
+        my $decl_type = $1;
         $declaration_name = $2;
         my $members = $3;
 
@@ -2194,7 +2194,7 @@ sub dump_struct($$) {
         $members =~ s/DECLARE_HASHTABLE\s*\(([^,)]+), ([^,)]+)\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
 
         create_parameterlist($members, ';', $file);
-        check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);
+        check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual, $nested);
 
         output_declaration($declaration_name,
                            'struct',
@@ -2226,6 +2226,8 @@ sub dump_enum($$) {
     if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
         $declaration_name = $1;
         my $members = $2;
+        my %_members;
+
         $members =~ s/\s+$//;
 
         foreach my $arg (split ',', $members) {
@@ -2236,9 +2238,16 @@ sub dump_enum($$) {
                 print STDERR "${file}:$.: warning: Enum value '$arg' ".
                     "not described in enum '$declaration_name'\n";
             }
-
+            $_members{$arg} = 1;
         }
 
+        while (my ($k, $v) = each %parameterdescs) {
+            if (!exists($_members{$k})) {
+             print STDERR "${file}:$.: warning: Excess enum value " .
+                          "'$k' description in '$declaration_name'\n";
+            }
+        }
+
         output_declaration($declaration_name,
                            'enum',
                            {'enum' => $declaration_name,
@@ -2506,7 +2515,7 @@ sub check_sections($$$$$$) {
                         } else {
                                 if ($nested !~ m/\Q$sects[$sx]\E/) {
                                     print STDERR "${file}:$.: warning: " .
-                                        "Excess struct/union/enum/typedef member " .
+                                        "Excess $decl_type member " .
                                         "'$sects[$sx]' " .
                                         "description in '$decl_name'\n";
                                     ++$warnings;