Eric Lee / smarc-fsl-linux-kernel

18 Jun, 2021

1 commit

05 Feb, 2021

1 commit

01 Jan, 2021

1 commit

  • 0be1511f5   Documentation: doc-guide: fixes to sphinx.rst ... Browse Code »

    Various fixes to sphinx.rst:

    - eliminate a double-space between 2 words
    - grammar/wording
    - punctuation
    - call rows in a table 'rows' instead of 'columns' (or does Sphinx
    call everything a column?)
    - It seems that "amdfonts" should be "amsfonts". I can't find any
    amdfonts.

    Signed-off-by: Randy Dunlap
    Reviewed-by: Mauro Carvalho Chehab
    Link: https://lore.kernel.org/r/20201228231212.22448-1-rdunlap@infradead.org
    Signed-off-by: Jonathan Corbet

    Randy Dunlap
     

09 Dec, 2020

1 commit

04 Dec, 2020

1 commit

15 Oct, 2020

1 commit

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
     

04 Sep, 2020

1 commit

11 Jun, 2020

1 commit

  • 6d62c5b21   Merge tag 'docs-5.8-2' of git://git.lwn.net/linux ... Browse Code »

    Pull more documentation updates from Jonathan Corbet:
    "A handful of late-arriving docs fixes, along with a patch changing a
    lot of HTTP links to HTTPS that had to be yanked and redone before the
    first pull"

    * tag 'docs-5.8-2' of git://git.lwn.net/linux:
    docs/memory-barriers.txt/kokr: smp_mb__{before,after}_atomic(): update Documentation
    Documentation: devres: add missing entry for devm_platform_get_and_ioremap_resource()
    Replace HTTP links with HTTPS ones: documentation
    docs: it_IT: address invalid reference warnings
    doc: zh_CN: use doc reference to resolve undefined label warning
    docs: Update the location of the LF NDA program
    docs: dev-tools: coccinelle: underlines

    Linus Torvalds
     

08 Jun, 2020

