Eric Lee / smarc-fsl-linux-kernel

12 Apr, 2017

8 commits

  • 79e0c2e6d   usb/anchors.txt: convert to ReST and add to driver-api book ... Browse Code »

    This document describe some USB core functions. Add it to the
    driver-api book.

    Signed-off-by: Mauro Carvalho Chehab
    Acked-by: Greg Kroah-Hartman
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • 67cc20e00   writing_musb_glue_layer.rst: Enrich its ReST representation ... Browse Code »

    This file is actually quite complex, and required several
    manual handwork:

    - add a title for the document;
    - use the right tags for monospaced fonts;
    - use c references where needed;
    - adjust cross-reference to writing_usb_driver.rst
    - hightlight cross-referenced lines.

    With regards to C code snippet line highlights, the better would be
    to use :linenos: for the C code snippets that are referenced by
    the line number. However, at least with Sphinx 1.4.9, enabling
    it cause the line number to be misaligned with the code,
    making it even more confusing. So, instead, let's use
    :emphasize-lines: tag to mark the lines that are referenced
    at the text.

    Signed-off-by: Mauro Carvalho Chehab
    Acked-by: Greg Kroah-Hartman
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • 0e8c46d03   writing_usb_driver.rst: Enrich its ReST representation ... Browse Code »

    The pandoc conversion is not perfect. Do handwork in order to:

    - add a title to this chapter;
    - adjust function and struct references;
    - use monospaced fonts for C code names;
    - some other minor adjustments to make it better to read in
    text mode and in html.

    Signed-off-by: Mauro Carvalho Chehab
    Acked-by: Greg Kroah-Hartman
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • e1cfb8cab   gadget.rst: Enrich its ReST representation and add kernel-doc tag ... Browse Code »

    The pandoc conversion is not perfect. Do handwork in order to:

    - add a title to this chapter;
    - use the proper warning and note markups;
    - use kernel-doc to include Kernel header and c files;
    - remove legacy notes with regards to DocBook;
    - some other minor adjustments to make it better to read in
    text mode and in html.

    Signed-off-by: Mauro Carvalho Chehab
    Acked-by: Greg Kroah-Hartman
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • 9a3c8b354   usb.rst: Enrich its ReST representation ... Browse Code »

    - use the proper warning and note markups;
    - add references for parts of the document that will be
    cross-referenced on other USB docs;
    - some minor adjustments to make it better to read in
    text mode and in html.

    Signed-off-by: Mauro Carvalho Chehab
    Acked-by: Greg Kroah-Hartman
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • 4ad4b21b1   docs-rst: convert usb docbooks to ReST ... Browse Code »

    As we're moving out of DocBook, let's convert the remaining
    USB docbooks to ReST.

    The transformation itself on this patch is a no-brainer
    conversion using pandoc via this script:
    Documentation/sphinx/tmplcvt

    Signed-off-by: Mauro Carvalho Chehab
    Acked-by: Greg Kroah-Hartman
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • d76a085bc   driver-api/basics.rst: add device table header ... Browse Code »

    The structs there at device table are used by other documentation
    at the Kernel. So, add it to the driver API.

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • 686b0d9bb   tmplcvt: make the tool more robust ... Browse Code »

    Currently, the script just assumes to be called at
    Documentation/sphinx/. Change it to work on any directory,
    and make it abort if something gets wrong.

    Also, be sure that both parameters are specified.

    That should avoid troubles like this:

    $ Documentation/sphinx/tmplcvt Documentation/DocBook/writing_usb_driver.tmpl
    sed: couldn't open file convert_template.sed: No such file or directory

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     

09 Apr, 2017

3 commits

03 Apr, 2017

