Eric Lee / smarc-fsl-linux-kernel

04 Sep, 2021

1 commit

  • abf36fe0b   docs: kernel-hacking: Remove inappropriate text ... Browse Code »

    Remove inappropriate sexual (and ableist) text from the locking
    documentation, aligning it with the kernel code-of-conduct. As the text
    was unrelated to locking, this change streamlines the document and
    improves readability.

    Signed-off-by: Alyssa Rosenzweig
    Link: https://lore.kernel.org/r/20210903151826.6300-1-alyssa@rosenzweig.io
    Signed-off-by: Jonathan Corbet

    Alyssa Rosenzweig
     

25 Aug, 2021

1 commit

  • fe450eeb4   Documentation: in_irq() cleanup ... Browse Code »

    Replace the obsolete and ambiguos macro in_irq() with new
    macro in_hardirq().

    Signed-off-by: Changbin Du

    Link: https://lore.kernel.org/r/20210814014831.53083-1-changbin.du@gmail.com
    Signed-off-by: Jonathan Corbet

    Changbin Du
     

18 Jun, 2021

1 commit

12 Feb, 2021

1 commit

  • 3c2e0a489   docs: kernel-hacking: be more civil ... Browse Code »

    Remove the f-bomb from locking.rst. Let's have a moment of silence,
    though, as we mark the passing of the last of Rusty's once plentiful
    profanities in this venerable document.

    Signed-off-by: Bhaskar Chowdhury
    Link: https://lore.kernel.org/r/20210205115951.1276526-1-unixbhaskar@gmail.com
    [jc: rewrote changelog]
    Signed-off-by: Jonathan Corbet

    Bhaskar Chowdhury
     

12 Jan, 2021

1 commit

01 Jan, 2021

1 commit

  • 4f8af077a   docs: Fix reST markup when linking to sections ... Browse Code »

    During the process of converting the documentation to reST, some links
    were converted using the following wrong syntax (and sometimes using %20
    instead of spaces):

    `Display text `__

    This syntax isn't valid according to the docutils' spec [1], but more
    importantly, it is specific to HTML, since it uses '#' to link to an
    HTML anchor.

    The right syntax would instead use a docutils hyperlink reference as the
    embedded URI to point to the section [2], that is:

    `Display text `__

    This syntax works in both HTML and PDF.

    The LaTeX toolchain doesn't mind the HTML anchor syntax when generating
    the pdf documentation (make pdfdocs), that is, the build succeeds but
    the links don't work, but that syntax causes errors when trying to build
    using the not-yet-merged rst2pdf:

    ValueError: format not resolved, probably missing URL scheme or undefined destination target for 'Forcing%20Quiescent%20States'

    So, use the correct syntax in order to have it work in all different
    output formats.

    [1]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#reference-names
    [2]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#embedded-uris-and-aliases

    Fixes: ccc9971e2147 ("docs: rcu: convert some articles from html to ReST")
    Fixes: c8cce10a62aa ("docs: Fix the reference labels in Locking.rst")
    Fixes: e548cdeffcd8 ("docs-rst: convert kernel-locking to ReST")
    Fixes: 7ddedebb03b7 ("ALSA: doc: ReSTize writing-an-alsa-driver document")
    Signed-off-by: Nícolas F. R. A. Prado
    Reviewed-by: Takashi Iwai
    Reviewed-by: Mauro Carvalho Chehab
    Link: https://lore.kernel.org/r/20201228144537.135353-1-nfraprado@protonmail.com
    Signed-off-by: Jonathan Corbet

    Nícolas F. R. A. Prado
     

21 Mar, 2020

3 commits

  • b1735296c   docs: locking: Drop :c:func: throughout ... Browse Code »

    The kernel doc tooling knows how to do this itself so drop this markup
    throughout this file to simplify.

    Suggested-by: Jonathan Corbet
    Signed-off-by: Stephen Boyd
    Link: https://lore.kernel.org/r/20200318174133.160206-3-swboyd@chromium.org
    Signed-off-by: Jonathan Corbet

    Stephen Boyd
     
  • 6adb77559   docs: locking: Add 'need' to hardirq section ... Browse Code »

    Add the missing word to make this sentence read properly.

    Signed-off-by: Stephen Boyd
    Link: https://lore.kernel.org/r/20200318174133.160206-2-swboyd@chromium.org
    Signed-off-by: Jonathan Corbet

    Stephen Boyd
     
  • c44166fe5   docs: prevent warnings due to autosectionlabel ... Browse Code »

    Changeset 58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")
    enabled a new feature at Sphinx: it will now generate index for each
    document title, plus to each chapter inside it.

    There's a drawback, though: one document cannot have two sections
    with the same name anymore.

    A followup patch will change the logic of autosectionlabel to
    avoid most creating references for every single section title,
    but still we need to be able to reference the chapters inside
    a document.

    There are a few places where there are two chapters with the
    same name. This patch renames one of the chapters, in order to
    avoid symbol conflict within the same document.

    PS.: as I don't speach Chinese, I had some help from a friend
    (Wen Liu) at the Chinese translation for "publishing patches"
    for this document:

    Documentation/translations/zh_CN/process/5.Posting.rst

    Fixes: 58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")
    Signed-off-by: Mauro Carvalho Chehab
    Link: https://lore.kernel.org/r/2bffb91e4a63d41bf5fae1c23e1e8b3bba0b8806.1584716446.git.mchehab+huawei@kernel.org
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     

20 Mar, 2020

