Documentation fixes
Subsystems (45)
cover Documentation fixes
Hi Jon,
That's a bunch of files I have to be applied on the top of v5.8-rc1 fixing documentation warnings. I already removed some duplicated stuff.
Regards,
Mauro
Mauro Carvalho Chehab (29):
mm: vmalloc.c: remove a kernel-doc annotation from a removed parameter
net: dev: add a missing kernel-doc annotation
net: netdevice.h: add a description for napi_defer_hard_irqs scripts/kernel-doc: parse __ETHTOOL_DECLARE_LINK_MODE_MASK
net: pylink.h: add kernel-doc descriptions for new fields at
phylink_config
scripts/kernel-doc: handle function pointer prototypes
fs: fs.h: fix a kernel-doc parameter description
gpio: driver.h: fix kernel-doc markup
kcsan: fix a kernel-doc warning
rcu: fix some kernel-doc warnings
fs: docs: f2fs.rst: fix a broken table
dt: update a reference for reneases pcar file renamed to yaml
dt: fix broken links due to txt->yaml renames
dt: Fix broken references to renamed docs
dt: fix reference to olpc,xo1.75-ec.txt
selftests/vm/keys: fix a broken reference at protection_keys.c
docs: hugetlbpage.rst: fix some warnings
docs: powerpc: fix some issues at vas-api.rst
docs: driver-model: remove a duplicated markup at driver.rst
docs: watch_queue.rst: supress some Sphinx warnings and move to
core-api
docs: device-mapper: add dm-ebs.rst to an index file
docs: it_IT: add two missing references
docs: ABI: fix a typo when pointing to w1-generic.rst
docs: fs: locking.rst: fix a broken table
docs: add bus-virt-phys-mapping.txt to core-api
docs: fix references for DMA*.txt files
docs: dt: minor adjustments at writing-schema.rst
docs: fs: proc.rst: fix a warning due to a merge conflict
docs: fs: proc.rst: convert a new chapter to ReST
.../ABI/testing/sysfs-driver-w1_therm | 2 +-
Documentation/PCI/pci.rst | 6 +-
.../admin-guide/device-mapper/index.rst | 1 +
Documentation/admin-guide/mm/hugetlbpage.rst | 25 ++-
Documentation/block/biodoc.rst | 2 +-
.../bus-virt-phys-mapping.rst} | 2 +-
Documentation/core-api/dma-api.rst | 6 +-
Documentation/core-api/dma-isa-lpc.rst | 2 +-
Documentation/core-api/index.rst | 2 +
Documentation/{ => core-api}/watch_queue.rst | 34 ++--
.../bindings/arm/freescale/fsl,scu.txt | 2 +-
.../bindings/display/bridge/sii902x.txt | 2 +-
.../bindings/display/imx/fsl-imx-drm.txt | 4 +-
.../devicetree/bindings/display/imx/ldb.txt | 4 +-
.../display/rockchip/rockchip-drm.yaml | 2 +-
.../bindings/misc/olpc,xo1.75-ec.txt | 2 +-
.../bindings/net/mediatek-bluetooth.txt | 2 +-
.../bindings/pinctrl/renesas,pfc-pinctrl.txt | 2 +-
.../bindings/sound/audio-graph-card.txt | 2 +-
.../bindings/sound/st,sti-asoc-card.txt | 2 +-
.../bindings/spi/qcom,spi-geni-qcom.txt | 2 +-
Documentation/devicetree/writing-schema.rst | 9 +-
.../driver-api/driver-model/driver.rst | 2 -
Documentation/driver-api/usb/dma.rst | 6 +-
Documentation/filesystems/f2fs.rst | 150 ++++++++++++------
Documentation/filesystems/locking.rst | 6 +-
Documentation/filesystems/proc.rst | 46 +++---
Documentation/memory-barriers.txt | 6 +-
Documentation/mips/ingenic-tcu.rst | 2 +-
Documentation/powerpc/vas-api.rst | 23 ++-
Documentation/security/keys/core.rst | 2 +-
.../it_IT/process/management-style.rst | 2 +
.../it_IT/process/submitting-patches.rst | 2 +
.../translations/ko_KR/memory-barriers.txt | 6 +-
MAINTAINERS | 8 +-
arch/ia64/hp/common/sba_iommu.c | 12 +-
arch/parisc/kernel/pci-dma.c | 2 +-
arch/x86/include/asm/dma-mapping.h | 4 +-
arch/x86/kernel/amd_gart_64.c | 2 +-
drivers/parisc/sba_iommu.c | 14 +-
include/linux/dma-mapping.h | 2 +-
include/linux/fs.h | 2 +-
include/linux/gpio/driver.h | 2 +-
include/linux/kcsan-checks.h | 10 +-
include/linux/netdevice.h | 2 +
include/linux/phylink.h | 4 +
include/linux/rculist.h | 2 +-
include/linux/watch_queue.h | 2 +-
include/media/videobuf-dma-sg.h | 2 +-
init/Kconfig | 2 +-
kernel/dma/debug.c | 2 +-
kernel/watch_queue.c | 2 +-
mm/vmalloc.c | 1 -
net/core/dev.c | 1 +
scripts/kernel-doc | 7 +
tools/testing/selftests/vm/protection_keys.c | 2 +-
56 files changed, 282 insertions(+), 175 deletions(-)
rename Documentation/{bus-virt-phys-mapping.txt => core-api/bus-virt-phys-mapping.rst} (99%)
rename Documentation/{ => core-api}/watch_queue.rst (94%)Signature · 1 line
2.26.2
PATCH 13/29 dt: fix broken links due to txt->yaml renames
There are some new broken doc links due to yaml renames at DT. Developers should really run:
./scripts/documentation-file-ref-check
in order to solve those issues while submitting patches. This tool can even fix most of the issues with:
./scripts/documentation-file-ref-check --fix
--- Documentation/devicetree/bindings/display/bridge/sii902x.txt | 2 +- .../devicetree/bindings/display/rockchip/rockchip-drm.yaml | 2 +- Documentation/devicetree/bindings/net/mediatek-bluetooth.txt | 2 +- Documentation/devicetree/bindings/sound/audio-graph-card.txt | 2 +- Documentation/devicetree/bindings/sound/st,sti-asoc-card.txt | 2 +- Documentation/mips/ingenic-tcu.rst | 2 +- MAINTAINERS | 4 ++-- 7 files changed, 8 insertions(+), 8 deletions(-)
Documentation/devicetree/bindings/display/bridge/sii902x.txt +1 -1
@@ -37,7 +37,7 @@ Optional properties: simple-card or audio-graph-card binding. See their binding documents on how to describe the way the sii902x device is connected to the rest of the audio system: - Documentation/devicetree/bindings/sound/simple-card.txt + Documentation/devicetree/bindings/sound/simple-card.yaml Documentation/devicetree/bindings/sound/audio-graph-card.txt Note: In case of the audio-graph-card binding the used port index should be 3.
Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml +1 -1
@@ -24,7 +24,7 @@ properties: description: | Should contain a list of phandles pointing to display interface port of vop devices. vop definitions as defined in - Documentation/devicetree/bindings/display/rockchip/rockchip-vop.txt + Documentation/devicetree/bindings/display/rockchip/rockchip-vop.yaml required: - compatible
Documentation/devicetree/bindings/net/mediatek-bluetooth.txt +1 -1
@@ -3,7 +3,7 @@ MediaTek SoC built-in Bluetooth Devices This device is a serial attached device to BTIF device and thus it must be a child node of the serial node with BTIF. The dt-bindings details for BTIF -device can be known via Documentation/devicetree/bindings/serial/8250.txt. +device can be known via Documentation/devicetree/bindings/serial/8250.yaml. Required properties:
Documentation/devicetree/bindings/sound/audio-graph-card.txt +1 -1
@@ -5,7 +5,7 @@ It is based on common bindings for device graphs. see ${LINUX}/Documentation/devicetree/bindings/graph.txt Basically, Audio Graph Card property is same as Simple Card. -see ${LINUX}/Documentation/devicetree/bindings/sound/simple-card.txt +see ${LINUX}/Documentation/devicetree/bindings/sound/simple-card.yaml Below are same as Simple-Card.
Documentation/devicetree/bindings/sound/st,sti-asoc-card.txt +1 -1
@@ -5,7 +5,7 @@ codec or external codecs. sti sound drivers allows to expose sti SoC audio interface through the generic ASoC simple card. For details about sound card declaration please refer to -Documentation/devicetree/bindings/sound/simple-card.txt. +Documentation/devicetree/bindings/sound/simple-card.yaml. 1) sti-uniperiph-dai: audio dai device. ---------------------------------------
Documentation/mips/ingenic-tcu.rst +1 -1
@@ -68,4 +68,4 @@ and frameworks can be controlled from the same registers, all of these drivers access their registers through the same regmap. For more information regarding the devicetree bindings of the TCU drivers, -have a look at Documentation/devicetree/bindings/timer/ingenic,tcu.txt. +have a look at Documentation/devicetree/bindings/timer/ingenic,tcu.yaml.
MAINTAINERS +2 -2
@@ -3946,7 +3946,7 @@ L: [email protected] S: Supported F: drivers/char/hw_random/cctrng.c F: drivers/char/hw_random/cctrng.h -F: Documentation/devicetree/bindings/rng/arm-cctrng.txt +F: Documentation/devicetree/bindings/rng/arm-cctrng.yaml W: https://developer.arm.com/products/system-ip/trustzone-cryptocell/cryptocell-700-family CEC FRAMEWORK
@@ -5490,7 +5490,7 @@ F: include/uapi/drm/r128_drm.h DRM DRIVER FOR RAYDIUM RM67191 PANELS M: Robert Chiras <[email protected]> S: Maintained -F: Documentation/devicetree/bindings/display/panel/raydium,rm67191.txt +F: Documentation/devicetree/bindings/display/panel/raydium,rm67191.yaml F: drivers/gpu/drm/panel/panel-raydium-rm67191.c DRM DRIVER FOR ROCKTECH JH057N00900 PANELS
Signature · 1 line
2.26.2
PATCH 20/29 docs: watch_queue.rst: supress some Sphinx warnings and move to core-api
In reply to Mauro Carvalho ChehabSphinx doesn't like multi-line literal blocks with ``foobar``:
Documentation/watch_queue.rst:109: WARNING: Inline literal start-string without end-string. Documentation/watch_queue.rst:109: WARNING: Inline emphasis start-string without end-string. Documentation/watch_queue.rst:109: WARNING: Inline emphasis start-string without end-string. Documentation/watch_queue.rst:109: WARNING: Inline emphasis start-string without end-string. Documentation/watch_queue.rst:186: WARNING: Inline literal start-string without end-string. Documentation/watch_queue.rst:186: WARNING: Inline emphasis start-string without end-string. Documentation/watch_queue.rst:185: WARNING: Inline emphasis start-string without end-string.
So, let's use the "::" markup instead.
While we could do the fix only at the affected lines, let's do the same change along the entire file, in order to preserve the same look and feel at the entire doc.
---
Documentation/core-api/index.rst | 1 +
Documentation/{ => core-api}/watch_queue.rst | 34 ++++++++++++++------
Documentation/security/keys/core.rst | 2 +-
include/linux/watch_queue.h | 2 +-
init/Kconfig | 2 +-
kernel/watch_queue.c | 2 +-
6 files changed, 30 insertions(+), 13 deletions(-)
rename Documentation/{ => core-api}/watch_queue.rst (94%)Documentation/core-api/index.rst +1 -0
@@ -40,6 +40,7 @@ Library functionality that is used throughout the kernel. generic-radix-tree packing timekeeping + watch_queue errseq Concurrency primitives
Documentation/core-api/watch_queue.rst renamed from Documentation/watch_queue.rst +25 -9
@@ -103,15 +103,19 @@ watch that specific key). To manage a watch list, the following functions are provided: - * ``void init_watch_list(struct watch_list *wlist, - void (*release_watch)(struct watch *wlist));`` + * :: + + void init_watch_list(struct watch_list *wlist, + void (*release_watch)(struct watch *wlist)); Initialise a watch list. If ``release_watch`` is not NULL, then this indicates a function that should be called when the watch_list object is destroyed to discard any references the watch list holds on the watched object. - * ``void remove_watch_list(struct watch_list *wlist);`` + * :: + + void remove_watch_list(struct watch_list *wlist); This removes all of the watches subscribed to a watch_list and frees them and then destroys the watch_list object itself.
@@ -125,14 +129,18 @@ records will be written into. The workings of this are hidden entirely inside of the pipe device driver, but it is necessary to gain a reference to it to set a watch. These can be managed with: - * ``struct watch_queue *get_watch_queue(int fd);`` + * :: + + struct watch_queue *get_watch_queue(int fd);`` Since watch queues are indicated to the kernel by the fd of the pipe that implements the buffer, userspace must hand that fd through a system call. This can be used to look up an opaque pointer to the watch queue from the system call. - * ``void put_watch_queue(struct watch_queue *wqueue);`` + * :: + + void put_watch_queue(struct watch_queue *wqueue); This discards the reference obtained from ``get_watch_queue()``.
@@ -168,18 +176,24 @@ different ID are ignored. The following functions are provided to manage watches: - * ``void init_watch(struct watch *watch, struct watch_queue *wqueue);`` + * :: + + void init_watch(struct watch *watch, struct watch_queue *wqueue); Initialise a watch object, setting its pointer to the watch queue, using appropriate barriering to avoid lockdep complaints. - * ``int add_watch_to_object(struct watch *watch, struct watch_list *wlist);`` + * :: + + int add_watch_to_object(struct watch *watch, struct watch_list *wlist); Subscribe a watch to a watch list (notification source). The driver-settable fields in the watch struct must have been set before this is called. - * ``int remove_watch_from_object(struct watch_list *wlist, + * :: + + int remove_watch_from_object(struct watch_list *wlist, struct watch_queue *wqueue, u64 id, false);``
@@ -188,7 +202,9 @@ The following functions are provided to manage watches: (``WATCH_META_REMOVAL_NOTIFICATION``) is sent to the watch queue to indicate that the watch got removed. - * ``int remove_watch_from_object(struct watch_list *wlist, NULL, 0, true);`` + * :: + + int remove_watch_from_object(struct watch_list *wlist, NULL, 0, true); Remove all the watches from a watch list. It is expected that this will be called preparatory to destruction and that the watch list will be
Documentation/security/keys/core.rst +1 -1
@@ -1046,7 +1046,7 @@ The keyctl syscall functions are: "filter" is either NULL to remove a watch or a filter specification to indicate what events are required from the key. - See Documentation/watch_queue.rst for more information. + See Documentation/core-api/watch_queue.rst for more information. Note that only one watch may be emplaced for any particular { key, queue_fd } combination.
include/linux/watch_queue.h +1 -1
@@ -4,7 +4,7 @@* Copyright (C) 2020 Red Hat, Inc. All Rights Reserved. * Written by David Howells ([email protected]) * -* See Documentation/watch_queue.rst +* See Documentation/core-api/watch_queue.rst */ #ifndef _LINUX_WATCH_QUEUE_H
init/Kconfig +1 -1
@@ -377,7 +377,7 @@ config WATCH_QUEUE with watches for key/keyring change notifications and device notifications. - See Documentation/watch_queue.rst + See Documentation/core-api/watch_queue.rst config CROSS_MEMORY_ATTACH bool "Enable process_vm_readv/writev syscalls"
kernel/watch_queue.c +1 -1
@@ -4,7 +4,7 @@* Copyright (C) 2020 Red Hat, Inc. All Rights Reserved. * Written by David Howells ([email protected]) * -* See Documentation/watch_queue.rst +* See Documentation/core-api/watch_queue.rst */ #define pr_fmt (fmt) "watchq: " fmt
Signature · 1 line
2.26.2
PATCH 21/29 docs: device-mapper: add dm-ebs.rst to an index file
In reply to Mauro Carvalho ChehabSolves this Sphinx warning:
Documentation/admin-guide/device-mapper/dm-ebs.rst: WARNING: document isn't included in any toctree
--- Documentation/admin-guide/device-mapper/index.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/admin-guide/device-mapper/index.rst +1 -0
@@ -11,6 +11,7 @@ Device Mapper dm-clone dm-crypt dm-dust + dm-ebs dm-flakey dm-init dm-integrity
Signature · 1 line
2.26.2
PATCH 26/29 docs: fix references for DMA*.txt files
In reply to Mauro Carvalho ChehabAs we moved those files to core-api, fix references to point to their newer locations.
--- Documentation/PCI/pci.rst | 6 +++--- Documentation/block/biodoc.rst | 2 +- Documentation/core-api/bus-virt-phys-mapping.rst | 2 +- Documentation/core-api/dma-api.rst | 6 +++--- Documentation/core-api/dma-isa-lpc.rst | 2 +- Documentation/driver-api/usb/dma.rst | 6 +++--- Documentation/memory-barriers.txt | 6 +++--- .../translations/ko_KR/memory-barriers.txt | 6 +++--- arch/ia64/hp/common/sba_iommu.c | 12 ++++++------ arch/parisc/kernel/pci-dma.c | 2 +- arch/x86/include/asm/dma-mapping.h | 4 ++-- arch/x86/kernel/amd_gart_64.c | 2 +- drivers/parisc/sba_iommu.c | 14 +++++++------- include/linux/dma-mapping.h | 2 +- include/media/videobuf-dma-sg.h | 2 +- kernel/dma/debug.c | 2 +- 16 files changed, 38 insertions(+), 38 deletions(-)
Documentation/PCI/pci.rst +3 -3
@@ -265,7 +265,7 @@ Set the DMA mask size --------------------- .. note:: If anything below doesn't make sense, please refer to - Documentation/DMA-API.txt. This section is just a reminder that + :doc:`/core-api/dma-api`. This section is just a reminder that drivers need to indicate DMA capabilities of the device and is not an authoritative source for DMA interfaces.
@@ -291,7 +291,7 @@ Many 64-bit "PCI" devices (before PCI-X) and some PCI-X devices are Setup shared control data ------------------------- Once the DMA masks are set, the driver can allocate "consistent" (a.k.a. shared) -memory. See Documentation/DMA-API.txt for a full description of +memory. See :doc:`/core-api/dma-api` for a full description of the DMA APIs. This section is just a reminder that it needs to be done before enabling DMA on the device.
@@ -421,7 +421,7 @@ owners if there is one. Then clean up "consistent" buffers which contain the control data. -See Documentation/DMA-API.txt for details on unmapping interfaces. +See :doc:`/core-api/dma-api` for details on unmapping interfaces. Unregister from other subsystems
Documentation/block/biodoc.rst +1 -1
@@ -196,7 +196,7 @@ a virtual address mapping (unlike the earlier scheme of virtual address do not have a corresponding kernel virtual address space mapping) and low-memory pages. -Note: Please refer to Documentation/DMA-API-HOWTO.txt for a discussion +Note: Please refer to :doc:`/core-api/dma-api-howto` for a discussion on PCI high mem DMA aspects and mapping of scatter gather lists, and support for 64 bit PCI.
Documentation/core-api/bus-virt-phys-mapping.rst +1 -1
@@ -8,7 +8,7 @@ How to access I/O mapped memory from within device drivers The virt_to_bus() and bus_to_virt() functions have been superseded by the functionality provided by the PCI DMA interface - (see Documentation/DMA-API-HOWTO.txt). They continue + (see :doc:`/core-api/dma-api-howto`). They continue to be documented below for historical purposes, but new code must not use them. --davidm 00/12/12
Documentation/core-api/dma-api.rst +3 -3
@@ -5,7 +5,7 @@ Dynamic DMA mapping using the generic device :Author: James E.J. Bottomley <[email protected]> This document describes the DMA API. For a more gentle introduction -of the API (and actual examples), see Documentation/DMA-API-HOWTO.txt. +of the API (and actual examples), see :doc:`/core-api/dma-api-howto`. This API is split into two pieces. Part I describes the basic API. Part II describes extensions for supporting non-consistent memory
@@ -471,7 +471,7 @@ without the _attrs suffixes, except that they pass an optional dma_attrs. The interpretation of DMA attributes is architecture-specific, and -each attribute should be documented in Documentation/DMA-attributes.txt. +each attribute should be documented in :doc:`/core-api/dma-attributes`. If dma_attrs are 0, the semantics of each of these functions is identical to those of the corresponding function
@@ -484,7 +484,7 @@ for DMA:: #include <linux/dma-mapping.h> /* DMA_ATTR_FOO should be defined in linux/dma-mapping.h and - * documented in Documentation/DMA-attributes.txt */ + * documented in Documentation/core-api/dma-attributes.rst */ ... unsigned long attr;
Documentation/core-api/dma-isa-lpc.rst +1 -1
@@ -17,7 +17,7 @@ To do ISA style DMA you need to include two headers:: #include <asm/dma.h> The first is the generic DMA API used to convert virtual addresses to -bus addresses (see Documentation/DMA-API.txt for details). +bus addresses (see :doc:`/core-api/dma-api` for details). The second contains the routines specific to ISA DMA transfers. Since this is not present on all platforms make sure you construct your
Documentation/driver-api/usb/dma.rst +3 -3
@@ -10,7 +10,7 @@ API overview The big picture is that USB drivers can continue to ignore most DMA issues, though they still must provide DMA-ready buffers (see -``Documentation/DMA-API-HOWTO.txt``). That's how they've worked through +:doc:`/core-api/dma-api-howto`). That's how they've worked through the 2.4 (and earlier) kernels, or they can now be DMA-aware. DMA-aware usb drivers:
@@ -60,7 +60,7 @@ and effects like cache-trashing can impose subtle penalties. force a consistent memory access ordering by using memory barriers. It's not using a streaming DMA mapping, so it's good for small transfers on systems where the I/O would otherwise thrash an IOMMU mapping. (See - ``Documentation/DMA-API-HOWTO.txt`` for definitions of "coherent" and + :doc:`/core-api/dma-api-howto` for definitions of "coherent" and "streaming" DMA mappings.) Asking for 1/Nth of a page (as well as asking for N pages) is reasonably
@@ -91,7 +91,7 @@ Working with existing buffers Existing buffers aren't usable for DMA without first being mapped into the DMA address space of the device. However, most buffers passed to your driver can safely be used with such DMA mapping. (See the first section -of Documentation/DMA-API-HOWTO.txt, titled "What memory is DMA-able?") +of :doc:`/core-api/dma-api-howto`, titled "What memory is DMA-able?") - When you're using scatterlists, you can map everything at once. On some systems, this kicks in an IOMMU and turns the scatterlists into single
Documentation/memory-barriers.txt +3 -3
@@ -546,8 +546,8 @@ There are certain things that the Linux kernel memory barriers do not guarantee: [*] For information on bus mastering DMA and coherency please read: Documentation/driver-api/pci/pci.rst - Documentation/DMA-API-HOWTO.txt - Documentation/DMA-API.txt + Documentation/core-api/dma-api-howto.rst + Documentation/core-api/dma-api.rst DATA DEPENDENCY BARRIERS (HISTORICAL)
@@ -1932,7 +1932,7 @@ There are some more advanced barrier functions: here. See the subsection "Kernel I/O barrier effects" for more information on - relaxed I/O accessors and the Documentation/DMA-API.txt file for more + relaxed I/O accessors and the Documentation/core-api/dma-api.rst file for more information on consistent memory.
Documentation/translations/ko_KR/memory-barriers.txt +3 -3
@@ -570,8 +570,8 @@ ACQUIRE 는 해당 오퍼레이션의 로드 부분에만 적용되고 RELEASE [*] 버스 마스터링 DMA 와 일관성에 대해서는 다음을 참고하시기 바랍니다: Documentation/driver-api/pci/pci.rst - Documentation/DMA-API-HOWTO.txt - Documentation/DMA-API.txt + Documentation/core-api/dma-api-howto.rst + Documentation/core-api/dma-api.rst 데이터 의존성 배리어 (역사적)
@@ -1907,7 +1907,7 @@ Mandatory 배리어들은 SMP 시스템에서도 UP 시스템에서도 SMP 효 writel_relaxed() 와 같은 완화된 I/O 접근자들에 대한 자세한 내용을 위해서는 "커널 I/O 배리어의 효과" 섹션을, consistent memory 에 대한 자세한 내용을 - 위해선 Documentation/DMA-API.txt 문서를 참고하세요. + 위해선 Documentation/core-api/dma-api.rst 문서를 참고하세요. =========================
arch/ia64/hp/common/sba_iommu.c +6 -6
@@ -907,7 +907,7 @@ sba_mark_invalid(struct ioc *ioc, dma_addr_t iova, size_t byte_cnt)* @dir: dma direction * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static dma_addr_t sba_map_page(struct device *dev, struct page *page, unsigned long poff, size_t size,
@@ -1028,7 +1028,7 @@ sba_mark_clean(struct ioc *ioc, dma_addr_t iova, size_t size)* @dir: R/W or both. * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void sba_unmap_page (struct device *dev,dma_addr_t iova,size_t size,enum dma_data_direction dir,unsigned long attrs)
@@ -1105,7 +1105,7 @@ static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,* @size: number of bytes mapped in driver buffer. * @dma_handle: IOVA of new buffer. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void * sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,
@@ -1162,7 +1162,7 @@ sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,* @vaddr: virtual address IOVA of "consistent" buffer. * @dma_handler: IO virtual address of "consistent" buffer. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void sba_free_coherent (struct device *dev,size_t size,void *vaddr,dma_addr_t dma_handle,unsigned long attrs)
@@ -1425,7 +1425,7 @@ static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist,* @dir: R/W or both. * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist, int nents, enum dma_data_direction dir,
@@ -1524,7 +1524,7 @@ static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist,* @dir: R/W or both. * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist, int nents, enum dma_data_direction dir,
arch/parisc/kernel/pci-dma.c +1 -1
@@ -3,7 +3,7 @@ ** PARISC 1.1 Dynamic DMA mapping support. ** This implementation is for PA-RISC platforms that do not support ** I/O TLBs (aka DMA address translation hardware). -** See Documentation/DMA-API-HOWTO.txt for interface definitions. +** See Documentation/core-api/dma-api-howto.rst for interface definitions. ** ** (c) Copyright 1999,2000 Hewlett-Packard Company ** (c) Copyright 2000 Grant Grundler
arch/x86/include/asm/dma-mapping.h +2 -2
@@ -3,8 +3,8 @@#define _ASM_X86_DMA_MAPPING_H/* -* IOMMU interface. See Documentation/DMA-API-HOWTO.txt and -* Documentation/DMA-API.txt for documentation. +* IOMMU interface. See Documentation/core-api/dma-api-howto.rst and +* Documentation/core-api/dma-api.rst for documentation. */ #include <linux/scatterlist.h>
arch/x86/kernel/amd_gart_64.c +1 -1
@@ -6,7 +6,7 @@* This allows to use PCI devices that only support 32bit addresses on systems * with more than 4GB. * -* See Documentation/DMA-API-HOWTO.txt for the interface specification. +* See Documentation/core-api/dma-api-howto.rst for the interface specification. * * Copyright 2002 Andi Kleen, SuSE Labs. */
drivers/parisc/sba_iommu.c +7 -7
@@ -666,7 +666,7 @@ sba_mark_invalid(struct ioc *ioc, dma_addr_t iova, size_t byte_cnt)* @dev: instance of PCI owned by the driver that's asking * @mask: number of address bits this PCI device can handle * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static int sba_dma_supported (struct device *dev,u64 mask) {
@@ -698,7 +698,7 @@ static int sba_dma_supported( struct device *dev, u64 mask)* @size: number of bytes to map in driver buffer. * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static dma_addr_t sba_map_single(struct device *dev, void *addr, size_t size,
@@ -788,7 +788,7 @@ sba_map_page(struct device *dev, struct page *page, unsigned long offset,* @size: number of bytes mapped in driver buffer. * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,
@@ -867,7 +867,7 @@ sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,* @size: number of bytes mapped in driver buffer. * @dma_handle: IOVA of new buffer. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void *sba_alloc (struct device *hwdev,size_t size,dma_addr_t *dma_handle,gfp_t gfp,unsigned long attrs)
@@ -898,7 +898,7 @@ static void *sba_alloc(struct device *hwdev, size_t size, dma_addr_t *dma_handle* @vaddr: virtual address IOVA of "consistent" buffer. * @dma_handler: IO virtual address of "consistent" buffer. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void sba_free(struct device *hwdev, size_t size, void *vaddr,
@@ -933,7 +933,7 @@ int dump_run_sg = 0;* @nents: number of entries in list * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static int sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents,
@@ -1017,7 +1017,7 @@ sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents,* @nents: number of entries in list * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void sba_unmap_sg(struct device *dev, struct scatterlist *sglist, int nents,
include/linux/dma-mapping.h +1 -1
@@ -14,7 +14,7 @@/** * List of possible attributes associated with a DMA mapping. The semantics -* of each attribute should be defined in Documentation/DMA-attributes.txt. +* of each attribute should be defined in Documentation/core-api/dma-attributes.rst. */ /*
include/media/videobuf-dma-sg.h +1 -1
@@ -31,7 +31,7 @@* does memory allocation too using vmalloc_32(). * * videobuf_dma_*() -* see Documentation/DMA-API-HOWTO.txt, these functions to +* see Documentation/core-api/dma-api-howto.rst, these functions to * basically the same. The map function does also build a * scatterlist for the buffer (and unmap frees it ...) *
kernel/dma/debug.c +1 -1
@@ -1071,7 +1071,7 @@ static void check_unmap(struct dma_debug_entry *ref)/* * Drivers should use dma_mapping_error() to check the returned * addresses of dma_map_single() and dma_map_page(). -* If not, print this warning message. See Documentation/DMA-API.txt. +* If not, print this warning message. See Documentation/core-api/dma-api.rst. */ if (entry->map_err_type ==MAP_ERR_NOT_CHECKED ) { err_printk(ref->dev, entry,
Signature · 1 line
2.26.2
PATCH 1/29 mm: vmalloc.c: remove a kernel-doc annotation from a removed parameter
In reply to Mauro Carvalho ChehabThe prot argument was removed. Drop it als from the kernel-doc markup.
--- mm/vmalloc.c | 1 - 1 file changed, 1 deletion(-)
mm/vmalloc.c +0 -1
@@ -1862,7 +1862,6 @@ EXPORT_SYMBOL(vm_unmap_ram);* @pages: an array of pointers to the pages to be mapped * @count: number of pages * @node: prefer to allocate data structures on this node -* @prot: memory protection to use. PAGE_KERNEL for regular RAM * * If you use this function for less than VMAP_MAX_ALLOC pages, it could be * faster than vmap so it's good. But if you mix long-life and short-life
Signature · 1 line
2.26.2
PATCH 2/29 net: dev: add a missing kernel-doc annotation
In reply to Mauro Carvalho ChehabThe dev argument was not listed at kernel-doc markup:
./net/core/dev.c:7878: warning: Function parameter or member 'dev' not described in 'netdev_get_xmit_slave'
--- net/core/dev.c | 1 + 1 file changed, 1 insertion(+)
net/core/dev.c +1 -0
@@ -7898,6 +7898,7 @@ EXPORT_SYMBOL(netdev_bonding_info_change);/** * netdev_get_xmit_slave - Get the xmit slave of master device +* @dev: device * @skb: The packet * @all_slaves: assume all the slaves are active *
Signature · 1 line
2.26.2
PATCH 17/29 docs: hugetlbpage.rst: fix some warnings
In reply to Mauro Carvalho ChehabSome new command line parameters were added at hugetlbpage.rst. Adjust them in order to properly parse that part of the file, avoiding those warnings:
Documentation/admin-guide/mm/hugetlbpage.rst:105: WARNING: Unexpected indentation. Documentation/admin-guide/mm/hugetlbpage.rst:108: WARNING: Unexpected indentation. Documentation/admin-guide/mm/hugetlbpage.rst:109: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/admin-guide/mm/hugetlbpage.rst:112: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/admin-guide/mm/hugetlbpage.rst:120: WARNING: Unexpected indentation. Documentation/admin-guide/mm/hugetlbpage.rst:121: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/admin-guide/mm/hugetlbpage.rst:132: WARNING: Unexpected indentation. Documentation/admin-guide/mm/hugetlbpage.rst:135: WARNING: Block quote ends without a blank line; unexpected unindent.
--- Documentation/admin-guide/mm/hugetlbpage.rst | 25 ++++++++++++++------ 1 file changed, 18 insertions(+), 7 deletions(-)
Documentation/admin-guide/mm/hugetlbpage.rst +18 -7
@@ -100,38 +100,49 @@ with a huge page size selection parameter "hugepagesz=<size>". <size> must be specified in bytes with optional scale suffix [kKmMgG]. The default huge page size may be selected with the "default_hugepagesz=<size>" boot parameter. -Hugetlb boot command line parameter semantics -hugepagesz - Specify a huge page size. Used in conjunction with hugepages +Hugetlb + boot command line parameter semantics +hugepagesz + Specify a huge page size. Used in conjunction with hugepages parameter to preallocate a number of huge pages of the specified size. Hence, hugepagesz and hugepages are typically specified in - pairs such as: + pairs such as:: + hugepagesz=2M hugepages=512 + hugepagesz can only be specified once on the command line for a specific huge page size. Valid huge page sizes are architecture dependent. -hugepages - Specify the number of huge pages to preallocate. This typically +hugepages + Specify the number of huge pages to preallocate. This typically follows a valid hugepagesz or default_hugepagesz parameter. However, if hugepages is the first or only hugetlb command line parameter it implicitly specifies the number of huge pages of default size to allocate. If the number of huge pages of default size is implicitly specified, it can not be overwritten by a hugepagesz,hugepages parameter pair for the default size. - For example, on an architecture with 2M default huge page size: + + For example, on an architecture with 2M default huge page size:: + hugepages=256 hugepagesz=2M hugepages=512 + will result in 256 2M huge pages being allocated and a warning message indicating that the hugepages=512 parameter is ignored. If a hugepages parameter is preceded by an invalid hugepagesz parameter, it will be ignored. -default_hugepagesz - Specify the default huge page size. This parameter can +default_hugepagesz + pecify the default huge page size. This parameter can only be specified once on the command line. default_hugepagesz can optionally be followed by the hugepages parameter to preallocate a specific number of huge pages of default size. The number of default sized huge pages to preallocate can also be implicitly specified as mentioned in the hugepages section above. Therefore, on an - architecture with 2M default huge page size: + architecture with 2M default huge page size:: + hugepages=256 default_hugepagesz=2M hugepages=256 hugepages=256 default_hugepagesz=2M + will all result in 256 2M huge pages being allocated. Valid default huge page size is architecture dependent.
Signature · 1 line
2.26.2
PATCH 14/29 dt: Fix broken references to renamed docs
In reply to Mauro Carvalho ChehabSome files got renamed. Those were all fixed automatically by
./scripts/documentation-file-ref-check --fix
--- Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt | 2 +- Documentation/devicetree/bindings/display/imx/fsl-imx-drm.txt | 4 ++-- Documentation/devicetree/bindings/display/imx/ldb.txt | 4 ++-- Documentation/devicetree/bindings/spi/qcom,spi-geni-qcom.txt | 2 +- MAINTAINERS | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-)
Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt +1 -1
@@ -47,7 +47,7 @@ Required properties: &lsio_mu1 1 2 &lsio_mu1 1 3 &lsio_mu1 3 3>; - See Documentation/devicetree/bindings/mailbox/fsl,mu.txt + See Documentation/devicetree/bindings/mailbox/fsl,mu.yaml for detailed mailbox binding. Note: Each mu which supports general interrupt should have an alias correctly
Documentation/devicetree/bindings/display/imx/fsl-imx-drm.txt +2 -2
@@ -68,7 +68,7 @@ Required properties: datasheet - clocks : phandle to the PRE axi clock input, as described in Documentation/devicetree/bindings/clock/clock-bindings.txt and - Documentation/devicetree/bindings/clock/imx6q-clock.txt. + Documentation/devicetree/bindings/clock/imx6q-clock.yaml. - clock-names: should be "axi" - interrupts: should contain the PRE interrupt - fsl,iram: phandle pointing to the mmio-sram device node, that should be
@@ -94,7 +94,7 @@ Required properties: datasheet - clocks : phandles to the PRG ipg and axi clock inputs, as described in Documentation/devicetree/bindings/clock/clock-bindings.txt and - Documentation/devicetree/bindings/clock/imx6q-clock.txt. + Documentation/devicetree/bindings/clock/imx6q-clock.yaml. - clock-names: should be "ipg" and "axi" - fsl,pres: phandles to the PRE units attached to this PRG, with the fixed PRE as the first entry and the muxable PREs following.
Documentation/devicetree/bindings/display/imx/ldb.txt +2 -2
@@ -30,8 +30,8 @@ Required properties: "di2_sel" - IPU2 DI0 mux "di3_sel" - IPU2 DI1 mux The needed clock numbers for each are documented in - Documentation/devicetree/bindings/clock/imx5-clock.txt, and in - Documentation/devicetree/bindings/clock/imx6q-clock.txt. + Documentation/devicetree/bindings/clock/imx5-clock.yaml, and in + Documentation/devicetree/bindings/clock/imx6q-clock.yaml. Optional properties: - pinctrl-names : should be "default" on i.MX53, not used on i.MX6q
Documentation/devicetree/bindings/spi/qcom,spi-geni-qcom.txt +1 -1
@@ -19,7 +19,7 @@ Required properties: SPI Controller nodes must be child of GENI based Qualcomm Universal Peripharal. Please refer GENI based QUP wrapper controller node bindings -described in Documentation/devicetree/bindings/soc/qcom/qcom,geni-se.txt. +described in Documentation/devicetree/bindings/soc/qcom/qcom,geni-se.yaml. SPI slave nodes must be children of the SPI master node and conform to SPI bus binding as described in Documentation/devicetree/bindings/spi/spi-bus.txt.
MAINTAINERS +2 -2
@@ -14561,8 +14561,8 @@ RENESAS R-CAR THERMAL DRIVERS M: Niklas Söderlund <[email protected]> L: [email protected] S: Supported -F: Documentation/devicetree/bindings/thermal/rcar-gen3-thermal.txt -F: Documentation/devicetree/bindings/thermal/rcar-thermal.txt +F: Documentation/devicetree/bindings/thermal/rcar-gen3-thermal.yaml +F: Documentation/devicetree/bindings/thermal/rcar-thermal.yaml F: drivers/thermal/rcar_gen3_thermal.c F: drivers/thermal/rcar_thermal.c
Signature · 7 lines
2.26.2 _______________________________________________ linux-arm-kernel mailing list [email protected] http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
PATCH 10/29 rcu: fix some kernel-doc warnings
In reply to Mauro Carvalho ChehabThere are some kernel-doc warnings:
./kernel/rcu/tree.c:2915: warning: Function parameter or member 'count' not described in 'kfree_rcu_cpu'
./include/linux/rculist.h:517: warning: bad line: [@right ][node2 ... ]
./include/linux/rculist.h:2: WARNING: Unexpected indentation.
Move the comment for "count" to the kernel-doc markup and add a missing "*" on one kernel-doc continuation line.
--- include/linux/rculist.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/rculist.h +1 -1
@@ -512,7 +512,7 @@ static inline void hlist_replace_rcu(struct hlist_node *old,* @right: The hlist head on the right * * The lists start out as [@left ][node1 ... ] and -[@right ][node2 ... ] +* [@right ][node2 ... ] * The lists end up as [@left ][node2 ... ] * [@right ][node1 ... ] */
Signature · 1 line
2.26.2
PATCH 6/29 scripts/kernel-doc: handle function pointer prototypes
In reply to Mauro Carvalho ChehabThere are some function pointer prototypes inside the net includes, like this one:
int (*pcs_config)(struct phylink_config *config, unsigned int mode, phy_interface_t interface, const unsigned long *advertising);
There's nothing wrong using it with kernel-doc, but we need to add a rule for it to parse such kind of prototype.
--- scripts/kernel-doc | 5 +++++ 1 file changed, 5 insertions(+)
scripts/kernel-doc +5 -0
@@ -1771,6 +1771,11 @@ sub process_proto_function($$) { $prototype =~ s@/\*.*?\*/@@gos; # strip comments. $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's. $prototype =~ s@^\s+@@gos; # strip leading spaces + + # Handle prototypes for function pointers like: + # int (*pcs_config)(struct foo) + $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos; + if ($prototype =~ /SYSCALL_DEFINE/) { syscall_munge(); }
Signature · 1 line
2.26.2
PATCH 11/29 fs: docs: f2fs.rst: fix a broken table
In reply to Mauro Carvalho ChehabAs reported by Sphinx:
Documentation/filesystems/f2fs.rst:229: WARNING: Malformed table. Text in column margin in table line 126.
====================== ============================================================
background_gc=%s Turn on/off cleaning operations, namely garbage
...
test_dummy_encryption
test_dummy_encryption=%s
Enable dummy encryption, which provides a fake fscrypt context. The fake fscrypt context is used by xfstests. The argument may be either "v1" or "v2", in order to select the corresponding fscrypt policy version.
This table is now broken, as some texts are bigger than a column. While it would be feasible to fix it by adding two extra positions at the table, it would still output something wrong, as "test_dummy_encryption" would appear on a separate row.
So, the best solution here seems to remove the table markup.
The html and PDF output won't be as nice as a table, but it will still be reasonable.
--- Documentation/filesystems/f2fs.rst | 150 +++++++++++++++++++---------- 1 file changed, 98 insertions(+), 52 deletions(-)
Documentation/filesystems/f2fs.rst +98 -52
@@ -101,8 +101,8 @@ Mount Options ============= -====================== ============================================================ -background_gc=%s Turn on/off cleaning operations, namely garbage +background_gc=%s + Turn on/off cleaning operations, namely garbage collection, triggered in background when I/O subsystem is idle. If background_gc=on, it will turn on the garbage collection and if background_gc=off, garbage collection
@@ -110,65 +110,91 @@ background_gc=%s Turn on/off cleaning operations, namely garbage on synchronous garbage collection running in background. Default value for this option is on. So garbage collection is on by default. -disable_roll_forward Disable the roll-forward recovery routine -norecovery Disable the roll-forward recovery routine, mounted read- +disable_roll_forward + Disable the roll-forward recovery routine +norecovery + Disable the roll-forward recovery routine, mounted read- only (i.e., -o ro,disable_roll_forward) -discard/nodiscard Enable/disable real-time discard in f2fs, if discard is +discard/nodiscard + Enable/disable real-time discard in f2fs, if discard is enabled, f2fs will issue discard/TRIM commands when a segment is cleaned. -no_heap Disable heap-style segment allocation which finds free +no_heap + Disable heap-style segment allocation which finds free segments for data from the beginning of main area, while for node from the end of main area. -nouser_xattr Disable Extended User Attributes. Note: xattr is enabled +nouser_xattr + Disable Extended User Attributes. Note: xattr is enabled by default if CONFIG_F2FS_FS_XATTR is selected. -noacl Disable POSIX Access Control List. Note: acl is enabled +noacl + Disable POSIX Access Control List. Note: acl is enabled by default if CONFIG_F2FS_FS_POSIX_ACL is selected. -active_logs=%u Support configuring the number of active logs. In the +active_logs=%u + Support configuring the number of active logs. In the current design, f2fs supports only 2, 4, and 6 logs. Default number is 6. -disable_ext_identify Disable the extension list configured by mkfs, so f2fs +disable_ext_identify + Disable the extension list configured by mkfs, so f2fs does not aware of cold files such as media files. -inline_xattr Enable the inline xattrs feature. -noinline_xattr Disable the inline xattrs feature. -inline_xattr_size=%u Support configuring inline xattr size, it depends on +inline_xattr + Enable the inline xattrs feature. +noinline_xattr + Disable the inline xattrs feature. +inline_xattr_size=%u + Support configuring inline xattr size, it depends on flexible inline xattr feature. -inline_data Enable the inline data feature: New created small(<~3.4k) +inline_data + Enable the inline data feature: New created small(<~3.4k) files can be written into inode block. -inline_dentry Enable the inline dir feature: data in new created +inline_dentry + Enable the inline dir feature: data in new created directory entries can be written into inode block. The space of inode block which is used to store inline dentries is limited to ~3.4k. -noinline_dentry Disable the inline dentry feature. -flush_merge Merge concurrent cache_flush commands as much as possible +noinline_dentry + Disable the inline dentry feature. +flush_merge + Merge concurrent cache_flush commands as much as possible to eliminate redundant command issues. If the underlying device handles the cache_flush command relatively slowly, recommend to enable this option. -nobarrier This option can be used if underlying storage guarantees +nobarrier + This option can be used if underlying storage guarantees its cached data should be written to the novolatile area. If this option is set, no cache_flush commands are issued but f2fs still guarantees the write ordering of all the data writes. -fastboot This option is used when a system wants to reduce mount +fastboot + This option is used when a system wants to reduce mount time as much as possible, even though normal performance can be sacrificed. -extent_cache Enable an extent cache based on rb-tree, it can cache +extent_cache + Enable an extent cache based on rb-tree, it can cache as many as extent which map between contiguous logical address and physical address per inode, resulting in increasing the cache hit ratio. Set by default. -noextent_cache Disable an extent cache based on rb-tree explicitly, see +noextent_cache + Disable an extent cache based on rb-tree explicitly, see the above extent_cache mount option. -noinline_data Disable the inline data feature, inline data feature is +noinline_data + Disable the inline data feature, inline data feature is enabled by default. -data_flush Enable data flushing before checkpoint in order to +data_flush + Enable data flushing before checkpoint in order to persist data of regular and symlink. -reserve_root=%d Support configuring reserved space which is used for +reserve_root=%d + Support configuring reserved space which is used for allocation from a privileged user with specified uid or gid, unit: 4KB, the default limit is 0.2% of user blocks. -resuid=%d The user ID which may use the reserved blocks. -resgid=%d The group ID which may use the reserved blocks. -fault_injection=%d Enable fault injection in all supported types with +resuid=%d + The user ID which may use the reserved blocks. +resgid=%d + The group ID which may use the reserved blocks. +fault_injection=%d + Enable fault injection in all supported types with specified injection rate. -fault_type=%d Support configuring fault injection type, should be +fault_type=%d + Support configuring fault injection type, should be enabled with fault_injection option, fault type value is shown below, it supports single or combined type.
@@ -191,32 +217,49 @@ fault_type=%d Support configuring fault injection type, should be FAULT_DISCARD 0x000002000 FAULT_WRITE_IO 0x000004000 =================== =========== -mode=%s Control block allocation mode which supports "adaptive" +mode=%s + Control block allocation mode which supports "adaptive" and "lfs". In "lfs" mode, there should be no random writes towards main area. -io_bits=%u Set the bit size of write IO requests. It should be set +io_bits=%u + Set the bit size of write IO requests. It should be set with "mode=lfs". -usrquota Enable plain user disk quota accounting. -grpquota Enable plain group disk quota accounting. -prjquota Enable plain project quota accounting. -usrjquota=<file> Appoint specified file and type during mount, so that quota -grpjquota=<file> information can be properly updated during recovery flow, -prjjquota=<file> <quota file>: must be in root directory; -jqfmt=<quota type> <quota type>: [vfsold,vfsv0,vfsv1]. -offusrjquota Turn off user journelled quota. -offgrpjquota Turn off group journelled quota. -offprjjquota Turn off project journelled quota. -quota Enable plain user disk quota accounting. -noquota Disable all plain disk quota option. -whint_mode=%s Control which write hints are passed down to block +usrquota + Enable plain user disk quota accounting. +grpquota + Enable plain group disk quota accounting. +prjquota + Enable plain project quota accounting. +usrjquota=<file> + Appoint specified file and type during mount, so that quota +grpjquota=<file> + information can be properly updated during recovery flow, +prjjquota=<file> + <quota file>: must be in root directory; +jqfmt=<quota type> + <quota type>: [vfsold,vfsv0,vfsv1]. +offusrjquota + Turn off user journelled quota. +offgrpjquota + Turn off group journelled quota. +offprjjquota + Turn off project journelled quota. +quota + Enable plain user disk quota accounting. +noquota + Disable all plain disk quota option. +whint_mode=%s + Control which write hints are passed down to block layer. This supports "off", "user-based", and "fs-based". In "off" mode (default), f2fs does not pass down hints. In "user-based" mode, f2fs tries to pass down hints given by users. And in "fs-based" mode, f2fs passes down hints with its policy. -alloc_mode=%s Adjust block allocation policy, which supports "reuse" +alloc_mode=%s + Adjust block allocation policy, which supports "reuse" and "default". -fsync_mode=%s Control the policy of fsync. Currently supports "posix", +fsync_mode=%s + Control the policy of fsync. Currently supports "posix", "strict", and "nobarrier". In "posix" mode, which is default, fsync will follow POSIX semantics and does a light operation to improve the filesystem performance.
@@ -225,13 +268,14 @@ fsync_mode=%s Control the policy of fsync. Currently supports "posix", pass, but the performance will regress. "nobarrier" is based on "posix", but doesn't issue flush command for non-atomic files likewise "nobarrier" mount option. -test_dummy_encryption -test_dummy_encryption=%s + +test_dummy_encryption, test_dummy_encryption=%s Enable dummy encryption, which provides a fake fscrypt context. The fake fscrypt context is used by xfstests. The argument may be either "v1" or "v2", in order to select the corresponding fscrypt policy version. -checkpoint=%s[:%u[%]] Set to "disable" to turn off checkpointing. Set to "enable" +checkpoint=%s[:%u[%]] + Set to "disable" to turn off checkpointing. Set to "enable" to reenable checkpointing. Is enabled by default. While disabled, any unmounting or unexpected shutdowns will cause the filesystem contents to appear as they did when the
@@ -247,18 +291,20 @@ checkpoint=%s[:%u[%]] Set to "disable" to turn off checkpointing. Set to "enabl hide up to all remaining free space. The actual space that would be unusable can be viewed at /sys/fs/f2fs/<disk>/unusable This space is reclaimed once checkpoint=enable. -compress_algorithm=%s Control compress algorithm, currently f2fs supports "lzo", +compress_algorithm=%s + Control compress algorithm, currently f2fs supports "lzo", "lz4", "zstd" and "lzo-rle" algorithm. -compress_log_size=%u Support configuring compress cluster size, the size will +compress_log_size=%u + Support configuring compress cluster size, the size will be 4KB * (1 << %u), 16KB is minimum size, also it's default size. -compress_extension=%s Support adding specified extension, so that f2fs can enable +compress_extension=%s + Support adding specified extension, so that f2fs can enable compression on those corresponding files, e.g. if all files with '.ext' has high compression rate, we can set the '.ext' on compression extension list and enable compression on these file by default rather than to enable it via ioctl. For other files, we can still enable compression via ioctl. -====================== ============================================================ Debugfs Entries ===============
Signature · 8 lines
2.26.2 _______________________________________________ Linux-f2fs-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
PATCH 28/29 docs: fs: proc.rst: fix a warning due to a merge conflict
In reply to Mauro Carvalho ChehabChangeset 424037b77519 ("mm: smaps: Report arm64 guarded pages in smaps") added a new parameter to a table. This causes Sphinx warnings, because there's now an extra "-" at the wrong place:
/devel/v4l/docs/Documentation/filesystems/proc.rst:548: WARNING: Malformed table. Text in column margin in table line 29. == ======================================= rd readable ... bt - arm64 BTI guarded page == =======================================
--- Documentation/filesystems/proc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/filesystems/proc.rst +1 -1
@@ -545,7 +545,7 @@ encoded manner. The codes are the following: hg huge page advise flag nh no huge page advise flag mg mergable advise flag - bt - arm64 BTI guarded page + bt arm64 BTI guarded page == ======================================= Note that there is no guarantee that every flag and associated mnemonic will
Signature · 1 line
2.26.2
PATCH 29/29 docs: fs: proc.rst: convert a new chapter to ReST
In reply to Mauro Carvalho ChehabA new chapter was added to proc.rst. Adjust the markups to avoid this warning:
Documentation/filesystems/proc.rst:2194: WARNING: Inconsistent literal block quoting.
And to properly mark the code-blocks there.
--- Documentation/filesystems/proc.rst | 44 ++++++++++++++---------------- 1 file changed, 21 insertions(+), 23 deletions(-)
Documentation/filesystems/proc.rst +21 -23
@@ -2179,46 +2179,44 @@ subset=pid hides all top level files and directories in the procfs that are not related to tasks. 5 Filesystem behavior ----------------------------- +--------------------------- Originally, before the advent of pid namepsace, procfs was a global file system. It means that there was only one procfs instance in the system. When pid namespace was added, a separate procfs instance was mounted in each pid namespace. So, procfs mount options are global among all -mountpoints within the same namespace. +mountpoints within the same namespace:: -:: + # grep ^proc /proc/mounts + proc /proc proc rw,relatime,hidepid=2 0 0 -# grep ^proc /proc/mounts -proc /proc proc rw,relatime,hidepid=2 0 0 + # strace -e mount mount -o hidepid=1 -t proc proc /tmp/proc + mount("proc", "/tmp/proc", "proc", 0, "hidepid=1") = 0 + +++ exited with 0 +++ -# strace -e mount mount -o hidepid=1 -t proc proc /tmp/proc -mount("proc", "/tmp/proc", "proc", 0, "hidepid=1") = 0 -+++ exited with 0 +++ - -# grep ^proc /proc/mounts -proc /proc proc rw,relatime,hidepid=2 0 0 -proc /tmp/proc proc rw,relatime,hidepid=2 0 0 + # grep ^proc /proc/mounts + proc /proc proc rw,relatime,hidepid=2 0 0 + proc /tmp/proc proc rw,relatime,hidepid=2 0 0 and only after remounting procfs mount options will change at all -mountpoints. +mountpoints:: -# mount -o remount,hidepid=1 -t proc proc /tmp/proc + # mount -o remount,hidepid=1 -t proc proc /tmp/proc -# grep ^proc /proc/mounts -proc /proc proc rw,relatime,hidepid=1 0 0 -proc /tmp/proc proc rw,relatime,hidepid=1 0 0 + # grep ^proc /proc/mounts + proc /proc proc rw,relatime,hidepid=1 0 0 + proc /tmp/proc proc rw,relatime,hidepid=1 0 0 This behavior is different from the behavior of other filesystems. The new procfs behavior is more like other filesystems. Each procfs mount creates a new procfs instance. Mount options affect own procfs instance. It means that it became possible to have several procfs instances -displaying tasks with different filtering options in one pid namespace. +displaying tasks with different filtering options in one pid namespace:: -# mount -o hidepid=invisible -t proc proc /proc -# mount -o hidepid=noaccess -t proc proc /tmp/proc -# grep ^proc /proc/mounts -proc /proc proc rw,relatime,hidepid=invisible 0 0 -proc /tmp/proc proc rw,relatime,hidepid=noaccess 0 0 + # mount -o hidepid=invisible -t proc proc /proc + # mount -o hidepid=noaccess -t proc proc /tmp/proc + # grep ^proc /proc/mounts + proc /proc proc rw,relatime,hidepid=invisible 0 0 + proc /tmp/proc proc rw,relatime,hidepid=noaccess 0 0
Signature · 1 line
2.26.2
PATCH 23/29 docs: ABI: fix a typo when pointing to w1-generic.rst
In reply to Mauro Carvalho ChehabThere's a typo there:
w1_generic.rst -> w1-generic.rst
Causing the document reference to point to the wrong place.
--- Documentation/ABI/testing/sysfs-driver-w1_therm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-driver-w1_therm +1 -1
@@ -8,7 +8,7 @@ Description: to device min/max capabilities. Values are integer as they are stored in a 8bit register in the device. Lowest value is automatically put to TL. Once set, alarms could be search at - master level, refer to Documentation/w1/w1_generic.rst for + master level, refer to Documentation/w1/w1-generic.rst for detailed information Users: any user space application which wants to communicate with w1_term device
Signature · 1 line
2.26.2
PATCH 27/29 docs: dt: minor adjustments at writing-schema.rst
In reply to Mauro Carvalho ChehabThere are two literal blocks that aren't mark as such. Mark them, in order to make the document to produce a better html output.
While here, also add a SPDX header to it.
--- Documentation/devicetree/writing-schema.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
Documentation/devicetree/writing-schema.rst +6 -3
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 Writing DeviceTree Bindings in json-schema ==========================================
@@ -124,9 +124,12 @@ dtc must also be built with YAML output support enabled. This requires that libyaml and its headers be installed on the host system. For some distributions that involves installing the development package, such as: -Debian: +Debian:: + apt-get install libyaml-dev -Fedora: + +Fedora:: + dnf -y install libyaml-devel Running checks
Signature · 1 line
2.26.2
PATCH 18/29 docs: powerpc: fix some issues at vas-api.rst
In reply to Mauro Carvalho ChehabThere are a few issues on this document, when built via the building with ``make htmldocs``:
Documentation/powerpc/vas-api.rst:116: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:116: WARNING: Inline emphasis start-string without end-string. Documentation/powerpc/vas-api.rst:117: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:117: WARNING: Inline emphasis start-string without end-string. Documentation/powerpc/vas-api.rst:120: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:124: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:133: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:135: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:150: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:151: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:161: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:176: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:253: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:253: WARNING: Inline emphasis start-string without end-string. Documentation/powerpc/vas-api.rst:259: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:261: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:266: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:267: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:270: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:271: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:273: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:274: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:277: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:278: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:280: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:287: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:289: WARNING: Block quote ends without a blank line; unexpected unindent.
--- Documentation/powerpc/vas-api.rst | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-)
Documentation/powerpc/vas-api.rst +18 -5
@@ -87,6 +87,7 @@ Applications may chose a specific instance of the NX co-processor using the vas_id field in the VAS_TX_WIN_OPEN ioctl as detailed below. A userspace library libnxz is available here but still in development: + https://github.com/abalib/power-gzip Applications that use inflate / deflate calls can link with libnxz
@@ -110,6 +111,7 @@ Applications should use the VAS_TX_WIN_OPEN ioctl as follows to establish a connection with NX co-processor engine: :: + struct vas_tx_win_open_attr { __u32 version; __s16 vas_id; /* specific instance of vas or -1
@@ -119,8 +121,10 @@ a connection with NX co-processor engine: __u64 reserved2[6]; }; - version: The version field must be currently set to 1. - vas_id: If '-1' is passed, kernel will make a best-effort attempt + version: + The version field must be currently set to 1. + vas_id: + If '-1' is passed, kernel will make a best-effort attempt to assign an optimal instance of NX for the process. To select the specific VAS instance, refer "Discovery of available VAS engines" section below.
@@ -129,7 +133,8 @@ a connection with NX co-processor engine: and must be set to 0. The attributes attr for the VAS_TX_WIN_OPEN ioctl are defined as - follows: + follows:: + #define VAS_MAGIC 'v' #define VAS_TX_WIN_OPEN _IOW(VAS_MAGIC, 1, struct vas_tx_win_open_attr)
@@ -141,6 +146,8 @@ a connection with NX co-processor engine: returns -1 and sets the errno variable to indicate the error. Error conditions: + + ====== ================================================ EINVAL fd does not refer to a valid VAS device. EINVAL Invalid vas ID EINVAL version is not set with proper value
@@ -149,6 +156,7 @@ a connection with NX co-processor engine: ENOSPC System has too many active windows (connections) opened EINVAL reserved fields are not set to 0. + ====== ================================================ See the ioctl(2) man page for more details, error codes and restrictions.
@@ -158,11 +166,13 @@ mmap() NX-GZIP device The mmap() system call for a NX-GZIP device fd returns a paste_address that the application can use to copy/paste its CRB to the hardware engines. + :: paste_addr = mmap(addr, size, prot, flags, fd, offset); Only restrictions on mmap for a NX-GZIP device fd are: + * size should be PAGE_SIZE * offset parameter should be 0ULL
@@ -170,10 +180,12 @@ that the application can use to copy/paste its CRB to the hardware engines. In addition to the error conditions listed on the mmap(2) man page, can also fail with one of the following error codes: + ====== ============================================= EINVAL fd is not associated with an open window (i.e mmap() does not follow a successful call to the VAS_TX_WIN_OPEN ioctl). EINVAL offset field is not 0ULL. + ====== ============================================= Discovery of available VAS engines ==================================
@@ -210,7 +222,7 @@ In case if NX encounters translation error (called NX page fault) on CSB address or any request buffer, raises an interrupt on the CPU to handle the fault. Page fault can happen if an application passes invalid addresses or request buffers are not in memory. The operating system handles the fault by -updating CSB with the following data: +updating CSB with the following data:: csb.flags = CSB_V; csb.cc = CSB_CC_TRANSLATION;
@@ -223,7 +235,7 @@ the application can resend this request to NX. If the OS can not update CSB due to invalid CSB address, sends SEGV signal to the process who opened the send window on which the original request was -issued. This signal returns with the following siginfo struct: +issued. This signal returns with the following siginfo struct:: siginfo.si_signo = SIGSEGV; siginfo.si_errno = EFAULT;
@@ -248,6 +260,7 @@ Simple example ============== :: + int use_nx_gzip() { int rc, fd;
Signature · 1 line
2.26.2
PATCH 24/29 docs: fs: locking.rst: fix a broken table
In reply to Mauro Carvalho ChehabAs reported by Sphinx:
Documentation/filesystems/locking.rst:443: WARNING: Malformed table. Text in column margin in table line 8.
========== ============= ================= ========= ops inode->i_lock blocked_lock_lock may block ========== ============= ================= ========= lm_notify: yes yes no lm_grant: no no no lm_break: yes no no lm_change yes no no lm_breaker_owns_lease: no no no ========== ============= ================= =========
--- Documentation/filesystems/locking.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/filesystems/locking.rst +3 -3
@@ -433,15 +433,15 @@ prototypes:: locking rules: -========== ============= ================= ========= +====================== ============= ================= ========= ops inode->i_lock blocked_lock_lock may block -========== ============= ================= ========= +====================== ============= ================= ========= lm_notify: yes yes no lm_grant: no no no lm_break: yes no no lm_change yes no no lm_breaker_owns_lease: no no no -========== ============= ================= ========= +====================== ============= ================= ========= buffer_head ===========
Signature · 1 line
2.26.2
PATCH 22/29 docs: it_IT: add two missing references
In reply to Mauro Carvalho Chehabthere are missing references causing Sphinx warnings:
Documentation/translations/it_IT/process/submitting-patches.rst:384: WARNING: undefined label: it_email_clients (if the link has no caption the label must precede a section header) Documentation/translations/it_IT/process/submitting-patches.rst:384: WARNING: undefined label: it_email_clients (if the link has no caption the label must precede a section header)
--- Documentation/translations/it_IT/process/management-style.rst | 2 ++ Documentation/translations/it_IT/process/submitting-patches.rst | 2 ++ 2 files changed, 4 insertions(+)
Documentation/translations/it_IT/process/management-style.rst +2 -0
@@ -1,5 +1,7 @@ .. include:: ../disclaimer-ita.rst +.. _it_managementstyle: + :Original: :doc:`../../../process/management-style` :Translator: Alessia Mantegazza <[email protected]>
Documentation/translations/it_IT/process/submitting-patches.rst +2 -0
@@ -1,3 +1,5 @@ +.. _it_email_clients: + .. include:: ../disclaimer-ita.rst :Original: :ref:`Documentation/process/submitting-patches.rst <submittingpatches>`
Signature · 1 line
2.26.2
PATCH 25/29 docs: add bus-virt-phys-mapping.txt to core-api
In reply to Mauro Carvalho ChehabThis describes an old interface used prior the new DMA-API interfaces. Add it to the core-api guide, just after the DMA stuff.
---
.../bus-virt-phys-mapping.rst} | 0
Documentation/core-api/index.rst | 1 +
2 files changed, 1 insertion(+)
rename Documentation/{bus-virt-phys-mapping.txt => core-api/bus-virt-phys-mapping.rst} (100%)Documentation/core-api/bus-virt-phys-mapping.rst renamed from Documentation/bus-virt-phys-mapping.txt +0 -0
Documentation/core-api/index.rst +1 -0
@@ -87,6 +87,7 @@ more memory-management documentation in :doc:`/vm/index`. dma-api-howto dma-attributes dma-isa-lpc + bus-virt-phys-mapping mm-api genalloc pin_user_pages
Signature · 1 line
2.26.2
PATCH 12/29 dt: update a reference for reneases pcar file renamed to yaml
In reply to Mauro Carvalho ChehabThis file was renamed, but its reference at pfc-pinctl.txt is still pointing to the old file.
--- .../devicetree/bindings/pinctrl/renesas,pfc-pinctrl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/pinctrl/renesas,pfc-pinctrl.txt +1 -1
@@ -114,7 +114,7 @@ with values derived from the SoC user manual. [flags]> On other mach-shmobile platforms GPIO is handled by the gpio-rcar driver. -Please refer to Documentation/devicetree/bindings/gpio/renesas,gpio-rcar.txt +Please refer to Documentation/devicetree/bindings/gpio/renesas,rcar-gpio.yaml for documentation of the GPIO device tree bindings on those platforms.
Signature · 1 line
2.26.2
PATCH 16/29 selftests/vm/keys: fix a broken reference at protection_keys.c
In reply to Mauro Carvalho ChehabChangeset 1eecbcdca2bd ("docs: move protection-keys.rst to the core-api book") from Jun 7, 2019 converted protection-keys.txt file to ReST.
A recent change at protection_keys.c partially reverted such changeset, causing it to point to a non-existing file:
- * Tests x86 Memory Protection Keys (see Documentation/core-api/protection-keys.rst)
+ * Tests Memory Protection Keys (see Documentation/vm/protection-keys.txt)
It sounds to me that the changeset that introduced such change 4645e3563673 ("selftests/vm/pkeys: rename all references to pkru to a generic name") could also have other side effects, as it sounds that it was not generated against uptream code, but, instead, against a version
older than Jun 7, 2019.
--- tools/testing/selftests/vm/protection_keys.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
tools/testing/selftests/vm/protection_keys.c +1 -1
@@ -1,6 +1,6 @@// SPDX-License-Identifier: GPL-2.0 /* -* Tests Memory Protection Keys (see Documentation/vm/protection-keys.txt) +* Tests Memory Protection Keys (see Documentation/core-api/protection-keys.rst) * * There are examples in here of: * * how to set protection keys on memory
Signature · 1 line
2.26.2
PATCH 7/29 fs: fs.h: fix a kernel-doc parameter description
In reply to Mauro Carvalho ChehabChangeset 3b0311e7ca71 ("vfs: track per-sb writeback errors and report them to syncfs") added a variant of filemap_sample_wb_err(), but it forgot to
rename the arguments at the kernel-doc markup. Fix it.
Fix those warnings:
./include/linux/fs.h:2845: warning: Function parameter or member 'file' not described in 'file_sample_sb_err' ./include/linux/fs.h:2845: warning: Excess function parameter 'mapping' description in 'file_sample_sb_err'
--- include/linux/fs.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/fs.h +1 -1
@@ -2829,7 +2829,7 @@ static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)/** * file_sample_sb_err - sample the current errseq_t to test for later errors -* @mapping: mapping to be sampled +* @file: file pointer to be sampled * * Grab the most current superblock-level errseq_t value for the given * struct file.
Signature · 1 line
2.26.2
PATCH 19/29 docs: driver-model: remove a duplicated markup at driver.rst
In reply to Mauro Carvalho ChehabThe "::" markup is there twice, causing a warning:
Documentation/driver-api/driver-model/driver.rst:233: WARNING: Inline emphasis start-string without end-string.
--- Documentation/driver-api/driver-model/driver.rst | 2 -- 1 file changed, 2 deletions(-)
Documentation/driver-api/driver-model/driver.rst +0 -2
@@ -228,8 +228,6 @@ over management of devices from the bootloader, the usage of sync_state() is not restricted to that. Use it whenever it makes sense to take an action after all the consumers of a device have probed:: -:: - int (*remove) (struct device *dev); remove is called to unbind a driver from a device. This may be
Signature · 1 line
2.26.2
PATCH 15/29 dt: fix reference to olpc,xo1.75-ec.txt
In reply to Mauro Carvalho ChehabThis file was converted and renamed.
--- Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.txt +1 -1
@@ -8,7 +8,7 @@ The embedded controller requires the SPI controller driver to signal readiness to receive a transfer (that is, when TX FIFO contains the response data) by strobing the ACK pin with the ready signal. See the "ready-gpios" property of the SSP binding as documented in: -<Documentation/devicetree/bindings/spi/spi-pxa2xx.txt>. +<Documentation/devicetree/bindings/spi/marvell,mmp2-ssp.yaml>. Example: &ssp3 {
Signature · 1 line
2.26.2
PATCH 5/29 net: pylink.h: add kernel-doc descriptions for new fields at phylink_config
In reply to Mauro Carvalho ChehabSome fields were moved from struct phylink into phylink_config. Update the kernel-doc markups for the config struct accordingly
--- include/linux/phylink.h | 4 ++++ 1 file changed, 4 insertions(+)
include/linux/phylink.h +4 -0
@@ -62,6 +62,10 @@ enum phylink_op_type {* @dev: a pointer to a struct device associated with the MAC * @type: operation type of PHYLINK instance * @pcs_poll: MAC PCS cannot provide link change interrupt +* @poll_fixed_state: if true, starts link_poll, +* if MAC link is at %MLO_AN_FIXED mode. +* @get_fixed_state: callback to execute to determine the fixed link state, +* if MAC link is at %MLO_AN_FIXED mode. */ struct phylink_config {struct device *dev;
Signature · 1 line
2.26.2
PATCH 8/29 gpio: driver.h: fix kernel-doc markup
In reply to Mauro Carvalho ChehabThere is one parameter with a wrong name at kernel-doc macro:
./include/linux/gpio/driver.h:499: warning: Function parameter or member 'gc' not described in 'gpiochip_add_data' ./include/linux/gpio/driver.h:499: warning: Excess function parameter 'chip' description in 'gpiochip_add_data'
Fix it.
--- include/linux/gpio/driver.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/gpio/driver.h +1 -1
@@ -481,7 +481,7 @@ extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,/** * gpiochip_add_data() - register a gpio_chip -* @chip: the chip to register, with chip->base initialized +* @gc: the chip to register, with chip->base initialized * @data: driver-private data associated with this chip * * Context: potentially before irqs will work
Signature · 1 line
2.26.2
PATCH 9/29 kcsan: fix a kernel-doc warning
In reply to Mauro Carvalho ChehabOne of the kernel-doc markups there have two "note" sections:
./include/linux/kcsan-checks.h:346: warning: duplicate section name 'Note'
While this is not the case here, duplicated sections can cause build issues on Sphinx. So, let's change the notes section to use, instead, a list for those 2 notes at the same function.
--- include/linux/kcsan-checks.h | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-)
include/linux/kcsan-checks.h +6 -4
@@ -337,11 +337,13 @@ static inline void __kcsan_disable_current(void) { }* release_for_reuse(obj); * } * -* Note: ASSERT_EXCLUSIVE_ACCESS_SCOPED(), if applicable, performs more thorough -* checking if a clear scope where no concurrent accesses are expected exists. +* Note: * -* Note: For cases where the object is freed, `KASAN <kasan.html>`_ is a better -* fit to detect use-after-free bugs. +* 1. ASSERT_EXCLUSIVE_ACCESS_SCOPED(), if applicable, performs more thorough +* checking if a clear scope where no concurrent accesses are expected exists. +* +* 2. For cases where the object is freed, `KASAN <kasan.html>`_ is a better +* fit to detect use-after-free bugs. * * @var: variable to assert on */
Signature · 1 line
2.26.2
PATCH 4/29 scripts/kernel-doc: parse __ETHTOOL_DECLARE_LINK_MODE_MASK
In reply to Mauro Carvalho ChehabThe __ETHTOOL_DECLARE_LINK_MODE_MASK macro is a variant of DECLARE_BITMAP(), used by phylink.h. As we have already a parser for DECLARE_BITMAP(), let's add one for this macro, in order to avoid such warnings:
./include/linux/phylink.h:54: warning: Function parameter or member '__ETHTOOL_DECLARE_LINK_MODE_MASK(advertising' not described in 'phylink_link_state' ./include/linux/phylink.h:54: warning: Function parameter or member '__ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising' not described in 'phylink_link_state'
--- scripts/kernel-doc | 2 ++ 1 file changed, 2 insertions(+)
scripts/kernel-doc +2 -0
@@ -1083,7 +1083,9 @@ sub dump_struct($$) { $members =~ s/\s*__packed\s*/ /gos; $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos; $members =~ s/\s*____cacheline_aligned_in_smp/ /gos; + # replace DECLARE_BITMAP + $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos; $members =~ s/DECLARE_BITMAP\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos; # replace DECLARE_HASHTABLE $members =~ s/DECLARE_HASHTABLE\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
Signature · 1 line
2.26.2
PATCH 3/29 net: netdevice.h: add a description for napi_defer_hard_irqs
In reply to Mauro Carvalho ChehabChangeset 6f8b12d661d0 ("net: napi: add hard irqs deferral feature") added a new element at struct net_device.
Add a description for it, based on what's described at the changeset which added such feature.
--- include/linux/netdevice.h | 2 ++ 1 file changed, 2 insertions(+)
include/linux/netdevice.h +2 -0
@@ -1742,6 +1742,8 @@ enum netdev_priv_flags {* @real_num_rx_queues: Number of RX queues currently active in device * @xdp_prog: XDP sockets filter program pointer * @gro_flush_timeout: timeout for GRO layer in NAPI +* @napi_defer_hard_irqs: If not zero, provides a counter that would +* allow to avoid NIC hard IRQ, on busy queues. * * @rx_handler: handler for received packets * @rx_handler_data: XXX: need comments on this one
Signature · 1 line
2.26.2
Re: [PATCH 09/29] kcsan: fix a kernel-doc warning
In reply to Mauro Carvalho ChehabQuoted 10 lines · Mauro Carvalho Chehab
One of the kernel-doc markups there have two "note" sections:
./include/linux/kcsan-checks.h:346: warning: duplicate section name 'Note'While this is not the case here, duplicated sections can cause build issues on Sphinx. So, let's change the notes section to use, instead, a list for those 2 notes at the same function.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Thanks!
Quoted 29 lines
--- include/linux/kcsan-checks.h | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-)include/linux/kcsan-checks.h +6
-5@@ -337,11 +337,13 @@ static inline void __kcsan_disable_current(void) { }* release_for_reuse(obj); * } * -* Note: ASSERT_EXCLUSIVE_ACCESS_SCOPED(), if applicable, performs more thorough -* checking if a clear scope where no concurrent accesses are expected exists. +* Note: * -* Note: For cases where the object is freed, `KASAN <kasan.html>`_ is a better -* fit to detect use-after-free bugs. +* 1. ASSERT_EXCLUSIVE_ACCESS_SCOPED(), if applicable, performs more thorough +* checking if a clear scope where no concurrent accesses are expected exists. +* +* 2. For cases where the object is freed, `KASAN <kasan.html>`_ is a better +* fit to detect use-after-free bugs. * * @var: variable to assert on */ --2.26.2
Re: [PATCH 12/29] dt: update a reference for reneases pcar file renamed to yaml
In reply to Mauro Carvalho ChehabHi Mauro,
Quoted 1 line · Mauro Carvalho Chehab
This file was renamed, but its reference at pfc-pinctl.txt is
pfc-pinctrl.txt
Quoted 4 lines
still pointing to the old file.
Fixes 7f7d408e5a00 ("dt-bindings: gpio: rcar: Convert to json-schema")Signed-off-by Mauro Carvalho Chehab <[email protected]>
Thanks!
Note that the reference will go away with the pfc-pinctrl.txt json-schema conversion.
Gr{oetje,eeting}s,
Geert
Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected] In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that. -- Linus Torvalds
Federico Vaga
maintainerRe: [PATCH 22/29] docs: it_IT: add two missing references
In reply to Mauro Carvalho ChehabIt is already fixed by https://lkml.org/lkml/2020/5/31/260
Quoted 41 lines · CEST Mauro Carvalho Chehab
there are missing references causing Sphinx warnings:
Documentation/translations/it_IT/process/submitting-patches.rst:384:
WARNING: undefined label:it_email_clients(if the link has no caption the label must precede a section header)Documentation/translations/it_IT/process/submitting-patches.rst:384:
WARNING: undefined label:it_email_clients(if the link has no caption the label must precede a section header)Signed-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/translations/it_IT/process/management-style.rst | 2 ++ Documentation/translations/it_IT/process/submitting-patches.rst | 2 ++ 2 files changed, 4 insertions(+)(quoted diff) +0
-0
b/Documentation/translations/it_IT/process/management-style.rstindex76ed074082ea..f7acee105c05100644Documentation/translations/it_IT/process/management-style.rst +2
-0@@ -1,5 +1,7 @@ .. include:: ../disclaimer-ita.rst +.. _it_managementstyle: + :Original: :doc:`../../../process/management-style` :Translator: Alessia Mantegazza <[email protected]>(quoted diff) +0
-0
b/Documentation/translations/it_IT/process/submitting-patches.rstindex7c23c08e4401..94c816b4e8f8100644Documentation/translations/it_IT/process/submitting-patches.rst +2
-0@@ -1,3 +1,5 @@ +.. _it_email_clients: + .. include:: ../disclaimer-ita.rst :Original: :ref:`Documentation/process/submitting-patches.rst:<submittingpatches>`
Re: [PATCH 14/29] dt: Fix broken references to renamed docs
In reply to Mauro Carvalho ChehabQuoted 53 lines · Mauro Carvalho Chehab
Some files got renamed. Those were all fixed automatically by
./scripts/documentation-file-ref-check --fixSigned-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt | 2 +- Documentation/devicetree/bindings/display/imx/fsl-imx-drm.txt | 4 ++-- Documentation/devicetree/bindings/display/imx/ldb.txt | 4 ++-- Documentation/devicetree/bindings/spi/qcom,spi-geni-qcom.txt | 2 +- MAINTAINERS | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-)Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt +1
-1@@ -47,7 +47,7 @@ Required properties: &lsio_mu1 1 2 &lsio_mu1 1 3 &lsio_mu1 3 3>; - See Documentation/devicetree/bindings/mailbox/fsl,mu.txt + See Documentation/devicetree/bindings/mailbox/fsl,mu.yaml for detailed mailbox binding. Note: Each mu which supports general interrupt should have an alias correctlyDocumentation/devicetree/bindings/display/imx/fsl-imx-drm.txt +2
-2@@ -68,7 +68,7 @@ Required properties: datasheet - clocks : phandle to the PRE axi clock input, as described in Documentation/devicetree/bindings/clock/clock-bindings.txt and - Documentation/devicetree/bindings/clock/imx6q-clock.txt. + Documentation/devicetree/bindings/clock/imx6q-clock.yaml. - clock-names: should be "axi" - interrupts: should contain the PRE interrupt - fsl,iram: phandle pointing to the mmio-sram device node, that should be@@ -94,7 +94,7 @@ Required properties: datasheet - clocks : phandles to the PRG ipg and axi clock inputs, as described in Documentation/devicetree/bindings/clock/clock-bindings.txt and - Documentation/devicetree/bindings/clock/imx6q-clock.txt. + Documentation/devicetree/bindings/clock/imx6q-clock.yaml. - clock-names: should be "ipg" and "axi" - fsl,pres: phandles to the PRE units attached to this PRG, with the fixed PRE as the first entry and the muxable PREs following.Documentation/devicetree/bindings/display/imx/ldb.txt +0
-0
Documentation/devicetree/bindings/display/imx/ldb.txt Required properties: · line 37
Quoted 10 lines
Documentation/devicetree/bindings/display/imx/ldb.txt +2
-2@@ -30,8 +30,8 @@ Required properties: "di2_sel" - IPU2 DI0 mux "di3_sel" - IPU2 DI1 mux The needed clock numbers for each are documented in - Documentation/devicetree/bindings/clock/imx5-clock.txt, and in - Documentation/devicetree/bindings/clock/imx6q-clock.txt. + Documentation/devicetree/bindings/clock/imx5-clock.yaml, and in + Documentation/devicetree/bindings/clock/imx6q-clock.yaml. Optional properties: - pinctrl-names : should be "default" on i.MX53, not used on i.MX6q
regards
Philipp
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Re: [PATCH 08/29] gpio: driver.h: fix kernel-doc markup
In reply to Mauro Carvalho Chehabpon., 15 cze 2020 o 08:47 Mauro Carvalho Chehab
<[email protected]> napisał(a):
Quoted 27 lines
There is one parameter with a wrong name at kernel-doc macro:
./include/linux/gpio/driver.h:499: warning: Function parameter or member 'gc' not described in 'gpiochip_add_data'./include/linux/gpio/driver.h:499: warning: Excess function parameter 'chip' description in 'gpiochip_add_data'Fix it.
Signed-off-by Mauro Carvalho Chehab <[email protected]>--- include/linux/gpio/driver.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)include/linux/gpio/driver.h +1
-2@@ -481,7 +481,7 @@ extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,/** * gpiochip_add_data() - register a gpio_chip -* @chip: the chip to register, with chip->base initialized +* @gc: the chip to register, with chip->base initialized * @data: driver-private data associated with this chip * * Context: potentially before irqs will work --
Quoted 2 lines
2.26.2
Patch applied, thanks!
Bartosz
Re: [PATCH 13/29] dt: fix broken links due to txt->yaml renames
In reply to Mauro Carvalho ChehabQuoted 11 lines · Mauro Carvalho Chehab
There are some new broken doc links due to yaml renames at DT. Developers should really run:
./scripts/documentation-file-ref-checkin order to solve those issues while submitting patches. This tool can even fix most of the issues with:
./scripts/documentation-file-ref-check --fixSigned-off-by Mauro Carvalho Chehab <[email protected]>
Quoted 9 lines
--- Documentation/devicetree/bindings/display/bridge/sii902x.txt | 2 +- .../devicetree/bindings/display/rockchip/rockchip-drm.yaml | 2 +- Documentation/devicetree/bindings/net/mediatek-bluetooth.txt | 2 +- Documentation/devicetree/bindings/sound/audio-graph-card.txt | 2 +- Documentation/devicetree/bindings/sound/st,sti-asoc-card.txt | 2 +- Documentation/mips/ingenic-tcu.rst | 2 +- MAINTAINERS | 4 ++-- 7 files changed, 8 insertions(+), 8 deletions(-)
Signature · 2 lines
Crap can work. Given enough thrust pigs will fly, but it's not necessarily a good idea. [ RFC1925, 2.3 ]
Re: [PATCH 07/29] fs: fs.h: fix a kernel-doc parameter description
In reply to Mauro Carvalho ChehabQuoted 10 lines · Mauro Carvalho Chehab
Changeset
3b0311e7ca71("vfs: track per-sb writeback errors and report them to syncfs") added a variant offilemap_sample_wb_err(), but it forgot to
rename the arguments at the kernel-doc markup. Fix it.Fix those warnings:
./include/linux/fs.h:2845: warning: Function parameter or member 'file' not described in 'file_sample_sb_err'./include/linux/fs.h:2845: warning: Excess function parameter 'mapping' description in 'file_sample_sb_err'Fixes 3b0311e7ca71 ("vfs: track per-sb writeback errors and report them to syncfs")Signed-off-by Mauro Carvalho Chehab <[email protected]>
Thanks for the fix! It looks good to me. You can add:
Honza
Quoted 20 lines
--- include/linux/fs.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)include/linux/fs.h +1
-1@@ -2829,7 +2829,7 @@ static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)/** * file_sample_sb_err - sample the current errseq_t to test for later errors -* @mapping: mapping to be sampled +* @file: file pointer to be sampled * * Grab the most current superblock-level errseq_t value for the given * struct file. Signature · 1 line
2.26.2
Signature · 2 lines
Jan Kara <[email protected]> SUSE Labs, CR
Mark Brown
maintainerRe: [PATCH 28/29] docs: fs: proc.rst: fix a warning due to a merge conflict
In reply to Mauro Carvalho ChehabQuoted 8 lines · Mauro Carvalho Chehab
... bt - arm64 BTI guarded page == =======================================Fixes 424037b77519 ("mm: smaps: Report arm64 guarded pages in smaps")Fixes c33e97efa9d9 ("docs: filesystems: convert proc.txt to ReST")Signed-off-by Mauro Carvalho Chehab <[email protected]>---
I acked this when you sent it previously but you've dropped my ack - I'm not clear what's changed? The prior ack was in [email protected].
Re: [PATCH 14/29] dt: Fix broken references to renamed docs
In reply to Mauro Carvalho ChehabQuoted 3 lines · Mauro Carvalho Chehab
Some files got renamed. Those were all fixed automatically by
./scripts/documentation-file-ref-check --fix
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Mark Brown
maintainerRe: [PATCH 13/29] dt: fix broken links due to txt->yaml renames
In reply to Mauro Carvalho ChehabQuoted 2 lines · Mauro Carvalho Chehab
There are some new broken doc links due to yaml renames at DT. Developers should really run:
I also previously acked this one in [email protected] Has anything changed here to cause the ack to be dropped?
Matthew Wilcox
maintainerRe: [PATCH 17/29] docs: hugetlbpage.rst: fix some warnings
In reply to Mauro Carvalho ChehabDocumentation/admin-guide/mm/hugetlbpage.rst with a huge page size selection parameter "hugepagesz=<size>". <size> must · line 104
Quoted 7 lines · Mauro Carvalho Chehab
Documentation/admin-guide/mm/hugetlbpage.rst +2
-1@@ -100,38 +100,49 @@ with a huge page size selection parameter "hugepagesz=<size>". <size> must be specified in bytes with optional scale suffix [kKmMgG]. The default huge page size may be selected with the "default_hugepagesz=<size>" boot parameter. -Hugetlb boot command line parameter semantics +Hugetlb + boot command line parameter semantics
That's not right. This is a single sentence, not something being defined.
Re: [PATCH 13/29] dt: fix broken links due to txt->yaml renames
In reply to Mark BrownHi Mark,
Em Mon, 15 Jun 2020 12:19:27 +0100
Mark Brown <[email protected]> escreveu:
Quoted 6 lines · Mauro Carvalho Chehab
Quoted 2 lines
There are some new broken doc links due to yaml renames at DT. Developers should really run:
I also previously acked this one in [email protected]. Has anything changed here to cause the ack to be dropped?
Both patches are the same. I forgot to add your acks on my tree.
My bad!
Thanks,
Mauro
Mark Brown
maintainerRe: [PATCH 13/29] dt: fix broken links due to txt->yaml renames
Quoted 11 lines · Mauro Carvalho Chehab
Mark Brown <[email protected]> escreveu:
Quoted 6 lines · Mauro Carvalho Chehab
Quoted 2 lines
There are some new broken doc links due to yaml renames at DT. Developers should really run:
I also previously acked this one in [email protected]. Has anything changed here to cause the ack to be dropped?
Both patches are the same. I forgot to add your acks on my tree.
My bad!
Ah, no worries - no wonder I couldn't spot the changes!
Re: [PATCH 29/29] docs: fs: proc.rst: convert a new chapter to ReST
In reply to Mauro Carvalho ChehabQuoted 9 lines · Mauro Carvalho Chehab
A new chapter was added to
proc.rst. Adjust the markups to avoid this warning:
Documentation/filesystems/proc.rst:2194: WARNING: Inconsistent literal block quoting.And to properly mark the code-blocks there.
Fixes 37e7647a7212 ("docs: proc: add documentation for "hidepid=4" and "subset=pid" options and new mount behavior")Signed-off-by Mauro Carvalho Chehab <[email protected]>
Signature · 1 line
Kees Cook
Re: [PATCH 28/29] docs: fs: proc.rst: fix a warning due to a merge conflict
In reply to Mauro Carvalho ChehabQuoted 13 lines · Mauro Carvalho Chehab
Changeset
424037b77519("mm: smaps: Report arm64 guarded pages in smaps") added a new parameter to a table. This causes Sphinx warnings, because there's now an extra "-" at the wrong place:/devel/v4l/docs/Documentation/filesystems/proc.rst:548: WARNING: Malformed table. Text in column margin in table line 29. == ======================================= rd readable ... bt - arm64 BTI guarded page == =======================================
Quoted 3 lines
Fixes 424037b77519 ("mm: smaps: Report arm64 guarded pages in smaps")Fixes c33e97efa9d9 ("docs: filesystems: convert proc.txt to ReST")Signed-off-by Mauro Carvalho Chehab <[email protected]>
Signature · 1 line
Kees Cook
Re: [PATCH 10/29] rcu: fix some kernel-doc warnings
In reply to Mauro Carvalho ChehabQuoted 10 lines · Mauro Carvalho Chehab
There are some kernel-doc warnings:
./kernel/rcu/tree.c:2915: warning: Function parameter or member 'count' not described in 'kfree_rcu_cpu'
./include/linux/rculist.h:517: warning: bad line: [@right ][node2 ... ]
./include/linux/rculist.h:2: WARNING: Unexpected indentation.Move the comment for "count" to the kernel-doc markup and add a missing "*" on one kernel-doc continuation line.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Queued and pushed, thank you!
Thanx, Paul
Quoted 20 lines
--- include/linux/rculist.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)include/linux/rculist.h +1
-1@@ -512,7 +512,7 @@ static inline void hlist_replace_rcu(struct hlist_node *old,* @right: The hlist head on the right * * The lists start out as [@left ][node1 ... ] and -[@right ][node2 ... ] +* [@right ][node2 ... ] * The lists end up as [@left ][node2 ... ] * [@right ][node1 ... ] */ Signature · 1 line
2.26.2
Re: [PATCH 26/29] docs: fix references for DMA*.txt files
In reply to Mauro Carvalho ChehabQuoted 4 lines · 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 <[email protected]>
Quoted 8 lines
--- Documentation/PCI/pci.rst | 6 +++--- Documentation/block/biodoc.rst | 2 +- Documentation/core-api/bus-virt-phys-mapping.rst | 2 +- Documentation/core-api/dma-api.rst | 6 +++--- Documentation/core-api/dma-isa-lpc.rst | 2 +- Documentation/driver-api/usb/dma.rst | 6 +++--- Documentation/memory-barriers.txt | 6 +++---
I grabbed this Documentation/memory-barriers.txt, but can drop it if Jon takes the whole batch, in which case:
Quoted 399 lines
.../translations/ko_KR/memory-barriers.txt | 6 +++--- arch/ia64/hp/common/sba_iommu.c | 12 ++++++------ arch/parisc/kernel/pci-dma.c | 2 +- arch/x86/include/asm/dma-mapping.h | 4 ++-- arch/x86/kernel/amd_gart_64.c | 2 +- drivers/parisc/sba_iommu.c | 14 +++++++------- include/linux/dma-mapping.h | 2 +- include/media/videobuf-dma-sg.h | 2 +- kernel/dma/debug.c | 2 +- 16 files changed, 38 insertions(+), 38 deletions(-)Documentation/PCI/pci.rst +3
-3@@ -265,7 +265,7 @@ Set the DMA mask size --------------------- .. note:: If anything below doesn't make sense, please refer to - Documentation/DMA-API.txt. This section is just a reminder that + :doc:`/core-api/dma-api`. This section is just a reminder that drivers need to indicate DMA capabilities of the device and is not an authoritative source for DMA interfaces.@@ -291,7 +291,7 @@ Many 64-bit "PCI" devices (before PCI-X) and some PCI-X devices are Setup shared control data ------------------------- Once the DMA masks are set, the driver can allocate "consistent" (a.k.a. shared) -memory. See Documentation/DMA-API.txt for a full description of +memory. See :doc:`/core-api/dma-api` for a full description of the DMA APIs. This section is just a reminder that it needs to be done before enabling DMA on the device.@@ -421,7 +421,7 @@ owners if there is one. Then clean up "consistent" buffers which contain the control data. -See Documentation/DMA-API.txt for details on unmapping interfaces. +See :doc:`/core-api/dma-api` for details on unmapping interfaces. Unregister from other subsystemsDocumentation/block/biodoc.rst +1
-1@@ -196,7 +196,7 @@ a virtual address mapping (unlike the earlier scheme of virtual address do not have a corresponding kernel virtual address space mapping) and low-memory pages. -Note: Please refer to Documentation/DMA-API-HOWTO.txt for a discussion +Note: Please refer to :doc:`/core-api/dma-api-howto` for a discussion on PCI high mem DMA aspects and mapping of scatter gather lists, and support for 64 bit PCI.Documentation/core-api/bus-virt-phys-mapping.rst +1
-1@@ -8,7 +8,7 @@ How to access I/O mapped memory from within device drivers The virt_to_bus() and bus_to_virt() functions have been superseded by the functionality provided by the PCI DMA interface - (see Documentation/DMA-API-HOWTO.txt). They continue + (see :doc:`/core-api/dma-api-howto`). They continue to be documented below for historical purposes, but new code must not use them. --davidm 00/12/12Documentation/core-api/dma-api.rst +3
-3@@ -5,7 +5,7 @@ Dynamic DMA mapping using the generic device :Author: James E.J. Bottomley <[email protected]> This document describes the DMA API. For a more gentle introduction -of the API (and actual examples), see Documentation/DMA-API-HOWTO.txt. +of the API (and actual examples), see :doc:`/core-api/dma-api-howto`. This API is split into two pieces. Part I describes the basic API. Part II describes extensions for supporting non-consistent memory@@ -471,7 +471,7 @@ without the _attrs suffixes, except that they pass an optional dma_attrs. The interpretation of DMA attributes is architecture-specific, and -each attribute should be documented in Documentation/DMA-attributes.txt. +each attribute should be documented in :doc:`/core-api/dma-attributes`. If dma_attrs are 0, the semantics of each of these functions is identical to those of the corresponding function@@ -484,7 +484,7 @@ for DMA:: #include <linux/dma-mapping.h> /* DMA_ATTR_FOO should be defined in linux/dma-mapping.h and - * documented in Documentation/DMA-attributes.txt */ + * documented in Documentation/core-api/dma-attributes.rst */ unsigned long attr;Documentation/core-api/dma-isa-lpc.rst +1
-1@@ -17,7 +17,7 @@ To do ISA style DMA you need to include two headers:: #include <asm/dma.h> The first is the generic DMA API used to convert virtual addresses to -bus addresses (see Documentation/DMA-API.txt for details). +bus addresses (see :doc:`/core-api/dma-api` for details). The second contains the routines specific to ISA DMA transfers. Since this is not present on all platforms make sure you construct yourDocumentation/driver-api/usb/dma.rst +3
-3@@ -10,7 +10,7 @@ API overview The big picture is that USB drivers can continue to ignore most DMA issues, though they still must provide DMA-ready buffers (see -``Documentation/DMA-API-HOWTO.txt``). That's how they've worked through +:doc:`/core-api/dma-api-howto`). That's how they've worked through the 2.4 (and earlier) kernels, or they can now be DMA-aware. DMA-aware usb drivers:@@ -60,7 +60,7 @@ and effects like cache-trashing can impose subtle penalties. force a consistent memory access ordering by using memory barriers. It's not using a streaming DMA mapping, so it's good for small transfers on systems where the I/O would otherwise thrash an IOMMU mapping. (See - ``Documentation/DMA-API-HOWTO.txt`` for definitions of "coherent" and + :doc:`/core-api/dma-api-howto` for definitions of "coherent" and "streaming" DMA mappings.) Asking for 1/Nth of a page (as well as asking for N pages) is reasonably@@ -91,7 +91,7 @@ Working with existing buffers Existing buffers aren't usable for DMA without first being mapped into the DMA address space of the device. However, most buffers passed to your driver can safely be used with such DMA mapping. (See the first section -of Documentation/DMA-API-HOWTO.txt, titled "What memory is DMA-able?") +of :doc:`/core-api/dma-api-howto`, titled "What memory is DMA-able?") - When you're using scatterlists, you can map everything at once. On some systems, this kicks in an IOMMU and turns the scatterlists into singleDocumentation/memory-barriers.txt +3
-3@@ -546,8 +546,8 @@ There are certain things that the Linux kernel memory barriers do not guarantee: [*] For information on bus mastering DMA and coherency please read: Documentation/driver-api/pci/pci.rst - Documentation/DMA-API-HOWTO.txt - Documentation/DMA-API.txt + Documentation/core-api/dma-api-howto.rst + Documentation/core-api/dma-api.rst DATA DEPENDENCY BARRIERS (HISTORICAL)@@ -1932,7 +1932,7 @@ There are some more advanced barrier functions: here. See the subsection "Kernel I/O barrier effects" for more information on - relaxed I/O accessors and the Documentation/DMA-API.txt file for more + relaxed I/O accessors and the Documentation/core-api/dma-api.rst file for more information on consistent memory.Documentation/translations/ko_KR/memory-barriers.txt +3
-3@@ -570,8 +570,8 @@ ACQUIRE 는 해당 오퍼레이션의 로드 부분에만 적용되고 RELEASE [*] 버스 마스터링 DMA 와 일관성에 대해서는 다음을 참고하시기 바랍니다: Documentation/driver-api/pci/pci.rst - Documentation/DMA-API-HOWTO.txt - Documentation/DMA-API.txt + Documentation/core-api/dma-api-howto.rst + Documentation/core-api/dma-api.rst 데이터 의존성 배리어 (역사적)@@ -1907,7 +1907,7 @@ Mandatory 배리어들은 SMP 시스템에서도 UP 시스템에서도 SMP 효 writel_relaxed() 와 같은 완화된 I/O 접근자들에 대한 자세한 내용을 위해서는 "커널 I/O 배리어의 효과" 섹션을, consistent memory 에 대한 자세한 내용을 - 위해선 Documentation/DMA-API.txt 문서를 참고하세요. + 위해선 Documentation/core-api/dma-api.rst 문서를 참고하세요. =========================arch/ia64/hp/common/sba_iommu.c +6
-6@@ -907,7 +907,7 @@ sba_mark_invalid(struct ioc *ioc, dma_addr_t iova, size_t byte_cnt)* @dir: dma direction * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static dma_addr_t sba_map_page(struct device *dev, struct page *page, unsigned long poff, size_t size,@@ -1028,7 +1028,7 @@ sba_mark_clean(struct ioc *ioc, dma_addr_t iova, size_t size)* @dir: R/W or both. * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void sba_unmap_page (struct device *dev,dma_addr_t iova,size_t size,enum dma_data_direction dir,unsigned long attrs)@@ -1105,7 +1105,7 @@ static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,* @size: number of bytes mapped in driver buffer. * @dma_handle: IOVA of new buffer. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void * sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,@@ -1162,7 +1162,7 @@ sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,* @vaddr: virtual address IOVA of "consistent" buffer. * @dma_handler: IO virtual address of "consistent" buffer. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void sba_free_coherent (struct device *dev,size_t size,void *vaddr,dma_addr_t dma_handle,unsigned long attrs)@@ -1425,7 +1425,7 @@ static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist,* @dir: R/W or both. * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist, int nents, enum dma_data_direction dir,@@ -1524,7 +1524,7 @@ static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist,* @dir: R/W or both. * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist, int nents, enum dma_data_direction dir,arch/parisc/kernel/pci-dma.c +1
-1@@ -3,7 +3,7 @@ ** PARISC 1.1 Dynamic DMA mapping support. ** This implementation is for PA-RISC platforms that do not support ** I/O TLBs (aka DMA address translation hardware). -** See Documentation/DMA-API-HOWTO.txt for interface definitions. +** See Documentation/core-api/dma-api-howto.rst for interface definitions. ** ** (c) Copyright 1999,2000 Hewlett-Packard Company ** (c) Copyright 2000 Grant Grundlerarch/x86/include/asm/dma-mapping.h +2
-2@@ -3,8 +3,8 @@#define _ASM_X86_DMA_MAPPING_H/* -* IOMMU interface. See Documentation/DMA-API-HOWTO.txt and -* Documentation/DMA-API.txt for documentation. +* IOMMU interface. See Documentation/core-api/dma-api-howto.rst and +* Documentation/core-api/dma-api.rst for documentation. */ #include <linux/scatterlist.h> arch/x86/kernel/amd_gart_64.c +1
-1@@ -6,7 +6,7 @@* This allows to use PCI devices that only support 32bit addresses on systems * with more than 4GB. * -* See Documentation/DMA-API-HOWTO.txt for the interface specification. +* See Documentation/core-api/dma-api-howto.rst for the interface specification. * * Copyright 2002 Andi Kleen, SuSE Labs. */ drivers/parisc/sba_iommu.c +7
-7@@ -666,7 +666,7 @@ sba_mark_invalid(struct ioc *ioc, dma_addr_t iova, size_t byte_cnt)* @dev: instance of PCI owned by the driver that's asking * @mask: number of address bits this PCI device can handle * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static int sba_dma_supported (struct device *dev,u64 mask) {@@ -698,7 +698,7 @@ static int sba_dma_supported( struct device *dev, u64 mask)* @size: number of bytes to map in driver buffer. * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static dma_addr_t sba_map_single(struct device *dev, void *addr, size_t size,@@ -788,7 +788,7 @@ sba_map_page(struct device *dev, struct page *page, unsigned long offset,* @size: number of bytes mapped in driver buffer. * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,@@ -867,7 +867,7 @@ sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,* @size: number of bytes mapped in driver buffer. * @dma_handle: IOVA of new buffer. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void *sba_alloc (struct device *hwdev,size_t size,dma_addr_t *dma_handle,gfp_t gfp,unsigned long attrs)@@ -898,7 +898,7 @@ static void *sba_alloc(struct device *hwdev, size_t size, dma_addr_t *dma_handle* @vaddr: virtual address IOVA of "consistent" buffer. * @dma_handler: IO virtual address of "consistent" buffer. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void sba_free(struct device *hwdev, size_t size, void *vaddr,@@ -933,7 +933,7 @@ int dump_run_sg = 0;* @nents: number of entries in list * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static int sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents,@@ -1017,7 +1017,7 @@ sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents,* @nents: number of entries in list * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.txt +* See Documentation/core-api/dma-api-howto.rst */ static void sba_unmap_sg(struct device *dev, struct scatterlist *sglist, int nents,include/linux/dma-mapping.h +1
-1@@ -14,7 +14,7 @@/** * List of possible attributes associated with a DMA mapping. The semantics -* of each attribute should be defined in Documentation/DMA-attributes.txt. +* of each attribute should be defined in Documentation/core-api/dma-attributes.rst. */ /* include/media/videobuf-dma-sg.h +1
-1@@ -31,7 +31,7 @@* does memory allocation too using vmalloc_32(). * * videobuf_dma_*() -* see Documentation/DMA-API-HOWTO.txt, these functions to +* see Documentation/core-api/dma-api-howto.rst, these functions to * basically the same. The map function does also build a * scatterlist for the buffer (and unmap frees it ...) * kernel/dma/debug.c +1
-1@@ -1071,7 +1071,7 @@ static void check_unmap(struct dma_debug_entry *ref)/* * Drivers should use dma_mapping_error() to check the returned * addresses of dma_map_single() and dma_map_page(). -* If not, print this warning message. See Documentation/DMA-API.txt. +* If not, print this warning message. See Documentation/core-api/dma-api.rst. */ if (entry->map_err_type ==MAP_ERR_NOT_CHECKED ) { err_printk(ref->dev, entry,Signature · 1 line
2.26.2
Re: [PATCH 15/29] dt: fix reference to olpc,xo1.75-ec.txt
In reply to Mauro Carvalho ChehabQuoted 4 lines · Mauro Carvalho Chehab
This file was converted and renamed.
Fixes 7882d822b3f9 ("dt-bindings: spi: Convert spi-pxa2xx to json-schema")Signed-off-by Mauro Carvalho Chehab <[email protected]>
Thank you,
I'm wondering -- which tree is this targetted for? I may end up converting the XO-1.75 EC docs to YAML for 5.9, and I suppose I'd need to base it on this and send it in the same direction.
Lubo
Quoted 20 lines
--- Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.txt +1
-1@@ -8,7 +8,7 @@ The embedded controller requires the SPI controller driver to signal readiness to receive a transfer (that is, when TX FIFO contains the response data) by strobing the ACK pin with the ready signal. See the "ready-gpios" property of the SSP binding as documented in: -<Documentation/devicetree/bindings/spi/spi-pxa2xx.txt>. +<Documentation/devicetree/bindings/spi/marvell,mmp2-ssp.yaml>. Example: &ssp3 {Signature · 1 line
2.26.2
Re: [PATCH 12/29] dt: update a reference for reneases pcar file renamed to yaml
In reply to Mauro Carvalho ChehabQuoted 9 lines · Mauro Carvalho Chehab
This file was renamed, but its reference at pfc-pinctl.txt is still pointing to the old file.
Fixes 7f7d408e5a00 ("dt-bindings: gpio: rcar: Convert to json-schema")Signed-off-by Mauro Carvalho Chehab <[email protected]>--- .../devicetree/bindings/pinctrl/renesas,pfc-pinctrl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Applied, thanks!
Re: [PATCH 13/29] dt: fix broken links due to txt->yaml renames
In reply to Mauro Carvalho ChehabQuoted 11 lines · Mauro Carvalho Chehab
There are some new broken doc links due to yaml renames at DT. Developers should really run:
./scripts/documentation-file-ref-checkin order to solve those issues while submitting patches. This tool can even fix most of the issues with:
./scripts/documentation-file-ref-check --fixSigned-off-by Mauro Carvalho Chehab <[email protected]>
Quoted 10 lines
--- Documentation/devicetree/bindings/display/bridge/sii902x.txt | 2 +- .../devicetree/bindings/display/rockchip/rockchip-drm.yaml | 2 +- Documentation/devicetree/bindings/net/mediatek-bluetooth.txt | 2 +- Documentation/devicetree/bindings/sound/audio-graph-card.txt | 2 +- Documentation/devicetree/bindings/sound/st,sti-asoc-card.txt | 2 +- Documentation/mips/ingenic-tcu.rst | 2 +- MAINTAINERS | 4 ++-- 7 files changed, 8 insertions(+), 8 deletions(-)
Applied, thanks!
Rob Herring
maintainerRe: [PATCH 14/29] dt: Fix broken references to renamed docs
In reply to Mauro Carvalho ChehabQuoted 4 lines · Mauro Carvalho Chehab
Some files got renamed. Those were all fixed automatically by
./scripts/documentation-file-ref-check --fix
Quoted 9 lines
Signed-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt | 2 +- Documentation/devicetree/bindings/display/imx/fsl-imx-drm.txt | 4 ++-- Documentation/devicetree/bindings/display/imx/ldb.txt | 4 ++-- Documentation/devicetree/bindings/spi/qcom,spi-geni-qcom.txt | 2 +- MAINTAINERS | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-)
Applied, thanks!
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Re: [PATCH 15/29] dt: fix reference to olpc,xo1.75-ec.txt
In reply to Mauro Carvalho ChehabQuoted 8 lines · Mauro Carvalho Chehab
This file was converted and renamed.
Fixes 7882d822b3f9 ("dt-bindings: spi: Convert spi-pxa2xx to json-schema")Signed-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Applied, thanks!
Re: [PATCH 27/29] docs: dt: minor adjustments at writing-schema.rst
In reply to Mauro Carvalho ChehabQuoted 9 lines · Mauro Carvalho Chehab
There are two literal blocks that aren't mark as such. Mark them, in order to make the document to produce a better html output.
While here, also add a SPDX header to it.
Signed-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/devicetree/writing-schema.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
Applied, thanks.
Rob
Re: [PATCH 21/29] docs: device-mapper: add dm-ebs.rst to an index file
In reply to Mauro Carvalho ChehabQuoted 23 lines · Mauro Carvalho Chehab
Solves this Sphinx warning:
Documentation/admin-guide/device-mapper/dm-ebs.rst: WARNING: document isn't included in any toctreeSigned-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/admin-guide/device-mapper/index.rst | 1 + 1 file changed, 1 insertion(+)Documentation/admin-guide/device-mapper/index.rst +1
-0@@ -11,6 +11,7 @@ Device Mapper dm-clone dm-crypt dm-dust + dm-ebs dm-flakey dm-init dm-integritySignature · 1 line
2.26.2
Didn't see this fix staged in linux-next so I've picked it up for 5.8.
Thanks,
Mike