12 Nov, 2020

1 commit


24 Oct, 2020

1 commit

  • Pull documentation fixes from Jonathan Corbet:
    "A handful of late-arriving documentation fixes"

    * tag 'docs-5.10-2' of git://git.lwn.net/linux:
    docs: Add two missing entries in vm sysctl index
    docs/vm: trivial fixes to several spelling mistakes
    docs: submitting-patches: describe preserving review/test tags
    Documentation: Chinese translation of Documentation/arm64/hugetlbpage.rst
    Documentation: x86: fix a missing word in x86_64/mm.rst.
    docs: driver-api: remove a duplicated index entry
    docs: lkdtm: Modernize and improve details
    docs: deprecated.rst: Expand str*cpy() replacement notes
    docs/cpu-load: format the example code.

    Linus Torvalds
     

22 Oct, 2020

1 commit


15 Oct, 2020

3 commits

  • As warned by Sphinx 2.4.4:
    .../Documentation/translations/zh_CN/arm64/amu.rst:7: WARNING: Title overline too short.

    Increase its size.

    Signed-off-by: Mauro Carvalho Chehab

    Mauro Carvalho Chehab
     
  • There's a missing "`", causing this warning:
    ./Documentation/translations/it_IT/kernel-hacking/hacking.rst:404: WARNING: Unparseable C cross-reference: 'cpu_to_be32p(), che prende un puntatore\nad un tipo, e ritorna il valore convertito. L\'altra variante per\nla famiglia di conversioni "in-situ", come :c:func:`cpu_to_be32s'
    Invalid C declaration: Expected end of definition. [error at 14]
    cpu_to_be32p(), che prende un puntatore
    ad un tipo, e ritorna il valore convertito. L'altra variante per
    la famiglia di conversioni "in-situ", come :c:func:`cpu_to_be32s
    --------------^

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

    Mauro Carvalho Chehab
     
  • The C domain functions there collide with the English ones,
    due to namespace collision, generating lots of warnings with
    Sphinx 3.x:

    ./include/linux/mutex.h:121: WARNING: Duplicate C declaration, also defined in 'translations/it_IT/kernel-hacking/locking'.
    Declaration is 'mutex_init'.
    ./include/linux/mutex.h:152: WARNING: Duplicate C declaration, also defined in 'translations/it_IT/kernel-hacking/locking'.
    Declaration is 'mutex_is_locked'.
    ./include/linux/mutex.h:226: WARNING: Duplicate C declaration, also defined in 'translations/it_IT/kernel-hacking/locking'.
    Declaration is 'mutex_trylock_recursive'.
    ./kernel/locking/mutex.c:281: WARNING: Duplicate C declaration, also defined in 'translations/it_IT/kernel-hacking/locking'.
    Declaration is 'mutex_lock'.
    ...

    Add a namespace tag there, in order to prevent that.

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

    Mauro Carvalho Chehab
     

29 Sep, 2020

2 commits


10 Sep, 2020

1 commit


01 Sep, 2020

4 commits


25 Aug, 2020

1 commit

  • I noticed a double-() in the deprecated.rst rendering today. Fix that
    one and two others in the Documentation/ tree.

    Acked-by: "Paul E. McKenney" # For RCU
    Signed-off-by: Kees Cook
    Link: https://lore.kernel.org/r/20200817233207.4083538-1-keescook@chromium.org
    Signed-off-by: Jonathan Corbet

    Kees Cook
     

14 Aug, 2020

1 commit

  • Pull documentation fixes from Jonathan Corbet:
    "A handful of obvious fixes that wandered in during the merge window"

    * tag 'docs-5.9-2' of git://git.lwn.net/linux:
    Documentation/locking/locktypes: fix the typo
    doc/zh_CN: resolve undefined label warning in admin-guide index
    doc/zh_CN: fix title heading markup in admin-guide cpu-load
    docs: remove the 2.6 "Upgrading I2C Drivers" guide
    docs: Correct the release date of 5.2 stable
    mailmap: Update comments for with format and more detalis
    docs: cdrom: Fix a typo and rst markup
    Doc: admin-guide: use correct legends in kernel-parameters.txt
    Documentation/features: refresh RISC-V arch support files
    documentation: coccinelle: Improve command example for make C={1,2}
    Core-api: Documentation: Replace deprecated :c:func: Usage
    Dev-tools: Documentation: Replace deprecated :c:func: Usage
    Filesystems: Documentation: Replace deprecated :c:func: Usage
    docs: trace: fix a typo

    Linus Torvalds
     

12 Aug, 2020

2 commits

  • Documentation generation warns:

    Documentation/translations/zh_CN/admin-guide/index.rst:3:
    WARNING: undefined label: documentation/admin-guide/index.rst

    Use doc reference for .rst files to resolve the warning.

    Fixes: 37a607cf2318 ("doc/zh_CN: add admin-guide index")
    Signed-off-by: Lukas Bulwahn
    Link: https://lore.kernel.org/r/20200802161956.18268-1-lukas.bulwahn@gmail.com
    Signed-off-by: Jonathan Corbet

    Lukas Bulwahn
     
  • Documentation generation warns:

    Documentation/translations/zh_CN/admin-guide/cpu-load.rst:1:
    WARNING: Title overline too short.

    Extend title heading markup by one. It was just off by one.

    Fixes: e210c66d567c ("doc/zh_CN: add cpu-load Chinese version")
    Signed-off-by: Lukas Bulwahn
    Acked-by: Tao Zhou
    Link: https://lore.kernel.org/r/20200802162101.18875-1-lukas.bulwahn@gmail.com
    Signed-off-by: Jonathan Corbet

    Lukas Bulwahn
     

05 Aug, 2020

1 commit

  • Pull documentation updates from Jonathan Corbet:
    "It's been a busy cycle for documentation - hopefully the busiest for a
    while to come. Changes include:

    - Some new Chinese translations

    - Progress on the battle against double words words and non-HTTPS
    URLs

    - Some block-mq documentation

    - More RST conversions from Mauro. At this point, that task is
    essentially complete, so we shouldn't see this kind of churn again
    for a while. Unless we decide to switch to asciidoc or
    something...:)

    - Lots of typo fixes, warning fixes, and more"

    * tag 'docs-5.9' of git://git.lwn.net/linux: (195 commits)
    scripts/kernel-doc: optionally treat warnings as errors
    docs: ia64: correct typo
    mailmap: add entry for
    doc/zh_CN: add cpu-load Chinese version
    Documentation/admin-guide: tainted-kernels: fix spelling mistake
    MAINTAINERS: adjust kprobes.rst entry to new location
    devices.txt: document rfkill allocation
    PCI: correct flag name
    docs: filesystems: vfs: correct flag name
    docs: filesystems: vfs: correct sync_mode flag names
    docs: path-lookup: markup fixes for emphasis
    docs: path-lookup: more markup fixes
    docs: path-lookup: fix HTML entity mojibake
    CREDITS: Replace HTTP links with HTTPS ones
    docs: process: Add an example for creating a fixes tag
    doc/zh_CN: add Chinese translation prefer section
    doc/zh_CN: add clearing-warn-once Chinese version
    doc/zh_CN: add admin-guide index
    doc:it_IT: process: coding-style.rst: Correct __maybe_unused compiler label
    futex: MAINTAINERS: Re-add selftests directory
    ...

    Linus Torvalds
     

28 Jul, 2020

1 commit

  • Add cpu-load Chinese version and link it into admin-guide.
    Based on Alex's recent thread:

    https://lkml.kernel.org/r/20200713115807.56362-1-alex.shi@linux.alibaba.com

    Reviewed-by: Alex Shi
    Signed-off-by: Tao Zhou
    Link: https://lore.kernel.org/r/BL0PR14MB37798BBF2307910DE73EF6D49A770@BL0PR14MB3779.namprd14.prod.outlook.com
    Signed-off-by: Jonathan Corbet

    Tao Zhou
     

24 Jul, 2020

4 commits

  • The add words is:

    Tranlation plan:
    Welcome for any part of kernel doc Chinese translation, expecially for
    admin-guide part.

    Signed-off-by: Alex Shi
    Cc: Harry Wei
    Cc: Jonathan Corbet
    Cc: linux-doc@vger.kernel.org
    Cc: linux-kernel@vger.kernel.org
    Link: https://lore.kernel.org/r/20200713115807.56362-3-alex.shi@linux.alibaba.com
    Signed-off-by: Jonathan Corbet

    Alex Shi
     
  • and link it into admin-guide.

    Signed-off-by: Alex Shi
    Cc: Harry Wei
    Cc: Jonathan Corbet
    Cc: linux-doc@vger.kernel.org
    Cc: linux-kernel@vger.kernel.org
    Link: https://lore.kernel.org/r/20200713115807.56362-2-alex.shi@linux.alibaba.com
    Signed-off-by: Jonathan Corbet

    Alex Shi
     
  • Translate the admin-guide index.rst file into Chinese. and link it into
    Chinese top index file.

    Signed-off-by: Alex Shi
    Cc: Harry Wei
    Cc: Jonathan Corbet
    Cc: linux-doc@vger.kernel.org
    Cc: linux-kernel@vger.kernel.org
    Link: https://lore.kernel.org/r/20200713115807.56362-1-alex.shi@linux.alibaba.com
    Signed-off-by: Jonathan Corbet

    Alex Shi
     
  • Flag is __maybe_unused, not __maybe_used.

    Cc: Federico Vaga
    Cc: Jonathan Corbet
    Cc: linux-doc@vger.kernel.org
    Cc: clang-built-linux@googlegroups.com
    Signed-off-by: Lee Jones
    Link: https://lore.kernel.org/r/20200715122328.3882187-1-lee.jones@linaro.org
    Signed-off-by: Jonathan Corbet

    Lee Jones
     

21 Jul, 2020

1 commit


27 Jun, 2020

2 commits

  • - Add a SPDX header;
    - Adjust document title;
    - Adjust document and section titles;
    - Some whitespace fixes and new line breaks;
    - Mark literal blocks as such;
    - Add table markups;
    - Add it to devicetree/index.rst.

    Signed-off-by: Mauro Carvalho Chehab
    Link: https://lore.kernel.org/r/8dce14af13f66cb8393c21b58f0693e667a7045f.1592918949.git.mchehab+huawei@kernel.org
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • As we moved those files to core-api, fix references to point
    to their newer locations.

    Signed-off-by: Mauro Carvalho Chehab
    Link: https://lore.kernel.org/r/37b2fd159fbc7655dbf33b3eb1215396a25f6344.1592895969.git.mchehab+huawei@kernel.org
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     

20 Jun, 2020

3 commits

  • 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
    Reviewed-by: Alex Shi
    Link: https://lore.kernel.org/r/20200608181649.74883-1-grandmaster@al2klimov.de
    Signed-off-by: Jonathan Corbet

    Alexander A. Klimov
     
  • Update the show() usage according to the English version.

    Signed-off-by: Chen Zhou
    Reviewed-by: Alex Shi
    Link: https://lore.kernel.org/r/20200610025333.84010-1-chenzhou10@huawei.com
    Signed-off-by: Jonathan Corbet

    Chen Zhou
     
  • - add complete translation of symbol-namespaces.rst
    - fix references to this page within the italian translation
    - add document to main indexes

    Signed-off-by: Federico Vaga
    Link: https://lore.kernel.org/r/20200614201053.59502-1-federico.vaga@vaga.pv.it
    Signed-off-by: Jonathan Corbet

    Federico Vaga
     

11 Jun, 2020

1 commit

  • 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

3 commits

  • Translate this commit to Korean:

    39323c64b8a9 ("smp_mb__{before,after}_atomic(): update Documentation")

    Signed-off-by: SeongJae Park
    Reviewed-by: Yunjae Lee
    Link: https://lore.kernel.org/r/20200606083746.20869-1-sjpark@amazon.de
    Signed-off-by: Jonathan Corbet

    SeongJae Park
     
  • Documentation generation warns:

    it_IT/kernel-hacking/hacking.rst:
    WARNING: unknown document: ../core-api/symbol/namespaces

    it_IT/process/5.Posting.rst:
    WARNING: undefined label: it_email_clients

    it_IT/process/submitting-patches.rst:
    WARNING: undefined label: it_email_clients

    it_IT/process/howto.rst:
    WARNING: undefined label: it_managementstyle

    Refer to English documentation, as Italian translation does not exist,
    and add labels for Italian process documents to resolve label references.

    Signed-off-by: Lukas Bulwahn
    Link: https://lore.kernel.org/r/20200531185618.7099-1-lukas.bulwahn@gmail.com
    Signed-off-by: Jonathan Corbet

    Lukas Bulwahn
     
  • Documentation generation warns:

    Documentation/translations/zh_CN/filesystems/debugfs.rst:5:
    WARNING: undefined label: debugfs_index

    Use doc reference for files rather than introducing a label to refer to.
    This resolves the warning above.

    Signed-off-by: Lukas Bulwahn
    Reviewed-by: Alex Shi
    Link: https://lore.kernel.org/r/20200531183556.5751-1-lukas.bulwahn@gmail.com
    Signed-off-by: Jonathan Corbet

    Lukas Bulwahn
     

05 Jun, 2020

1 commit

  • Pull devicetree updates from Rob Herring:

    - Convert various DT (non-binding) doc files to ReST

    - Various improvements to device link code

    - Fix __of_attach_node_sysfs refcounting bug

    - Add support for 'memory-region-names' with reserved-memory binding

    - Vendor prefixes for Protonic Holland, BeagleBoard.org, Alps, Check
    Point, Würth Elektronik, U-Boot, Vaisala, Baikal Electronics,
    Shanghai Awinic Technology Co., MikroTik, Silex Insight

    - A bunch more binding conversions to DT schema. Only 3K to go.

    - Add a minimum version check for schema tools

    - Treewide dropping of 'allOf' usage with schema references. Not needed
    in new json-schema spec.

    - Some formatting clean-ups of schemas

    * tag 'devicetree-for-5.8' of git://git.kernel.org/pub/scm/linux/kernel/git/robh/linux: (194 commits)
    dt-bindings: clock: Add documentation for X1830 bindings.
    dt-bindings: mailbox: Convert imx mu to json-schema
    dt-bindings: power: Convert imx gpcv2 to json-schema
    dt-bindings: power: Convert imx gpc to json-schema
    dt-bindings: Merge gpio-usb-b-connector with usb-connector
    dt-bindings: timer: renesas: cmt: Convert to json-schema
    dt-bindings: clock: Convert i.MX8QXP LPCG to json-schema
    dt-bindings: timer: Convert i.MX GPT to json-schema
    dt-bindings: thermal: rcar-thermal: Add device tree support for r8a7742
    dt-bindings: serial: Add binding for UART pin swap
    dt-bindings: geni-se: Add interconnect binding for GENI QUP
    dt-bindings: geni-se: Convert QUP geni-se bindings to YAML
    dt-bindings: vendor-prefixes: Add Silex Insight vendor prefix
    dt-bindings: input: touchscreen: edt-ft5x06: change reg property
    dt-bindings: usb: qcom,dwc3: Introduce interconnect properties for Qualcomm DWC3 driver
    dt-bindings: timer: renesas: mtu2: Convert to json-schema
    of/fdt: Remove redundant kbasename function call
    dt-bindings: clock: Convert i.MX1 clock to json-schema
    dt-bindings: clock: Convert i.MX21 clock to json-schema
    dt-bindings: clock: Convert i.MX25 clock to json-schema
    ...

    Linus Torvalds
     

04 Jun, 2020

1 commit

  • 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
     

16 May, 2020

2 commits

  • There are 4 IRQ documentation files under Documentation/*.txt.

    Move them into a new directory (core-api/irq) and add a new
    index file for it.

    While here, use a title markup for the Debugging section of the
    irq-domain.rst file.

    Signed-off-by: Mauro Carvalho Chehab
    Link: https://lore.kernel.org/r/2da7485c3718e1442e6b4c2dd66857b776e8899b.1588345503.git.mchehab+huawei@kernel.org
    Signed-off-by: Jonathan Corbet

    Mauro Carvalho Chehab
     
  • Translate Documentation/filesystems/debugfs.txt into Chinese.

    Signed-off-by: Chucheng Luo
    Reviewed-by: Alex Shi
    Signed-off-by: Wang Wenhu
    [rebase for upstream conflict and minor change of subject]
    Link: https://lore.kernel.org/linux-doc/20200408021528.14062-1-luochucheng@vivo.com/
    Link: https://lore.kernel.org/r/20200509080535.7625-1-wenhu.wang@vivo.com
    Signed-off-by: Jonathan Corbet

    Chucheng Luo
     

05 May, 2020

2 commits

  • Translation for the following patches:

    commit c4f4af4094d6 ("docs: Add documentation for Symbol Namespaces")
    commit 36bc683dde0a ("kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers'")
    commit a035d552a93b ("Makefile: Globally enable fall-through warning")
    commit b9918bdcac1f ("Documentation/process: Add fallthrough pseudo-keyword")
    commit 58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")
    commit fb0e0ffe7fc8 ("Documentation: bring process docs up to date")
    commit 7af51678b6d3 ("docs: deprecated.rst: Add BUG()-family")
    commit 7929b9836ed0 ("docs: Remove :c:func: from process/deprecated.rst")
    commit 76136e028d3b ("docs: deprecated.rst: Clean up fall-through details")
    commit d8401f504b49 ("docs: deprecated.rst: Add %p to the list")
    commit b1735296cef9 ("docs: locking: Drop :c:func: throughout")
    commit 6adb7755996f ("docs: locking: Add 'need' to hardirq section")

    Signed-off-by: Federico Vaga
    Link: https://lore.kernel.org/r/20200430222037.4480-1-federico.vaga@vaga.pv.it
    Signed-off-by: Jonathan Corbet

    Federico Vaga
     
  • - Add a SPDX header;
    - Adjust document and section titles;
    - Mark literal blocks as such;
    - Add it to bindings/index.rst.

    Signed-off-by: Mauro Carvalho Chehab
    Signed-off-by: Rob Herring

    Mauro Carvalho Chehab
     

29 Apr, 2020

1 commit