Eric Lee / smarc-fsl-linux-kernel

09 Sep, 2017

3 commits

  • 54d6d73f5   docs-rst: don't require adjustbox anymore ... Browse Code »

    Only the media PDF book was requiring adjustbox, in order to
    scale big tables. That worked pretty good with Sphinx versions
    1.4 and 1.5, but Spinx 1.6 changed the way tables are produced,
    by introducing some weird macros before tabulary.
    That causes adjustbox to fail. So, it can't be used anymore,
    and its usage was removed from the media book.

    So, let's remove it from conf.py and sphinx-pre-install.

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

    Mauro Carvalho Chehab
     
  • 9fdcd6afd   docs-rst: conf.py: only setup notice box colors if Sphinx < 1.6 ... Browse Code »

    Sphinx 1.5 added a new way to change backward colors for note
    boxes, but kept backward compatibility with 1.4. On Sphinx 1.6,
    the old way stopped working, in favor of a new less hackish
    way.

    Unfortunately, this is currently too buggy to be used, and
    the old way doesn't work anymore. So, we have no option but
    to stick with boring notice boxes.

    One example of such bug is the notice that it is inside
    struct v4l2_plane, at the "bytesused" field.

    At least, add a notice about how to use, as maybe some day
    the bug will vanish.

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

    Mauro Carvalho Chehab
     
  • c4b326e1a   docs-rst: conf.py: remove lscape from LaTeX preamble ... Browse Code »

    Only the media book used this extension in the past, but
    it is not required anymore.

    Cleanup patch only.

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

    Mauro Carvalho Chehab
     

27 Aug, 2017

1 commit

25 Aug, 2017

2 commits

  • 0e4c2b758   docs: fix minimal sphinx version in conf.py ... Browse Code »

    according to what Documentation/doc-guide/sphinx.rst says::

    The ReST markups currently used by the Documentation/ files
    are meant to be built with ``Sphinx`` version 1.3 or upper.

    Signed-off-by: Markus Heiser
    Signed-off-by: Jonathan Corbet

    Markus Heiser
     
  • 5148e6ab7   docs-rst: pdf: use same vertical margin on all Sphinx versions ... Browse Code »

    Currently, on Sphinx up to version 1.4, pdf output uses a vertical
    margin of 1 inch. For upper versions, it uses a margin of 0.5 inches.

    That causes both page headers and footers to be very close to the margin
    of the sheet. Not all printers support writing like that.

    Also, there's no reason why the layout for newer versions would be
    different than for previous ones.

    So, standardize it, by always setting to 1 inch.

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

    Mauro Carvalho Chehab
     

24 Jun, 2017

2 commits

  • 633d612bd   Docs: Fix breakage with Sphinx 1.5 and upper ... Browse Code »

    Commit 85c21e5c3ee7 (docs-rst: better adjust margins and font size) added a
    \usepackage{geometry} that conflicts with another inclusion deep within the
    dependencies with newer versions of Sphinx, causing the the PDF build to fail
    with a "conflicting parameters" error.

    Detect the Sphinx version, using sphinxsetup for Sphinx versions 1.5 and
    upper.

    Fixes: 85c21e5c3ee74fb75d690c57f7066bae7e2dca55
    [jc: Tweaked logic to exclude 1.5.x for x < 3 ]
    Signed-off-by: Mauro Carvalho Chehab

    Mauro Carvalho Chehab
     
  • cc1102219   Docs: Include the Latex "ifthen" package ... Browse Code »

    Otherwise we get PDF build failures when LaTeX refused to acknowledge the
    existence of \ifthenelse

    Fixes: 41cff161fe99d1c6a773becc2250a1dc3ac035ff
    Cc: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Jonathan Corbet
     

16 May, 2017

11 commits

04 May, 2017

1 commit

  • 16a12fa9a   Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input ... Browse Code »

    Pull input subsystem updates from Dmitry Torokhov:

    - a big update from Mauro converting input documentation to ReST format

    - Synaptics PS/2 is now aware of SMBus companion devices, which means
    that we can now use native RMI4 protocol to handle touchpads, instead
    of relying on legacy PS/2 mode.

    - we removed support from BMA180 accelerometer from input devices as it
    is now handled properly by IIO

    - update to TSC2007 to corretcly report pressure

    - other miscellaneous driver fixes.

    * 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input: (152 commits)
    Input: ar1021_i2c - use BIT to check for a bit
    Input: twl4030-pwrbutton - use input_set_capability() helper
    Input: twl4030-pwrbutton - use correct device for irq request
    Input: ar1021_i2c - enable touch mode during open
    Input: add uinput documentation
    dt-bindings: input: add bindings document for ar1021_i2c driver
    dt-bindings: input: rotary-encoder: fix typo
    Input: xen-kbdfront - add module parameter for setting resolution
    ARM: pxa/raumfeld: fix compile error in rotary controller resources
    Input: xpad - do not suggest writing to Dominic
    Input: xpad - don't use literal blocks inside footnotes
    Input: xpad - note that usb/devices is now at /sys/kernel/debug/
    Input: docs - freshen up introduction
    Input: docs - split input docs into kernel- and user-facing
    Input: docs - note that MT-A protocol is obsolete
    Input: docs - update joystick documentation a bit
    Input: docs - remove disclaimer/GPL notice
    Input: fix "Game console" heading level in joystick documentation
    Input: rotary-encoder - remove references to platform data from docs
    Input: move documentation for Amiga CD32
    ...

    Linus Torvalds
     