1 commit

  • 58ad30cf9   docs: fix reference to core-api/namespaces.rst ... Browse Code »

    Fix a couple of dangling links to core-api/namespaces.rst by turning them
    into proper references. Enable the autosection extension (available since
    Sphinx 1.4) to make this work.

    Co-developed-by: Federico Vaga
    Fixes: fcfacb9f8374 ("doc: move namespaces.rst from kbuild/ to core-api/")
    Signed-off-by: Jonathan Corbet

    Jonathan Corbet
     

20 Dec, 2019

1 commit

  • bc51a6d34   Documentation: kernel-hacking: hacking.rst: Change reference to document namespa… ... Browse Code »

    …ces.rst to symbol-namespaces.rst

    This patch fixes the following documentation build warning:
    Warning: Documentation/kernel-hacking/hacking.rst references
    a file that doesn't exist: Documentation/kbuild/namespaces.rst

    According to the following patch:
    https://patchwork.kernel.org/patch/11178727/
    (doc: move namespaces.rst from kbuild/ to core-api/)

    The file namespaces.rst was moved from kbuild to core-api
    and renamed to symbol-namespaces.rst.
    Therefore, this patch changes the reference to the document
    kbuild/namespaces.rst in hacking.rst to
    core-api/symbol-namespaces.rst

    Signed-off-by: Madhuparna Bhowmik <madhuparnabhowmik04@gmail.com>
    Link: https://lore.kernel.org/r/20191204104554.9100-1-madhuparnabhowmik04@gmail.com
    Signed-off-by: Jonathan Corbet <corbet@lwn.net>

    Madhuparna Bhowmik
     

10 Sep, 2019

1 commit

17 Jul, 2019

1 commit

15 Jul, 2019

1 commit

  • 387b14684   docs: locking: convert docs to ReST and rename to *.rst ... Browse Code »

    Convert the locking documents to ReST and add them to the
    kernel development book where it belongs.

    Most of the stuff here is just to make Sphinx to properly
    parse the text file, as they're already in good shape,
    not requiring massive changes in order to be parsed.

    The conversion is actually:
    - add blank lines and identation in order to identify paragraphs;
    - fix tables markups;
    - add some lists markups;
    - mark literal blocks;
    - adjust title markups.

    At its new index.rst, let's add a :orphan: while this is not linked to
    the main index.rst file, in order to avoid build warnings.

    Signed-off-by: Mauro Carvalho Chehab
    Acked-by: Federico Vaga

    Mauro Carvalho Chehab
     

21 Jun, 2019

1 commit

  • 220ee02a0   docs: stop suggesting strlcpy ... Browse Code »

    Since strlcpy is deprecated, the documentation shouldn't suggest using
    it. This patch fixes the examples to use strscpy instead. It also uses
    sizeof instead of underlying constants as far as possible, to simplify
    future changes to the corresponding data structures.

    Signed-off-by: Stephen Kitt
    Acked-by: Kees Cook
    Acked-by: Federico Vaga
    Signed-off-by: Jonathan Corbet

    Stephen Kitt
     

15 Jun, 2019

1 commit

  • cd238effe   docs: kbuild: convert docs to ReST and rename to *.rst ... Browse Code »

    The kbuild documentation clearly shows that the documents
    there are written at different times: some use markdown,
    some use their own peculiar logic to split sections.

    Convert everything to ReST without affecting too much
    the author's style and avoiding adding uneeded markups.

    The conversion is actually:
    - add blank lines and identation in order to identify paragraphs;
    - fix tables markups;
    - add some lists markups;
    - mark literal blocks;
    - adjust title markups.

    At its new index.rst, let's add a :orphan: while this is not linked to
    the main index.rst file, in order to avoid build warnings.

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

    Mauro Carvalho Chehab
     

27 Jul, 2018

2 commits

26 Jun, 2018

1 commit

  • aa586e257   doc: add some chapter labels ... Browse Code »

    The idea is to make it easier to create references (doc-guide does the same).
    This will be used, for example but not only, in translations to point to
    the main document.

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

    Federico Vaga
     

18 Jan, 2018

1 commit

12 Dec, 2017

1 commit

04 Jul, 2017

1 commit

  • 650fc870a   Merge tag 'docs-4.13' of git://git.lwn.net/linux ... Browse Code »

    Pull documentation updates from Jonathan Corbet:
    "There has been a fair amount of activity in the docs tree this time
    around. Highlights include:

    - Conversion of a bunch of security documentation into RST

    - The conversion of the remaining DocBook templates by The Amazing
    Mauro Machine. We can now drop the entire DocBook build chain.

    - The usual collection of fixes and minor updates"

    * tag 'docs-4.13' of git://git.lwn.net/linux: (90 commits)
    scripts/kernel-doc: handle DECLARE_HASHTABLE
    Documentation: atomic_ops.txt is core-api/atomic_ops.rst
    Docs: clean up some DocBook loose ends
    Make the main documentation title less Geocities
    Docs: Use kernel-figure in vidioc-g-selection.rst
    Docs: fix table problems in ras.rst
    Docs: Fix breakage with Sphinx 1.5 and upper
    Docs: Include the Latex "ifthen" package
    doc/kokr/howto: Only send regression fixes after -rc1
    docs-rst: fix broken links to dynamic-debug-howto in kernel-parameters
    doc: Document suitability of IBM Verse for kernel development
    Doc: fix a markup error in coding-style.rst
    docs: driver-api: i2c: remove some outdated information
    Documentation: DMA API: fix a typo in a function name
    Docs: Insert missing space to separate link from text
    doc/ko_KR/memory-barriers: Update control-dependencies example
    Documentation, kbuild: fix typo "minimun" -> "minimum"
    docs: Fix some formatting issues in request-key.rst
    doc: ReSTify keys-trusted-encrypted.txt
    doc: ReSTify keys-request-key.txt
    ...

    Linus Torvalds
     

16 May, 2017

6 commits