Merge branch 'doc/4.9' into docs-next

7 files changed, 69 insertions, 21 deletions

diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
index 894cfaa41f55..92deea30b183 100644
--- a/Documentation/Makefile.sphinx
+++ b/Documentation/Makefile.sphinx
@@ -71,12 +71,12 @@ ifeq ($(HAVE_PDFLATEX),0)
         $(warning The 'xelatex' command was not found. Make sure you have it installed and in PATH to produce PDF output.)
         @echo "  SKIP    Sphinx $@ target."
 else # HAVE_PDFLATEX
-        @$(call loop_cmd,sphinx,latex,.,latex,.)
+        @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var)))
 endif # HAVE_PDFLATEX
 
 pdfdocs: latexdocs
 ifneq ($(HAVE_PDFLATEX),0)
-        $(Q)$(MAKE) PDFLATEX=xelatex LATEXOPTS="-interaction=nonstopmode" -C $(BUILDDIR)/latex
+        $(foreach var,$(SPHINXDIRS), $(MAKE) PDFLATEX=xelatex LATEXOPTS="-interaction=nonstopmode" -C $(BUILDDIR)/$(var)/latex)
 endif # HAVE_PDFLATEX
 
 epubdocs:
diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
index 20557efa8bce..1fa28092ec00 100644
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -2161,10 +2161,13 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
                         than or equal to this physical address is ignored.
 
         maxcpus=        [SMP] Maximum number of processors that an SMP kernel
-                        should make use of.  maxcpus=n : n >= 0 limits the
-                        kernel to using 'n' processors.  n=0 is a special case,
-                        it is equivalent to "nosmp", which also disables
-                        the IO APIC.
+                        will bring up during bootup.  maxcpus=n : n >= 0 limits
+                        the kernel to bring up 'n' processors. Surely after
+                        bootup you can bring up the other plugged cpu by executing
+                        "echo 1 > /sys/devices/system/cpu/cpuX/online". So maxcpus
+                        only takes effect during system bootup.
+                        While n=0 is a special case, it is equivalent to "nosmp",
+                        which also disables the IO APIC.
 
         max_loop=       [LOOP] The number of loop block devices that get
         (loop.max_loop) unconditionally pre-created at init time. The default
@@ -2773,9 +2776,12 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
 
         nr_cpus=        [SMP] Maximum number of processors that an SMP kernel
                         could support.  nr_cpus=n : n >= 1 limits the kernel to
-                        supporting 'n' processors. Later in runtime you can not
-                        use hotplug cpu feature to put more cpu back to online.
-                        just like you compile the kernel NR_CPUS=n
+                        support 'n' processors. It could be larger than the
+                        number of already plugged CPU during bootup, later in
+                        runtime you can physically add extra cpu until it reaches
+                        n. So during boot up some boot time memory for per-cpu
+                        variables need be pre-allocated for later physical cpu
+                        hot plugging.
 
         nr_uarts=       [SERIAL] maximum number of UARTs to be registered.
 
diff --git a/Documentation/media/conf.py b/Documentation/media/conf.py
index 77cb2bbd9461..bef927bc4659 100644
--- a/Documentation/media/conf.py
+++ b/Documentation/media/conf.py
@@ -3,3 +3,8 @@
 project = 'Linux Media Subsystem Documentation'
 
 tags.add("subproject")
+
+latex_documents = [
+    ('index', 'media.tex', 'Linux Media Subsystem Documentation',
+     'The kernel development community', 'manual'),
+]
diff --git a/Documentation/sphinx/kernel-doc.py b/Documentation/sphinx/kernel-doc.py
index f6920c0af6ee..d15e07f36881 100644
--- a/Documentation/sphinx/kernel-doc.py
+++ b/Documentation/sphinx/kernel-doc.py
@@ -39,6 +39,8 @@ from docutils.parsers.rst import directives
 from sphinx.util.compat import Directive
 from sphinx.ext.autodoc import AutodocReporter
 
+__version__  = '1.0'
+
 class KernelDocDirective(Directive):
     """Extract kernel-doc comments from the specified file"""
     required_argument = 1
@@ -139,3 +141,9 @@ def setup(app):
     app.add_config_value('kerneldoc_verbosity', 1, 'env')
 
     app.add_directive('kernel-doc', KernelDocDirective)