06 Apr, 2017

1 commit

31 Mar, 2017

1 commit

09 Mar, 2017

1 commit

  • db6ccf23e   docs-rst: automatically convert Graphviz and SVG images ... Browse Code »

    This patch brings scalable figure, image handling and a concept to
    embed *render* markups:

    * DOT (http://www.graphviz.org)
    * SVG

    For image handling use the 'image' replacement::

    .. kernel-image:: svg_image.svg
    :alt: simple SVG image

    For figure handling use the 'figure' replacement::

    .. kernel-figure:: svg_image.svg
    :alt: simple SVG image

    SVG image example

    Embed *render* markups (or languages) like Graphviz's **DOT** is
    provided by the *render* directive.::

    .. kernel-render:: DOT
    :alt: foobar digraph
    :caption: Embedded **DOT** (Graphviz) code.

    digraph foo {
    "bar" -> "baz";
    }

    The *render* directive is a concept to integrate *render* markups and
    languages, yet supported markups:

    * DOT: render embedded Graphviz's **DOT**
    * SVG: render embedded Scalable Vector Graphics (**SVG**)

    Cc: Jani Nikula
    Cc: Laurent Pinchart
    Tested-by: Mauro Carvalho Chehab
    Tested-by: Daniel Vetter
    Signed-off-by: Daniel Vetter (v2 - v5)
    Signed-off-by: Markus Heiser (v1, v6)
    Signed-off-by: Jonathan Corbet

    Markus Heiser
     

04 Mar, 2017

1 commit

07 Feb, 2017

1 commit

20 Nov, 2016

1 commit

17 Nov, 2016

2 commits

  • 22917b992   docs: Add more manuals to the PDF build ... Browse Code »

    There were a few manuals that weren't being built in PDF format, but
    there's no reason not to...

    Signed-off-by: Jonathan Corbet

    Jonathan Corbet
     
  • e2a91f4f4   docs-rst: fix LaTeX \DURole renewcommand with Sphinx 1.3+ ... Browse Code »

    PDF build on Kernel 4.9-rc? returns an error with Sphinx 1.3.x
    and Sphinx 1.4.x, when trying to solve some cross-references.

    The solution is to redefine the \DURole macro.

    However, this is redefined too late. Move such redefinition to
    LaTeX preamble and bind it to just the Sphinx versions where the
    error is known to be present.

    Tested by building the documentation on interactive mode:
    make PDFLATEX=xelatex -C Documentation/output/./latex

    Fixes: e61a39baf74d ("[media] index.rst: Fix LaTeX error in interactive mode on Sphinx 1.4.x")
    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     

03 Nov, 2016

2 commits

  • b459106ea   Documentation/sphinx: set literal block highlight language to none ... Browse Code »

    Set the default highlight language to "none", i.e. do not try to guess
    the language and do automatic syntax highlighting on literal blocks.

    Eyeballing around the generated documentation, we don't seem to actually
    have a lot of literal blocks that would benefit from syntax
    highlighting. The C code blocks we do have are typically very short, and
    most of the literal blocks are things that shouldn't be highlighted (or,
    do not have a pygments lexer). This seems to be true for literal blocks
    both in the rst source files and in source code comments.

    Not highlighting code is never wrong, but guessing the language wrong
    almost invariably leads to silly or confusing highlighting.

    At the time of writing, admin-guide/oops-tracing.rst and
    admin-guide/ramoops.rst contain good examples of 1) a small C code
    snippet not highlighted, 2) a hex dump highligted as who knows what, 3)
    device tree block highlighted as C or maybe Python, 4) a terminal
    interaction highlighted as code in some language, and finally, 5) some C
    code snippets correctly identified as C. I think we're better off
    disabling language guessing, and going by explicitly identified
    languages for longer code blocks.

    It is still possible to enable highlighting on an rst source file basis
    using the highlight directive:

    .. higlight:: language

    and on a literal block basis using the code-block directive:

    .. code-block:: language

    See http://www.sphinx-doc.org/en/latest/markup/code.html for details.

    Cc: Jonathan Corbet
    Cc: Mauro Carvalho Chehab
    Cc: Markus Heiser
    Signed-off-by: Jani Nikula

    Jani Nikula
     
  • 8d26d90ba   Documentation/sphinx: include admin-guide in the latex/pdf build ... Browse Code »

    Fix the warning:

    WARNING: "latex_documents" config value references unknown document
    user/index

    Reviewed-by: Mauro Carvalho Chehab
    Signed-off-by: Jani Nikula

    Jani Nikula
     

