Eric Lee / smarc-fsl-linux-kernel

17 Sep, 2020

1 commit

  • c170f2eb9   docs: Document cross-referencing between documentation pages ... Browse Code »

    The syntax to cross-reference between documentation pages wasn't
    documented anywhere.

    Document the cross-referencing using the new automarkup for
    Documentation/... and also Sphinx's doc directive for using relative
    paths.

    Signed-off-by: Nícolas F. R. A. Prado
    Link: https://lore.kernel.org/r/20200911133339.327721-4-nfraprado@protonmail.com
    Signed-off-by: Jonathan Corbet

    Nícolas F. R. A. Prado
     

27 Jun, 2019

1 commit

15 Jun, 2019

1 commit

31 May, 2019

1 commit

  • a700767a7   docs: requirements.txt: recommend Sphinx 1.7.9 ... Browse Code »

    As discussed at the linux-doc ML, while we'll still support
    version 1.3, it is time to recommend a more modern version.

    So, let's switch the minimal requirements to Sphinx 1.7.9,
    as it has the "-jauto" flag, with makes a lot faster when
    building documentation.

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

    Mauro Carvalho Chehab
     

15 Jan, 2019

1 commit

  • 4d01460ec   docs-rst: doc-guide: Minor grammar fixes ... Browse Code »

    While using this guide to learn the new documentation method, I saw
    a few phrases that I felt could be improved. These small changes
    improve the grammar and choice of words to further enhance the
    installation instructions.

    Signed-off-by: Joel Nider
    Acked-by: Mike Rapoport
    Acked-by: Matthew Wilcox
    Signed-off-by: Jonathan Corbet

    Joel Nider
     

07 Dec, 2018

1 commit

  • f77af637f   doc:process: add links where missing ... Browse Code »

    Some documents are refering to others without links. With this
    patch I add those missing links.

    This patch affects only documents under process/ and labels where
    necessary.

    Signed-off-by: Federico Vaga
    Signed-off-by: Jonathan Corbet

    Federico Vaga
     

26 Jun, 2018

1 commit

27 Aug, 2017

1 commit

24 Jul, 2017

1 commit

18 Jul, 2017

5 commits

16 May, 2017

1 commit

09 Mar, 2017

2 commits

  • 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
     
  • c3c53600f   doc: Explain light-handed markup preference a bit better ... Browse Code »

    We're still pretty far away from anything like a consensus, but
    there's clearly a lot of people who prefer an as-light as possible
    approach to converting existing .txt files to .rst. Make sure this is
    properly taken into account and clear.

    Motivated by discussions with Peter and Christoph and others.

    Cc: Christoph Hellwig
    Cc: Peter Zijlstra
    Cc: Jani Nikula
    Cc: Mauro Carvalho Chehab
    Signed-off-by: Daniel Vetter
    Signed-off-by: Jonathan Corbet

    Daniel Vetter
     

20 Nov, 2016

1 commit