Skip to content

cloud-kernel
cloud-kernel

openanolis / cloud-kernel
1 年多 前同步成功

通知 161
Star 36
Fork 7
cloud-kernel
cloud-kernel
切换分支/标签
  1. 20 7月, 2016 1 次提交
    • D
      doc/sphinx: Enable keep_warnings · 47d6d752
      由 Daniel Vetter 提交于 
      Unfortunately warnings generated after parsing in sphinx can end up
with entirely bogus files and line numbers as sources. Strangely for
outright errors this is not a problem. Trying to convert warnings to
errors also doesn't fix it.

The only way to get useful output out of sphinx to be able to root
cause the error seems to be enabling keep_warnings, which inserts
a System Message into the actual output. Not pretty at all, but I
don't really want to fix up core rst/sphinx code, and this gets the job
done meanwhile.

Cc: Markus Heiser <markus.heiser@darmarit.de>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Signed-off-by: NDaniel Vetter <daniel.vetter@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>
      47d6d752
  3. 18 7月, 2016 2 次提交
  5. 10 7月, 2016 1 次提交
  7. 06 7月, 2016 1 次提交
  9. 02 7月, 2016 3 次提交
  11. 01 7月, 2016 3 次提交
  13. 24 6月, 2016 1 次提交
  15. 23 6月, 2016 6 次提交
  17. 10 6月, 2016 4 次提交
    • J
      Documentation/sphinx: add support for specifying extra export files · 03d35d9e
      由 Jani Nikula 提交于 
      Let the user specify file patterns where to look for the EXPORT_SYMBOLs
in addition to the file with kernel-doc comments. This is directly based
on the -export-file FILE option added to kernel-doc in "kernel-doc: add
support for specifying extra files for EXPORT_SYMBOLs", but we extend
that with globbing patterns in the Sphinx extension.

The file patterns are added as options to the :export: and :internal:
arguments of the kernel-doc directive. For example, to extract the
documentation of exported functions from include/net/mac80211.h:

.. kernel-doc:: include/net/mac80211.h
   :export: net/mac80211/*.c

Without the file pattern, no exported functions would be found, as the
EXPORT_SYMBOLs are placed in the various source files under
net/mac80211.

The matched files are also added as dependencies on the document in
Sphinx, as they may affect the output. This is one of the reasons to do
the globbing in the Sphinx extension instead of in scripts/kernel-doc.

The file pattern remains optional, and is not needed if the kernel-doc
comments and EXPORT_SYMBOLs are placed in the source file passed in as
the main argument to the kernel-doc directive. This is the most common
case across the kernel source tree.
Signed-off-by: NJani Nikula <jani.nikula@intel.com>
      03d35d9e
    • J
      Documentation/sphinx: use a more sensible string split in kernel-doc extension · 057de5c4
      由 Jani Nikula 提交于 
      Using the default str.split doesn't return empty strings like the
current version does.
Signed-off-by: NJani Nikula <jani.nikula@intel.com>
      057de5c4
    • J
      Documentation/sphinx: remove unnecessary temporary variable · 06173fe3
      由 Jani Nikula 提交于 
      Leftover cruft. No functional changes.
Signed-off-by: NJani Nikula <jani.nikula@intel.com>
      06173fe3
    • K
      docs: self-protection: rename "leak" to "exposure" · c9de4a82
      由 Kees Cook 提交于 
      The meaning of "leak" can be both "untracked resource allocation" and
"memory content disclosure". This document's use was entirely of the
latter meaning, so avoid the confusion by using the Common Weakness
Enumeration name for this: Information Exposure (CWE-200). Additionally
adds a section on structure randomization.
Signed-off-by: NKees Cook <keescook@chromium.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>
      c9de4a82
  19. 04 6月, 2016 6 次提交
  21. 03 6月, 2016 1 次提交
  23. 01 6月, 2016 2 次提交
  25. 30 5月, 2016 8 次提交
    • J
      Documentation/sphinx: nicer referencing of struct in docbook->rst conversion · 30ca7aaf
      由 Jani Nikula 提交于 
      Add "struct" in the label of the reference.
Signed-off-by: NJani Nikula <jani.nikula@intel.com>
      30ca7aaf
    • J
      sphinx: update docbook->rst conversion script match C domain spec · 2e83ecb8
      由 Jani Nikula 提交于 
      Function references should include the parens (), struct references
should not include "struct".
Signed-off-by: NJani Nikula <jani.nikula@intel.com>
      2e83ecb8
    • J
      sphinx: cheesy script to convert .tmpl files · 89a66d76
      由 Jonathan Corbet 提交于 
      This script uses pandoc to convert existing DocBook template files to RST
templates.  A couple of sed scripts are need to massage things both before
and after the conversion, but the result is then usable with no hand
editing.

[Jani: Change usage to tmplcvt <in> <out>. Fix escaping for docproc
directives. Add support the new kernel-doc extension.]
Signed-off-by: NJonathan Corbet <corbet@lwn.net>
Signed-off-by: NJani Nikula <jani.nikula@intel.com>
      89a66d76
    • J
      Documentation/sphinx: set version and release properly · c13ce448
      由 Jani Nikula 提交于 
      Read the version and release from the top level Makefile (for use when
Sphinx is invoked directly, by e.g. Read the Docs), but override them
via Sphinx command line arguments in a normal documentation build.
Signed-off-by: NJani Nikula <jani.nikula@intel.com>
      c13ce448
    • J
      Documentation/sphinx: configure the kernel-doc extension · 24dcdeb2
      由 Jani Nikula 提交于 
      Tell Sphinx where to find the extension, and pass on the kernel src tree
and kernel-doc paths to the extension.

With this, any .rst files under Documentation may contain the kernel-doc
rst directive to include kernel-doc documentation from any source file.

While building, it may be handy to pass kernel-doc extension
configuration on the command line. For example, 'make SPHINXOPTS="-D
kerneldoc_verbosity=0" htmldocs' silences all stderr output from
kernel-doc when the kernel-doc exit code is 0. (The stderr will be
logged unconditionally when the exit code is non-zero.)
Signed-off-by: NJani Nikula <jani.nikula@intel.com>
      24dcdeb2
    • J
      Documentation/sphinx: add Sphinx kernel-doc directive extension · c56de1db
      由 Jani Nikula 提交于 
      Add an extension to handle kernel-doc directives, to call kernel-doc
according to the arguments and parameters given to the reStructuredText
directive.

The syntax for the kernel-doc directive is:

.. kernel-doc:: FILENAME
   :export:
   :internal:
   :functions: FUNCTION [FUNCTION ...]
   :doc: SECTION TITLE

Of the directive options export, internal, functions, and doc, currently
only one option may be given at a time.

The FILENAME is relative from the kernel source tree root.

The extension notifies Sphinx about the document dependency on FILENAME,
causing the document to be rebuilt when the file has been changed.
Signed-off-by: NJani Nikula <jani.nikula@intel.com>
      c56de1db
    • J
      Documentation: add .gitignore · 81cd3181
      由 Jani Nikula 提交于 
      The Sphinx output directory is generated.
Signed-off-by: NJani Nikula <jani.nikula@intel.com>
      81cd3181
    • J
      Documentation/sphinx: add basic working Sphinx configuration and build · 22cba31b
      由 Jani Nikula 提交于 
      Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.

At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.

All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.

There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.

If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.

Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.

Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.

This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: NJani Nikula <jani.nikula@intel.com>
      22cba31b
  27. 28 5月, 2016 1 次提交
    • A
      MIPS: devicetree: fix cpu interrupt controller node-names · 5214cae7
      由 Antony Pavlov 提交于 
      Here is the quote from [1]:

    The unit-address must match the first address specified
    in the reg property of the node. If the node has no reg property,
    the @ and unit-address must be omitted and the node-name alone
    differentiates the node from other nodes at the same level

This patch adjusts MIPS dts-files and devicetree binding
documentation in accordance with [1].

    [1] Power.org(tm) Standard for Embedded Power Architecture(tm)
        Platform Requirements (ePAPR). Version 1.1 – 08 April 2011.
        Chapter 2.2.1.1 Node Name Requirements
Signed-off-by: NAntony Pavlov <antonynpavlov@gmail.com>
Cc: Paul Burton <paul.burton@imgtec.com>
Cc: Zubair Lutfullah Kakakhel <Zubair.Kakakhel@imgtec.com>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Pawel Moll <pawel.moll@arm.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Ian Campbell <ijc+devicetree@hellion.org.uk>
Cc: Kumar Gala <galak@codeaurora.org>
Cc: linux-mips@linux-mips.org
Cc: devicetree@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Patchwork: https://patchwork.linux-mips.org/patch/13345/Acked-by: NRob Herring <robh@kernel.org>
Signed-off-by: NRalf Baechle <ralf@linux-mips.org>
      5214cae7