24 Oct, 2016

2 commits

20 Oct, 2016

1 commit

12 Oct, 2016

1 commit

  • de34f4da7   Merge tag 'media/v4.9-1' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-media ... Browse Code »

    Pull media updates from Mauro Carvalho Chehab:

    - Documentation improvements: conversion of all non-DocBook documents
    to Sphinx and lots of fixes to the uAPI media book

    - New PCI driver for Techwell TW5864 media grabber boards

    - New SoC driver for ATMEL Image Sensor Controller

    - Removal of some obsolete SoC drivers (s5p-tv driver and soc_camera
    drivers)

    - Addition of ST CEC driver

    - Lots of drivers fixes, improvements and additions

    * tag 'media/v4.9-1' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-media: (464 commits)
    [media] ttusb_dec: avoid the risk of go past buffer
    [media] cx23885: Fix some smatch warnings
    [media] si2165: switch to regmap
    [media] si2165: use i2c_client->dev instead of i2c_adapter->dev for logging
    [media] si2165: Remove legacy attach
    [media] cx231xx: attach si2165 driver via i2c_client
    [media] cx231xx: Prepare for attaching new style i2c_client DVB demod drivers
    [media] cx23885: attach si2165 driver via i2c_client
    [media] si2165: support i2c_client attach
    [media] si2165: avoid division by zero
    [media] rcar-vin: add R-Car gen2 fallback compatibility string
    [media] lgdt3306a: remove 20*50 msec unnecessary timeout
    [media] cx25821: Remove deprecated create_singlethread_workqueue
    [media] cx25821: Drop Freeing of Workqueue
    [media] cxd2841er: force 8MHz bandwidth for DVB-C if specified bw not supported
    [media] redrat3: hardware-specific parameters
    [media] redrat3: remove hw_timeout member
    [media] cxd2841er: BER and SNR reading for ISDB-T
    [media] dvb-usb: avoid link error with dib3000m{b,c|
    [media] dvb-usb: split out common parts of dibusb
    ...

    Linus Torvalds
     

05 Oct, 2016

1 commit

  • 02bafd96f   Merge tag 'docs-4.9' of git://git.lwn.net/linux ... Browse Code »

    Pull documentation updates from Jonathan Corbet:
    "This is the documentation update pull for the 4.9 merge window.

    The Sphinx transition is still creating a fair amount of work. Here we
    have a number of fixes and, importantly, a proper PDF output solution,
    thanks to Jani Nikula, Mauro Carvalho Chehab and Markus Heiser.

    I've started a couple of new books: a driver API book (based on the
    old device-drivers.tmpl) and a development tools book. Both are meant
    to show how we can integrate together our existing documentation into
    a more coherent and accessible whole. It involves moving some stuff
    around and formatting changes, but, I think, the results are worth it.
    The good news is that most of our existing Documentation/*.txt files
    are *almost* in RST format already; the amount of messing around
    required is minimal.

    And, of course, there's the usual set of updates, typo fixes, and
    more"

    * tag 'docs-4.9' of git://git.lwn.net/linux: (120 commits)
    URL changed for Linux Foundation TAB
    dax : Fix documentation with respect to struct pages
    iio: Documentation: Correct the path used to create triggers.
    docs: Remove space-before-label guidance from CodingStyle
    docs-rst: add inter-document cross references
    Documentation/email-clients.txt: convert it to ReST markup
    Documentation/kernel-docs.txt: reorder based on timestamp
    Documentation/kernel-docs.txt: Add dates for online docs
    Documentation/kernel-docs.txt: get rid of broken docs
    Documentation/kernel-docs.txt: move in-kernel docs
    Documentation/kernel-docs.txt: remove more legacy references
    Documentation/kernel-docs.txt: add two published books
    Documentation/kernel-docs.txt: sort books per publication date
    Documentation/kernel-docs.txt: adjust LDD references
    Documentation/kernel-docs.txt: some improvements on the ReST output
    Documentation/kernel-docs.txt: Consistent indenting: 4 spaces
    Documentation/kernel-docs.txt: Add 4 paper/book references
    Documentation/kernel-docs.txt: Improve layouting of book list
    Documentation/kernel-docs.txt: Remove offline or outdated entries
    docs: Clean up bare :: lines
    ...

    Linus Torvalds
     

21 Sep, 2016

1 commit

23 Aug, 2016

4 commits