1 commit

  • 93431e060   Replace HTTP links with HTTPS ones: documentation ... Browse Code »

    Rationale:
    Reduces attack surface on kernel devs opening the links for MITM
    as HTTPS traffic is much harder to manipulate.

    Deterministic algorithm:
    For each file:
    For each line:
    If doesn't contain `\bxmlns\b`:
    For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`:
    If both the HTTP and HTTPS versions
    return 200 OK and serve the same content:
    Replace HTTP with HTTPS.

    Signed-off-by: Alexander A. Klimov
    Link: https://lore.kernel.org/r/20200526060544.25127-1-grandmaster@al2klimov.de
    Signed-off-by: Jonathan Corbet

    Alexander A. Klimov
     

04 Jun, 2020

1 commit

  • a98f670e4   Merge tag 'media/v5.8-1' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-media ... Browse Code »

    Pull media updates from Mauro Carvalho Chehab:

    - Media documentation is now split into admin-guide, driver-api and
    userspace-api books (a longstanding request from Jon);

    - The media Kconfig was reorganized, in order to make easier to select
    drivers and their dependencies;

    - The testing drivers now has a separate directory;

    - added a new driver for Rockchip Video Decoder IP;

    - The atomisp staging driver was resurrected. It is meant to work with
    4 generations of cameras on Atom-based laptops, tablets and cell
    phones. So, it seems worth investing time to cleanup this driver and
    making it in good shape.

    - Added some V4L2 core ancillary routines to help with h264 codecs;

    - Added an ov2740 image sensor driver;

    - The si2157 gained support for Analog TV, which, in turn, added
    support for some cx231xx and cx23885 boards to also support analog
    standards;

    - Added some V4L2 controls (V4L2_CID_CAMERA_ORIENTATION and
    V4L2_CID_CAMERA_SENSOR_ROTATION) to help identifying where the camera
    is located at the device;

    - VIDIOC_ENUM_FMT was extended to support MC-centric devices;

    - Lots of drivers improvements and cleanups.

    * tag 'media/v5.8-1' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-media: (503 commits)
    media: Documentation: media: Refer to mbus format documentation from CSI-2 docs
    media: s5k5baf: Replace zero-length array with flexible-array
    media: i2c: imx219: Drop and
    media: i2c: Add ov2740 image sensor driver
    media: ov8856: Implement sensor module revision identification
    media: ov8856: Add devicetree support
    media: dt-bindings: ov8856: Document YAML bindings
    media: dvb-usb: Add Cinergy S2 PCIe Dual Port support
    media: dvbdev: Fix tuner->demod media controller link
    media: dt-bindings: phy: phy-rockchip-dphy-rx0: move rockchip dphy rx0 bindings out of staging
    media: staging: dt-bindings: phy-rockchip-dphy-rx0: remove non-used reg property
    media: atomisp: unify the version for isp2401 a0 and b0 versions
    media: atomisp: update TODO with the current data
    media: atomisp: adjust some code at sh_css that could be broken
    media: atomisp: don't produce errs for ignored IRQs
    media: atomisp: print IRQ when debugging
    media: atomisp: isp_mmu: don't use kmem_cache
    media: atomisp: add a notice about possible leak resources
    media: atomisp: disable the dynamic and reserved pools
    media: atomisp: turn on camera before setting it
    ...

    Linus Torvalds
     

21 Apr, 2020

1 commit

14 Apr, 2020

1 commit

  • 54f38fcae   media: docs: move uAPI book to userspace-api/media ... Browse Code »

    Since 2017, there is an space reserved for userspace API,
    created by changeset 1d596dee3862 ("docs: Create a user-space API guide").

    As the media subsystem was one of the first subsystems to use
    Sphinx, until this patch, we were keeping things on a separate
    place.

    Let's just use the new location, as having all uAPI altogether
    will likely make things easier for developers.

    Signed-off-by: Mauro Carvalho Chehab

    Mauro Carvalho Chehab
     

06 Feb, 2020

1 commit

25 Jan, 2020

2 commits

08 Nov, 2019

1 commit

17 Jul, 2019

1 commit

28 Jun, 2019

1 commit

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
     

20 Apr, 2019

1 commit

18 Feb, 2019

1 commit

02 Feb, 2019

2 commits

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
     

08 Nov, 2018

1 commit

  • 1bb37a356   doc-guide:kernel-doc.rst: Reference to foobar ... Browse Code »

    In the Function documentation Section of kernel-doc.rst
    there is a function_name() function as an example for
    how to make a comment about a function.

    But at the end of that example there is a reference to foobar
    instead of function_name.

    I think that should rather be function_name, because that
    was the placeholder the whole example was using.

    Signed-off-by: Joris Gutjahr
    Signed-off-by: Jonathan Corbet

    Joris Gutjahr
     

30 Jun, 2018

1 commit

  • f2e860360   Documentation/sphinx: allow "functions" with no parameters ... Browse Code »

    When kernel-doc:: specified in .rst document without explicit directives,
    it outputs both comment and DOC: sections. If a DOC: section was explicitly
    included in the same document it will be duplicated. For example, the
    output generated for Documentation/core-api/idr.rst [1] has "IDA
    description" in the "IDA usage" section and in the middle of the API
    reference.

    This patch enables using "functions" directive without parameters to output
    all the documentation excluding DOC: sections.

    [1] https://www.kernel.org/doc/html/v4.17/core-api/idr.html

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

    Mike Rapoport
     

26 Jun, 2018

2 commits

04 May, 2018

1 commit

  • 325908199   MAINTAINERS & files: Canonize the e-mails I use at files ... Browse Code »

    From now on, I'll start using my @kernel.org as my development e-mail.

    As such, let's remove the entries that point to the old
    mchehab@s-opensource.com at MAINTAINERS file.

    For the files written with a copyright with mchehab@s-opensource,
    let's keep Samsung on their names, using mchehab+samsung@kernel.org,
    in order to keep pointing to my employer, with sponsors the work.

    For the files written before I join Samsung (on July, 4 2013),
    let's just use mchehab@kernel.org.

    For bug reports, we can simply point to just kernel.org, as
    this will reach my mchehab+samsung inbox anyway.

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Brian Warner
    Signed-off-by: Mauro Carvalho Chehab

    Mauro Carvalho Chehab
     

23 Feb, 2018

1 commit

19 Feb, 2018

4 commits

14 Feb, 2018

2 commits

  • 46347502b   Restructure kernel-doc.rst ... Browse Code »

    I found the layout confusing with multiple introductions to what
    kernel-doc is and how to use it.

    I made the following changes:
    - Moved the 'Including kernel-doc comments' section to the end of
    the document -- we should explain what it *is* before we explain
    how to integrate it.
    - Moved the 'Recommendations' subsection to the top. We want people
    to know what to document before telling them how to do it.
    - Rewrite the 'Writing kernel-doc comments' section, integrating
    the 'Recommendations' subsection and a paragraph from 'How to format
    kernel-doc comments'.
    - Remove the paragraph about the kernel-doc script; we're supposed to
    be teaching people how to use punctuation to write pretty documentation,
    not documenting the build tooling.
    - Split the 'Parameters and member arguments' section into 'Function
    parameters' and 'Members'. Structure members are not commonly
    referred to as arguments.
    - Integrate the 'private:' and 'public:' tag descriptions into the
    'Members' section.
    - Move the 'In-line member documentation comments' subsection up to be
    with the 'Members' section.

    Signed-off-by: Matthew Wilcox
    Signed-off-by: Jonathan Corbet

    Matthew Wilcox
     
  • 9831e5548   Fix whitespace in example ... Browse Code »

    Line up the second line in the way that the example purports to be
    showing.

    Signed-off-by: Matthew Wilcox
    Signed-off-by: Jonathan Corbet

    Matthew Wilcox