12 commits

  • f504d47be   docs: Convert unshare.txt to RST and add to the user-space API manual ... Browse Code »

    This is a straightforward conversion, without any real textual changes.
    Since this document has seen no substantive changes since its addition in
    2006, some such changes are probably warranted.

    Signed-off-by: Jonathan Corbet

    Jonathan Corbet
     
  • 1d596dee3   docs: Create a user-space API guide ... Browse Code »

    This is meant to be the place for documentation relevant to application
    developers. It's empty for the moment, but at least we have a place now!

    Signed-off-by: Jonathan Corbet

    Jonathan Corbet
     
  • 0e056eb55   kernel-api.rst: fix a series of errors when parsing C files ... Browse Code »

    ./lib/string.c:134: WARNING: Inline emphasis start-string without end-string.
    ./mm/filemap.c:522: WARNING: Inline interpreted text or phrase reference start-string without end-string.
    ./mm/filemap.c:1283: ERROR: Unexpected indentation.
    ./mm/filemap.c:3003: WARNING: Inline interpreted text or phrase reference start-string without end-string.
    ./mm/vmalloc.c:1544: WARNING: Inline emphasis start-string without end-string.
    ./mm/page_alloc.c:4245: ERROR: Unexpected indentation.
    ./ipc/util.c:676: ERROR: Unexpected indentation.
    ./drivers/pci/irq.c:35: WARNING: Block quote ends without a blank line; unexpected unindent.
    ./security/security.c:109: ERROR: Unexpected indentation.
    ./security/security.c:110: WARNING: Definition list ends without a blank line; unexpected unindent.
    ./block/genhd.c:275: WARNING: Inline strong start-string without end-string.
    ./block/genhd.c:283: WARNING: Inline strong start-string without end-string.
    ./include/linux/clk.h:134: WARNING: Inline emphasis start-string without end-string.
    ./include/linux/clk.h:134: WARNING: Inline emphasis start-string without end-string.
    ./ipc/util.c:477: ERROR: Unknown target name: "s".

    Signed-off-by: Mauro Carvalho Chehab
    Acked-by: Bjorn Helgaas
    Signed-off-by: Jonathan Corbet

    mchehab@s-opensource.com
     
  • 40bf19a8d   kernel-api.rst: fix some complex tags at lib/bitmap.c ... Browse Code »

    Fix the following issues:

    ./lib/bitmap.c:869: WARNING: Definition list ends without a blank line; unexpected unindent.
    ./lib/bitmap.c:876: WARNING: Inline emphasis start-string without end-string.
    ./lib/bitmap.c:508: ERROR: Unexpected indentation.

    And make sure that a table and a footnote will use the right tags.

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    mchehab@s-opensource.com
     
  • 6cc89134c   kernel-api.rst: fix output of the vsnprintf() documentation ... Browse Code »

    The vsnprintf() kernel-doc comment uses % character with a special
    meaning other than escaping a constant. As ReST already defines
    ``literal`` as an escape sequence, let's make kernel-doc handle it,
    and use it at lib/vsprintf.c.

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    mchehab@s-opensource.com
     
  • c7e2c0643   docs-rst: core_api: move driver-specific stuff to drivers_api ... Browse Code »

    There are several stuff there that are actually driver-specific.

    Move those to the driver_api book.

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • 61c8830bc   kernel-api.rst: make it handle lib/crc32.c ... Browse Code »

    This file has only "internal" functions:
    ./lib/crc32.c:1: warning: no structured comments found

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • baca8a0c9   kernel-api.tmpl: convert it to ReST ... Browse Code »

    Brainless conversion of genericirq.tmpl book to ReST, via
    Documentation/sphinx/tmplcvt

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • 76d40fae1   genericirq.rst: add cross-reference links and use monospaced fonts ... Browse Code »

    The document describes several functions that are documented
    there via kernel doc macros. Add cross-references to them.

    In order to be consistend with other documents, use monospaced
    fonts for fields.

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • 3bd3b99ab   genericirq.tmpl: convert it to ReST ... Browse Code »

    Brainless conversion of genericirq.tmpl book to ReST, via
    Documentation/sphinx/tmplcvt

    Copyright information inserted manually.

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • f9b5c5304   scripts/kernel-doc: fix handling of parameters with parenthesis ... Browse Code »

    lib/crc32c defines one parameter as:
    const u32 (*tab)[256]

    Better handle parenthesis, to avoid those warnings:

    ./lib/crc32.c:149: warning: No description found for parameter 'tab)[256]'
    ./lib/crc32.c:149: warning: Excess function parameter 'tab' description in 'crc32_le_generic'
    ./lib/crc32.c:294: warning: No description found for parameter 'tab)[256]'
    ./lib/crc32.c:294: warning: Excess function parameter 'tab' description in 'crc32_be_generic'

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • b97f193ab   scripts/kernel-doc: fix parser for apostrophes ... Browse Code »

    On ReST, adding a text like ``literal`` is valid. However,
    the kernel-doc script won't handle it fine.

    We really need this feature, in order to escape things like
    %ph, with is found on some C files.

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     

31 Mar, 2017

2 commits

30 Mar, 2017

3 commits

19 Mar, 2017

1 commit

18 Mar, 2017

7 commits

14 Mar, 2017

4 commits