+
+    return dict(
+        version = __version__,
+        parallel_read_safe = True,
+        parallel_write_safe = True
+    )
diff --git a/Documentation/sphinx/kernel_include.py b/Documentation/sphinx/kernel_include.py
index db5738238733..f523aa68a36b 100755
--- a/Documentation/sphinx/kernel_include.py
+++ b/Documentation/sphinx/kernel_include.py
@@ -39,11 +39,18 @@ from docutils.parsers.rst import directives
 from docutils.parsers.rst.directives.body import CodeBlock, NumberLines
 from docutils.parsers.rst.directives.misc import Include
 
+__version__  = '1.0'
+
 # ==============================================================================
 def setup(app):
 # ==============================================================================
 
     app.add_directive("kernel-include", KernelInclude)
+    return dict(
+        version = __version__,
+        parallel_read_safe = True,
+        parallel_write_safe = True
+    )
 
 # ==============================================================================
 class KernelInclude(Include):
diff --git a/Documentation/sphinx/rstFlatTable.py b/Documentation/sphinx/rstFlatTable.py
index 26db852e3c74..55f275793028 100644..100755
--- a/Documentation/sphinx/rstFlatTable.py
+++ b/Documentation/sphinx/rstFlatTable.py
@@ -73,6 +73,12 @@ def setup(app):
     roles.register_local_role('cspan', c_span)
     roles.register_local_role('rspan', r_span)
 
+    return dict(
+        version = __version__,
+        parallel_read_safe = True,
+        parallel_write_safe = True
+    )
+
 # ==============================================================================
 def c_span(name, rawtext, text, lineno, inliner, options=None, content=None):
 # ==============================================================================
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index ba081c7636a2..301bf874cac8 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1831,13 +1831,22 @@ sub output_function_rst(%) {
     my %args = %{$_[0]};
     my ($parameter, $section);
     my $oldprefix = $lineprefix;
-    my $start;
-
-    print ".. c:function:: ";
+    my $start = "";
+
+    if ($args{'typedef'}) {
+        print ".. c:type:: ". $args{'function'} . "\n\n";
+        print_lineno($declaration_start_line);
+        print "   **Typedef**: ";
+        $lineprefix = "";
+        output_highlight_rst($args{'purpose'});
+        $start = "\n\n**Syntax**\n\n  ``";
+    } else {
+        print ".. c:function:: ";
+    }
     if ($args{'functiontype'} ne "") {
-        $start = $args{'functiontype'} . " " . $args{'function'} . " (";
+        $start .= $args{'functiontype'} . " " . $args{'function'} . " (";
     } else {
-        $start = $args{'function'} . " (";
+        $start .= $args{'function'} . " (";
     }
     print $start;
 
@@ -1856,11 +1865,15 @@ sub output_function_rst(%) {
             print $type . " " . $parameter;
         }
     }
-    print ")\n\n";
-    print_lineno($declaration_start_line);
-    $lineprefix = "   ";
-    output_highlight_rst($args{'purpose'});
-    print "\n";
+    if ($args{'typedef'}) {
+        print ");``\n\n";
+    } else {
+        print ")\n\n";
+        print_lineno($declaration_start_line);
+        $lineprefix = "   ";
+        output_highlight_rst($args{'purpose'});
+        print "\n";
+    }
 
     print "**Parameters**\n\n";
     $lineprefix = "  ";
@@ -2000,7 +2013,7 @@ sub output_struct_rst(%) {
         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
         $type = $args{'parametertypes'}{$parameter};
         print_lineno($parameterdesc_start_lines{$parameter_name});
-        print "``$type $parameter``\n";
+        print "``" . $parameter . "``\n";
         output_highlight_rst($args{'parameterdescs'}{$parameter_name});
         print "\n";
     }
@@ -2190,7 +2203,9 @@ sub dump_typedef($$) {
     $x =~ s@/\*.*?\*/@@gos;     # strip comments.
 
     # Parse function prototypes
-    if ($x =~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/) {
+    if ($x =~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/ ||
+        $x =~ /typedef\s+(\w+)\s*(\w\S+)\s*\s*\((.*)\);/) {
+
         # Function typedefs
         $return_type = $1;
         $declaration_name = $2;
@@ -2201,6 +2216,7 @@ sub dump_typedef($$) {
         output_declaration($declaration_name,
                            'function',
                            {'function' => $declaration_name,
+                            'typedef' => 1,
                             'module' => $modulename,
                             'functiontype' => $return_type,
                             'parameterlist' => \@parameterlist,