htmldoc build fixes with Sphinx 2.x and 3.x
Subsystems (56)
PATCH v6 49/80 docs: conf.py: fix c:function support with Sphinx 3.x
In reply to Mauro Carvalho ChehabSphinx C parser for the C domain is now more pedantic when trying to identify the function types. That prevents scope macros to be used as type defines.
Yet, since 3.0.2, it is possible to provide it a list of such macros. Add them, in order to solve several Sphinx 3.x warnings.
--- Documentation/conf.py | 65 +++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 62 insertions(+), 3 deletions(-)
Documentation/conf.py +62 -3
@@ -47,9 +47,68 @@ extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', # if major >= 3: sys.stderr.write('''WARNING: The kernel documentation build process - does not work correctly with Sphinx v3.0 and above. Expect errors - in the generated output. - ''') + does not work correctly with Sphinx v3.0 and above. Expect errors + in the generated output. + ''') + if minor > 0 or patch >= 2: + # Sphinx c function parser is more pedantic with regards to type + # checking. Due to that, having macros at c:function cause problems. + # Those needed to be scaped by using c_id_attributes[] array + c_id_attributes = [ + # GCC Compiler types not parsed by Sphinx: + "__restrict__", + + # include/linux/compiler_types.h: + "__iomem", + "__kernel", + "noinstr", + "notrace", + "__percpu", + "__rcu", + "__user", + + # include/linux/compiler_attributes.h: + "__alias", + "__aligned", + "__aligned_largest", + "__always_inline", + "__assume_aligned", + "__cold", + "__attribute_const__", + "__copy", + "__pure", + "__designated_init", + "__visible", + "__printf", + "__scanf", + "__gnu_inline", + "__malloc", + "__mode", + "__no_caller_saved_registers", + "__noclone", + "__nonstring", + "__noreturn", + "__packed", + "__pure", + "__section", + "__always_unused", + "__maybe_unused", + "__used", + "__weak", + "noinline", + + # include/linux/memblock.h: + "__init_memblock", + "__meminit", + + # include/linux/init.h: + "__init", + "__ref", + + # include/linux/linkage.h: + "asmlinkage", + ] + else: extensions.append('cdomain')
Signature · 1 line
2.26.2
PATCH v6 50/80 docs: conf.py: change the Sphinx 3.x+ text
In reply to Mauro Carvalho ChehabAfter the build fix patches, it is believed that the output with Sphinx 3.x won't be a problem. Still, the C domain support was re-written, and this can have caused hidden issues.
So, let's keep the warning, changing it to a lighter warning text.
--- Documentation/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/conf.py +2 -2
@@ -47,8 +47,8 @@ extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', # if major >= 3: sys.stderr.write('''WARNING: The kernel documentation build process - does not work correctly with Sphinx v3.0 and above. Expect errors - in the generated output. + support for Sphinx v3.0 and above is brand new. Be prepared for + possible issues in the generated output. ''') if minor > 0 or patch >= 2: # Sphinx c function parser is more pedantic with regards to type
Signature · 1 line
2.26.2
PATCH v6 51/80 docs: infrastructure.rst: exclude device_link_state from device.h
In reply to Mauro Carvalho ChehabThis is already documented at device_link.rst, causing this warning, due to a broken cross-reference:
.../Documentation/driver-api/device_link.rst: WARNING: Duplicate C declaration, also defined in 'driver-api/infrastructure'. Declaration is 'device_link_state'.
--- Documentation/driver-api/infrastructure.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/driver-api/infrastructure.rst +1 -0
@@ -6,6 +6,7 @@ The Basic Device Driver-Model Structures .. kernel-doc:: include/linux/device.h :internal: + :no-identifiers: device_link_state Device Drivers Base -------------------
Signature · 1 line
2.26.2
PATCH v6 52/80 docs: zh_CN: amu.rst: fix document title markup
In reply to Mauro Carvalho ChehabAs warned by Sphinx 2.4.4:
.../Documentation/translations/zh_CN/arm64/amu.rst:7: WARNING: Title overline too short.
Increase its size.
--- Documentation/translations/zh_CN/arm64/amu.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/translations/zh_CN/arm64/amu.rst +2 -2
@@ -4,9 +4,9 @@ Translator: Bailu Lin <[email protected]> -================================= +================================== AArch64 Linux 中扩展的活动监控单元 -================================= +================================== 作者: Ionela Voinescu <[email protected]>
Signature · 1 line
2.26.2
PATCH v6 53/80 media: uAPI: buffer.rst: remove a left-over documentation
In reply to Mauro Carvalho ChehabChangeset 129134e5415d ("media: media/v4l2: remove V4L2_FLAG_MEMORY_NON_CONSISTENT flag") reverted an uAPI flag, but it kept some left-overs at the documentation.
Drop them too. This should solve this warning:
Documentation/userspace-api/media/v4l/buffer.rst:692: WARNING: The "flat-table" directive is empty; content required.
.. flat-table::
:header-rows: 0
:stub-columns: 0
:widths: 3 1 4
--- Documentation/userspace-api/media/v4l/buffer.rst | 14 -------------- 1 file changed, 14 deletions(-)
Documentation/userspace-api/media/v4l/buffer.rst +0 -14
@@ -678,20 +678,6 @@ Buffer Flags .. _memory-flags: -Memory Consistency Flags -======================== - -.. tabularcolumns:: |p{7.0cm}|p{2.2cm}|p{8.3cm}| - -.. cssclass:: longtable - -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 - :widths: 3 1 4 - -.. c:type:: v4l2_memory - enum v4l2_memory ================
Signature · 1 line
2.26.2
PATCH v6 54/80 math64.h: kernel-docs: Convert some markups into normal comments
In reply to Mauro Carvalho ChehabThere are several functions at math64.h that are also defined at div64.c. As both are included at kernel-api.rst, Sphinx 3.x complains about symbol duplication:
./lib/math/div64.c:73: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'. Declaration is 'div_s64_rem'.
./lib/math/div64.c:104: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'. Declaration is 'div64_u64_rem'.
./lib/math/div64.c:144: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'. Declaration is 'div64_u64'.
./lib/math/div64.c:172: WARNING: Duplicate C declaration, also defined in 'core-api/kernel-api'. Declaration is 'div64_s64'.
In order to avoid Sphinx warnings about duplication, change the kernel-doc markups to just comments at math64.h.
--- include/linux/math64.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
include/linux/math64.h +4 -4
@@ -28,7 +28,7 @@ static inline u64 div_u64_rem(u64 dividend, u32 divisor, u32 *remainder)return dividend / divisor; } -/** +/* * div_s64_rem - signed 64bit divide with 32bit divisor with remainder * @dividend: signed 64bit dividend * @divisor: signed 32bit divisor
@@ -42,7 +42,7 @@ static inline s64 div_s64_rem(s64 dividend, s32 divisor, s32 *remainder)return dividend / divisor; } -/** +/* * div64_u64_rem - unsigned 64bit divide with 64bit divisor and remainder * @dividend: unsigned 64bit dividend * @divisor: unsigned 64bit divisor
@@ -56,7 +56,7 @@ static inline u64 div64_u64_rem(u64 dividend, u64 divisor, u64 *remainder)return dividend / divisor; } -/** +/* * div64_u64 - unsigned 64bit divide with 64bit divisor * @dividend: unsigned 64bit dividend * @divisor: unsigned 64bit divisor
@@ -68,7 +68,7 @@ static inline u64 div64_u64(u64 dividend, u64 divisor)return dividend / divisor; } -/** +/* * div64_s64 - signed 64bit divide with 64bit divisor * @dividend: signed 64bit dividend * @divisor: signed 64bit divisor
Signature · 1 line
2.26.2
PATCH v6 55/80 memblock: get rid of a :c:type leftover
In reply to Mauro Carvalho Chehabchanseset b3a7bb1851c8 ("docs: get rid of :c:type explicit declarations for structs") removed several :c:type: markups, except by one.
Now, Sphinx 3.x complains about it:
.../Documentation/core-api/boot-time-mm:26: ../mm/memblock.c:51: WARNING: Unparseable C cross-reference: 'struct\nmemblock_type' Invalid C declaration: Expected identifier in nested name, got keyword: struct [error at 6]
struct
memblock_type
------^
As, on Sphinx 3.x, the right markup is c:struct:foo.
So, let's remove it, relying on automarkup.py to convert it.
--- mm/memblock.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
mm/memblock.c +2 -2
@@ -50,8 +50,8 @@* * Each region is represented by struct memblock_region that * defines the region extents, its attributes and NUMA node id on NUMA -* systems. Every memory type is described by the :c:type:`struct -* memblock_type` which contains an array of memory regions along with +* systems. Every memory type is described by the struct memblock_type +* which contains an array of memory regions along with * the allocator metadata. The "memory" and "reserved" types are nicely * wrapped with struct memblock. This structure is statically * initialized at build time. The region arrays are initially sized to
Signature · 1 line
2.26.2
Re: [PATCH v6 55/80] memblock: get rid of a :c:type leftover
Quoted 11 lines · Mauro Carvalho Chehab
chanseset
b3a7bb1851c8("docs: get rid of :c:type explicit declarations for structs") removed several :c:type: markups, except by one.Now, Sphinx 3.x complains about it:
.../Documentation/core-api/boot-time-mm:26:
../mm/memblock.c:51: WARNING: Unparseable C cross-reference: 'struct\nmemblock_type' Invalid C declaration: Expected identifier in nested name, got keyword: struct [error at 6]
struct
memblock_type
------^
Quoted 5 lines
As, on Sphinx 3.x, the right markup is c:struct:
foo.So, let's remove it, relying on
automarkup.pyto convert it.Signed-off-by Mauro Carvalho Chehab <[email protected]>
Quoted 22 lines
--- mm/memblock.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)mm/memblock.c +2
-2@@ -50,8 +50,8 @@* * Each region is represented by struct memblock_region that * defines the region extents, its attributes and NUMA node id on NUMA -* systems. Every memory type is described by the :c:type:`struct -* memblock_type` which contains an array of memory regions along with +* systems. Every memory type is described by the struct memblock_type +* which contains an array of memory regions along with * the allocator metadata. The "memory" and "reserved" types are nicely * wrapped with struct memblock. This structure is statically * initialized at build time. The region arrays are initially sized to Signature · 1 line
2.26.2
Signature · 2 lines
Sincerely yours, Mike.
PATCH v6 56/80 dt-bindings: fix references to files converted to yaml
In reply to Mauro Carvalho ChehabThere were several files converted to yaml, but the .txt file is still referenced somewhere else.
Update the references for them to point to the right file.
--- .../bindings/display/tilcdc/tilcdc.txt | 2 +- .../devicetree/bindings/mailbox/omap-mailbox.txt | 2 +- .../devicetree/bindings/media/i2c/tvp5150.txt | 2 +- .../bindings/pwm/google,cros-ec-pwm.yaml | 2 +- .../bindings/soc/qcom/qcom,smd-rpm.yaml | 2 +- .../bindings/sound/google,cros-ec-codec.yaml | 2 +- MAINTAINERS | 16 ++++++++-------- 7 files changed, 14 insertions(+), 14 deletions(-)
Documentation/devicetree/bindings/display/tilcdc/tilcdc.txt +1 -1
@@ -37,7 +37,7 @@ Optional nodes: supports a single port with a single endpoint. - See also Documentation/devicetree/bindings/display/tilcdc/panel.txt and - Documentation/devicetree/bindings/display/bridge/ti,tfp410.txt for connecting + Documentation/devicetree/bindings/display/bridge/ti,tfp410.yaml for connecting tfp410 DVI encoder or lcd panel to lcdc [1] There is an errata about AM335x color wiring. For 16-bit color mode
Documentation/devicetree/bindings/mailbox/omap-mailbox.txt +1 -1
@@ -69,7 +69,7 @@ The following are mandatory properties for the K3 AM65x and J721E SoCs only: the interrupt routes between the IP and the main GIC controllers. See the following binding for additional details, - Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.txt + Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml Child Nodes: ============
Documentation/devicetree/bindings/media/i2c/tvp5150.txt +1 -1
@@ -56,7 +56,7 @@ Optional Connector Properties: instead of using the autodetection mechnism. Please look at [1] for more information. -[1] Documentation/devicetree/bindings/display/connector/analog-tv-connector.txt. +[1] Documentation/devicetree/bindings/display/connector/analog-tv-connector.yaml. Example - three input sources: #include <dt-bindings/display/sdtv-standards.h>
Documentation/devicetree/bindings/pwm/google,cros-ec-pwm.yaml +1 -1
@@ -14,7 +14,7 @@ description: | Google's ChromeOS EC PWM is a simple PWM attached to the Embedded Controller (EC) and controlled via a host-command interface. An EC PWM node should be only found as a sub-node of the EC node (see - Documentation/devicetree/bindings/mfd/cros-ec.txt). + Documentation/devicetree/bindings/mfd/google,cros-ec.yaml). properties: compatible:
Documentation/devicetree/bindings/soc/qcom/qcom,smd-rpm.yaml +1 -1
@@ -20,7 +20,7 @@ description: | present and this subnode may contain children that designate regulator resources. - Refer to Documentation/devicetree/bindings/regulator/qcom,smd-rpm-regulator.txt + Refer to Documentation/devicetree/bindings/regulator/qcom,smd-rpm-regulator.yaml for information on the regulator subnodes that can exist under the rpm_requests.
Documentation/devicetree/bindings/sound/google,cros-ec-codec.yaml +1 -1
@@ -13,7 +13,7 @@ description: | Google's ChromeOS EC codec is a digital mic codec provided by the Embedded Controller (EC) and is controlled via a host-command interface. An EC codec node should only be found as a sub-node of the EC node (see - Documentation/devicetree/bindings/mfd/cros-ec.txt). + Documentation/devicetree/bindings/mfd/google,cros-ec.yaml). properties: compatible:
MAINTAINERS +8 -8
@@ -1523,7 +1523,7 @@ L: [email protected] (moderated for non-subscribers) S: Maintained F: Documentation/devicetree/bindings/arm/actions.yaml F: Documentation/devicetree/bindings/clock/actions,owl-cmu.txt -F: Documentation/devicetree/bindings/dma/owl-dma.txt +F: Documentation/devicetree/bindings/dma/owl-dma.yaml F: Documentation/devicetree/bindings/i2c/i2c-owl.txt F: Documentation/devicetree/bindings/mmc/owl-mmc.yaml F: Documentation/devicetree/bindings/pinctrl/actions,s900-pinctrl.txt
@@ -5827,7 +5827,7 @@ L: [email protected] S: Supported T: git git://linuxtv.org/pinchartl/media drm/du/next F: Documentation/devicetree/bindings/display/bridge/renesas,dw-hdmi.txt -F: Documentation/devicetree/bindings/display/bridge/renesas,lvds.txt +F: Documentation/devicetree/bindings/display/bridge/renesas,lvds.yaml F: Documentation/devicetree/bindings/display/renesas,du.txt F: drivers/gpu/drm/rcar-du/ F: drivers/gpu/drm/shmobile/
@@ -6952,7 +6952,7 @@ M: Frank Li <[email protected]> L: [email protected] S: Maintained F: Documentation/admin-guide/perf/imx-ddr.rst -F: Documentation/devicetree/bindings/perf/fsl-imx-ddr.txt +F: Documentation/devicetree/bindings/perf/fsl-imx-ddr.yaml F: drivers/perf/fsl_imx8_ddr_perf.c FREESCALE IMX I2C DRIVER
@@ -6960,7 +6960,7 @@ M: Oleksij Rempel <[email protected]> R: Pengutronix Kernel Team <[email protected]> L: [email protected] S: Maintained -F: Documentation/devicetree/bindings/i2c/i2c-imx.txt +F: Documentation/devicetree/bindings/i2c/i2c-imx.yaml F: drivers/i2c/busses/i2c-imx.c FREESCALE IMX LPI2C DRIVER
@@ -6968,7 +6968,7 @@ M: Dong Aisheng <[email protected]> L: [email protected] L: [email protected] S: Maintained -F: Documentation/devicetree/bindings/i2c/i2c-imx-lpi2c.txt +F: Documentation/devicetree/bindings/i2c/i2c-imx-lpi2c.yaml F: drivers/i2c/busses/i2c-imx-lpi2c.c FREESCALE QORIQ DPAA ETHERNET DRIVER
@@ -11600,7 +11600,7 @@ MIPS GENERIC PLATFORM M: Paul Burton <[email protected]> L: [email protected] S: Supported -F: Documentation/devicetree/bindings/power/mti,mips-cpc.txt +F: Documentation/devicetree/bindings/power/mti,mips-cpc.yaml F: arch/mips/generic/ F: arch/mips/tools/generic-board-config.sh
@@ -12455,7 +12455,7 @@ NXP SGTL5000 DRIVER M: Fabio Estevam <[email protected]> L: [email protected] (moderated for non-subscribers) S: Maintained -F: Documentation/devicetree/bindings/sound/sgtl5000.txt +F: Documentation/devicetree/bindings/sound/sgtl5000.yaml F: sound/soc/codecs/sgtl5000* NXP SJA1105 ETHERNET SWITCH DRIVER
@@ -16737,7 +16737,7 @@ SYNOPSYS DESIGNWARE DMAC DRIVER M: Viresh Kumar <[email protected]> R: Andy Shevchenko <[email protected]> S: Maintained -F: Documentation/devicetree/bindings/dma/snps-dma.txt +F: Documentation/devicetree/bindings/dma/snps,dma-spear1340.yaml F: drivers/dma/dw/ F: include/dt-bindings/dma/dw-dmac.h F: include/linux/dma/dw.h
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v6 57/80 net: appletalk: Kconfig: Fix docs location
In reply to Mauro Carvalho ChehabThe location of ltpc.rst changed. Update it at Kconfig.
--- drivers/net/appletalk/Kconfig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/net/appletalk/Kconfig +1 -1
@@ -48,7 +48,7 @@ config LTPC If you are in doubt, this card is the one with the 65C02 chip on it. You also need version 1.3.3 or later of the netatalk package. This driver is experimental, which means that it may not work. - See the file <file:Documentation/networking/ltpc.rst>. + See the file <file:Documentation/networking/device_drivers/appletalk/ltpc.rst>. config COPS tristate "COPS LocalTalk PC support"
Signature · 1 line
2.26.2
PATCH v6 58/80 drivers: net: hamradio: fix document location
In reply to Mauro Carvalho ChehabThe hamradio docs were moved to a different dir.
Update its location accordingly.
--- drivers/net/hamradio/scc.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/net/hamradio/scc.c +1 -1
@@ -7,7 +7,7 @@* ------------------ * * You can find a subset of the documentation in -* Documentation/networking/device_drivers/wan/z8530drv.rst. +* Documentation/networking/device_drivers/hamradio/z8530drv.rst. */ /*
Signature · 1 line
2.26.2
PATCH v6 59/80 docs: powerpc: syscall64-abi.rst: fix a malformed table
In reply to Mauro Carvalho ChehabAs reported:
Documentation/powerpc/syscall64-abi.rst:53: WARNING: Malformed table. Text in column margin in table line 2.
=========== ============= ======================================== --- For the sc instruction, differences with the ELF ABI ---
r0 Volatile (System call number.)
This table requires a different notation to be valid.
--- Documentation/powerpc/syscall64-abi.rst | 32 ++++++++++++------------- 1 file changed, 16 insertions(+), 16 deletions(-)
Documentation/powerpc/syscall64-abi.rst +16 -16
@@ -49,22 +49,22 @@ Register preservation rules Register preservation rules match the ELF ABI calling sequence with the following differences: ---- For the sc instruction, differences with the ELF ABI --- -=========== ============= ======================================== -r0 Volatile (System call number.) -r3 Volatile (Parameter 1, and return value.) -r4-r8 Volatile (Parameters 2-6.) -cr0 Volatile (cr0.SO is the return error condition.) -cr1, cr5-7 Nonvolatile -lr Nonvolatile -=========== ============= ======================================== - ---- For the scv 0 instruction, differences with the ELF ABI --- -=========== ============= ======================================== -r0 Volatile (System call number.) -r3 Volatile (Parameter 1, and return value.) -r4-r8 Volatile (Parameters 2-6.) -=========== ============= ======================================== ++------------------------------------------------------------------------+ +| For the sc instruction, differences with the ELF ABI | ++--------------+--------------+------------------------------------------+ +| r0 | Volatile | (System call number.) | +| rr3 | Volatile | (Parameter 1, and return value.) | +| rr4-r8 | Volatile | (Parameters 2-6.) | +| rcr0 | Volatile | (cr0.SO is the return error condition.) | +| rcr1, cr5-7 | Nonvolatile | | +| rlr | Nonvolatile | | ++--------------+--------------+------------------------------------------+ +| For the scv 0 instruction, differences with the ELF ABI | ++--------------+--------------+------------------------------------------+ +| r0 | Volatile | (System call number.) | +| r3 | Volatile | (Parameter 1, and return value.) | +| r4-r8 | Volatile | (Parameters 2-6.) | ++--------------+--------------+------------------------------------------+ All floating point and vector data registers as well as control and status registers are nonvolatile.
Signature · 1 line
2.26.2
PATCH v6 60/80 block: bio: fix a warning at the kernel-doc markups
In reply to Mauro Carvalho ChehabUsing "@bio's parent" causes the following waring:
./block/bio.c:10: WARNING: Inline emphasis start-string without end-string.
The main problem here is that this would be converted into:
**bio**'s parent
By kernel-doc, which is not a valid notation. It would be possible to use, instead, this kernel-doc markup:
``bio's`` parent
Yet, here, is probably simpler to just use an altenative language:
the parent of @bio
--- block/bio.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
block/bio.c +1 -1
@@ -327,7 +327,7 @@ static void bio_chain_endio(struct bio *bio)/** * bio_chain - chain bio completions * @bio: the target bio -* @parent: the @bio's parent bio +* @parent: the parent bio of @bio * * The caller won't have a bi_end_io called when @bio completes - instead, * @parent's bi_end_io won't be called until both @parent and @bio have
Signature · 1 line
2.26.2
PATCH v6 61/80 kunit: test.h: solve kernel-doc warnings
In reply to Mauro Carvalho ChehabThere are some warnings there:
./include/kunit/test.h:90: warning: Function parameter or member 'name' not described in 'kunit_resource' ./include/kunit/test.h:353: warning: Function parameter or member 'res' not described in 'kunit_add_resource' ./include/kunit/test.h:367: warning: Function parameter or member 'res' not described in 'kunit_add_named_resource' ./include/kunit/test.h:367: warning: Function parameter or member 'name' not described in 'kunit_add_named_resource' ./include/kunit/test.h:367: warning: Function parameter or member 'data' not described in 'kunit_add_named_resource' ./include/kunit/test.h:367: warning: Excess function parameter 'name_data' description in 'kunit_add_named_resource'
Address them, ensuring that all non-private arguments will be properly described. With that regards, at struct kunit_resource, the free argument is described as user-provided. So, this doesn't seem to belong to the "private" part of the struct.
--- include/kunit/test.h | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-)
include/kunit/test.h +8 -4
@@ -25,6 +25,7 @@ typedef void (*kunit_resource_free_t)(struct kunit_resource *);/** * struct kunit_resource - represents a *test managed resource* * @data: for the user to store arbitrary data. +* @name: optional name * @free: a user supplied function to free the resource. Populated by * kunit_resource_alloc(). *
@@ -80,10 +81,10 @@ typedef void (*kunit_resource_free_t)(struct kunit_resource *);*/ struct kunit_resource {void *data; -const char *name;/* optional name */ - -/* private: internal use only. */ +const char *name;kunit_resource_free_t free; + +/* private: internal use only. */ struct kref refcount;struct list_head node; };
@@ -343,6 +344,7 @@ static inline void kunit_put_resource(struct kunit_resource *res)* none is supplied, the resource data value is simply set to @data. * If an init function is supplied, @data is passed to it instead. * @free: a user-supplied function to free the resource (if needed). +* @res: The resource. * @data: value to pass to init function or set in resource data field. */ int kunit_add_resource(struct kunit *test,
@@ -356,7 +358,9 @@ int kunit_add_resource(struct kunit *test,* @test: The test context object. * @init: a user-supplied function to initialize the resource data, if needed. * @free: a user-supplied function to free the resource data, if needed. -* @name_data: name and data to be set for resource. +* @res: The resource. +* @name: name to be set for resource. +* @data: value to pass to init function or set in resource data field. */ int kunit_add_named_resource(struct kunit *test, kunit_resource_init_t init,
Signature · 1 line
2.26.2
PATCH v6 62/80 docs: bio: fix a kerneldoc markup
In reply to Mauro Carvalho ChehabFix this warning:
./block/bio.c:1098: WARNING: Inline emphasis start-string without end-string.
The thing is that *iter is not a valid markup.
That seems to be a typo:
*iter -> @iter
--- block/bio.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
block/bio.c +1 -1
@@ -1095,7 +1095,7 @@ static int __bio_iov_append_get_pages(struct bio *bio, struct iov_iter *iter)* released. * * The function tries, but does not guarantee, to pin as many pages as -* fit into the bio, or are requested in *iter, whatever is smaller. If +* fit into the bio, or are requested in @iter, whatever is smaller. If * MM encounters an error pinning the requested pages, it stops. Error * is returned only if 0 pages could be pinned. */
Signature · 1 line
2.26.2
PATCH v6 63/80 drivers: core: fix kernel-doc markup for dev_err_probe()
In reply to Mauro Carvalho ChehabThere are two literal blocks there. Fix the markups, in order to produce the right html output and solve those warnings:
./drivers/base/core.c:4218: WARNING: Unexpected indentation. ./drivers/base/core.c:4222: WARNING: Definition list ends without a blank line; unexpected unindent. ./drivers/base/core.c:4223: WARNING: Block quote ends without a blank line; unexpected unindent.
--- drivers/base/core.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
drivers/base/core.c +5 -2
@@ -4211,13 +4211,16 @@ define_dev_printk_level(_dev_info, KERN_INFO);* -EPROBE_DEFER and propagate error upwards. * In case of -EPROBE_DEFER it sets also defer probe reason, which can be * checked later by reading devices_deferred debugfs attribute. -* It replaces code sequence: +* It replaces code sequence:: +* * if (err != -EPROBE_DEFER) * dev_err(dev, ...); * else * dev_dbg(dev, ...); * return err; -* with +* +* with:: +* * return dev_err_probe(dev, err, ...); * * Returns @err.
Signature · 1 line
2.26.2
PATCH v6 64/80 kunit: test.h: fix a bad kernel-doc markup
In reply to Mauro Carvalho ChehabAs warned by:
./include/kunit/test.h:504: WARNING: Block quote ends without a blank line; unexpected unindent.
The right way to describe a function is:
name - description
Instead, kunit_remove_resource was using:
name: description
Causing it to be improperly parsed.
--- include/kunit/test.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
include/kunit/test.h +2 -2
@@ -498,8 +498,8 @@ static inline int kunit_destroy_named_resource(struct kunit *test, }/** -* kunit_remove_resource: remove resource from resource list associated with -* test. +* kunit_remove_resource() - remove resource from resource list associated with +* test. * @test: The test context object. * @res: The resource to be removed. *
Signature · 1 line
2.26.2
PATCH v6 65/80 docs: amdgpu: fix a warning when building the documentation
In reply to Mauro Carvalho ChehabAs reported by Sphinx:
Documentation/gpu/amdgpu.rst:200: WARNING: Inline emphasis start-string without end-string.
--- Documentation/gpu/amdgpu.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/gpu/amdgpu.rst +2 -2
@@ -197,8 +197,8 @@ pp_power_profile_mode .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c :doc: pp_power_profile_mode -*_busy_percent -~~~~~~~~~~~~~~ +\*_busy_percent +~~~~~~~~~~~~~~~ .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c :doc: gpu_busy_percent
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
Alex Deucher
AppliedRe: [PATCH v6 65/80] docs: amdgpu: fix a warning when building the documentation
Applied. Thanks!
Alex
Quoted 32 lines · Mauro Carvalho Chehab
As reported by Sphinx:
Documentation/gpu/amdgpu.rst:200: WARNING: Inline emphasis start-string without end-string.Signed-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/gpu/amdgpu.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)Documentation/gpu/amdgpu.rst +2
-3@@ -197,8 +197,8 @@ pp_power_profile_mode .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c :doc: pp_power_profile_mode -*_busy_percent -~~~~~~~~~~~~~~ +\*_busy_percent +~~~~~~~~~~~~~~~ .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c :doc: gpu_busy_percent --2.26.2
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v6 66/80 locking/refcount: document the new "oldp" pointer value
In reply to Mauro Carvalho ChehabChangeset a435b9a14356 ("locking/refcount: Provide __refcount API to obtain the old value") added a new parameter to most refcount functions, but didn't update
the kernel-doc markups.
Add a description for it on all touched functions.
--- include/linux/refcount.h | 7 +++++++ 1 file changed, 7 insertions(+)
include/linux/refcount.h +7 -0
@@ -151,6 +151,7 @@ static inline unsigned int refcount_read(const refcount_t *r)* refcount_add_not_zero - add a value to a refcount unless it is 0 * @i: the value to add to the refcount * @r: the refcount +* @oldp: if not NULL, stores the previous value of the refcount * * Will saturate at REFCOUNT_SATURATED and WARN. *
@@ -184,6 +185,7 @@ static inline __must_check bool refcount_add_not_zero(int i, refcount_t *r)* refcount_add - add a value to a refcount * @i: the value to add to the refcount * @r: the refcount +* @oldp: if not NULL, stores the previous value of the refcount * * Similar to atomic_add(), but will saturate at REFCOUNT_SATURATED and WARN. *
@@ -209,6 +211,7 @@ static inline void refcount_add(int i, refcount_t *r)/** * refcount_inc_not_zero - increment a refcount unless it is 0 * @r: the refcount to increment +* @oldp: if not NULL, stores the previous value of the refcount * * Similar to atomic_inc_not_zero(), but will saturate at REFCOUNT_SATURATED * and WARN.
@@ -227,6 +230,7 @@ static inline __must_check bool refcount_inc_not_zero(refcount_t *r)/** * refcount_inc - increment a refcount * @r: the refcount to increment +* @oldp: if not NULL, stores the previous value of the refcount * * Similar to atomic_inc(), but will saturate at REFCOUNT_SATURATED and WARN. *
@@ -245,6 +249,7 @@ static inline void refcount_inc(refcount_t *r)* refcount_sub_and_test - subtract from a refcount and test if it is 0 * @i: amount to subtract from the refcount * @r: the refcount +* @oldp: if not NULL, stores the previous value of the refcount * * Similar to atomic_dec_and_test(), but it will WARN, return false and * ultimately leak on underflow and will fail to decrement when saturated
@@ -279,6 +284,7 @@ static inline __must_check bool refcount_sub_and_test(int i, refcount_t *r)/** * refcount_dec_and_test - decrement a refcount and test if it is 0 * @r: the refcount +* @oldp: if not NULL, stores the previous value of the refcount * * Similar to atomic_dec_and_test(), it will WARN on underflow and fail to * decrement when saturated at REFCOUNT_SATURATED.
@@ -297,6 +303,7 @@ static inline __must_check bool refcount_dec_and_test(refcount_t *r)/** * refcount_dec - decrement a refcount * @r: the refcount +* @oldp: if not NULL, stores the previous value of the refcount * * Similar to atomic_dec(), it will WARN on underflow and fail to decrement * when saturated at REFCOUNT_SATURATED.
Signature · 1 line
2.26.2
Peter Zijlstra
maintainerRe: [PATCH v6 66/80] locking/refcount: document the new "oldp" pointer value
Quoted 3 lines · Mauro Carvalho Chehab
Changeset
a435b9a14356("locking/refcount: Provide__refcountAPI to obtain the old value") added a new parameter to most refcount functions, but didn't update
the kernel-doc markups.
Mindless warning begets mindless patch :/ Please turn on brain while operating the computer.
Quoted 1 line
Add a description for it on all touched functions.
It's actively wrong now, the function in the comment is the variant with __ and they do not have the extra parameter.
Quoted 1 line
Fixes a435b9a14356 ("locking/refcount: Provide __refcount API to obtain the old value")
Breaks actual sanity.
PATCH v6 67/80 usb: docs: document altmode register/unregister functions
In reply to Mauro Carvalho ChehabThe typec_bus.rst asks for documentation of those two functions, but they don't exist:
./drivers/usb/typec/bus.c:1: warning: 'typec_altmode_unregister_driver' not found ./drivers/usb/typec/bus.c:1: warning: 'typec_altmode_register_driver' not found
Also, they're not declared on bus.c but, instead, at a header file (typec_altmode.h).
So, add documentation for both functions at the header and change the kernel-doc markup under typec_bus.rst to point to the right place.
While here, also place the documentation for both structs declared on typec_altmode.h at the rst file.
--- Documentation/driver-api/usb/typec_bus.rst | 8 +++++++- include/linux/usb/typec_altmode.h | 16 ++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-)
Documentation/driver-api/usb/typec_bus.rst +7 -1
@@ -91,10 +91,16 @@ their control. Driver API ---------- +Alternate mode structs +~~~~~~~~~~~~~~~~~~~~~~ + +.. kernel-doc:: include/linux/usb/typec_altmode.h + :functions: typec_altmode_driver typec_altmode_ops + Alternate mode driver registering/unregistering ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. kernel-doc:: drivers/usb/typec/bus.c +.. kernel-doc:: include/linux/usb/typec_altmode.h :functions: typec_altmode_register_driver typec_altmode_unregister_driver Alternate mode driver operations
include/linux/usb/typec_altmode.h +16 -0
@@ -152,10 +152,26 @@ struct typec_altmode_driver {#define to_altmode_driver (d) container_of(d, struct typec_altmode_driver, \ driver) +/** +* typec_altmode_register_driver - registers a USB Type-C alternate mode +* device driver +* @drv: pointer to struct typec_altmode_driver +* +* These drivers will be bind to the partner alternate mode devices. They will +* handle all SVID specific communication. +*/ #define typec_altmode_register_driver (drv) \ __typec_altmode_register_driver(drv, THIS_MODULE)int __typec_altmode_register_driver (struct typec_altmode_driver *drv,struct module *module); +/** +* typec_altmode_unregister_driver - unregisters a USB Type-C alternate mode +* device driver +* @drv: pointer to struct typec_altmode_driver +* +* These drivers will be bind to the partner alternate mode devices. They will +* handle all SVID specific communication. +*/ void typec_altmode_unregister_driver (struct typec_altmode_driver *drv);#define module_typec_altmode_driver (__typec_altmode_driver) \
Signature · 1 line
2.26.2
PATCH v6 68/80 nl80211: docs: add a description for s1g_cap parameter
In reply to Mauro Carvalho ChehabChangeset df78a0c0b67d ("nl80211: S1G band and channel definitions") added a new parameter, but didn't add the corresponding kernel-doc markup, as repoted when doing "make htmldocs":
./include/net/cfg80211.h:471: warning: Function parameter or member 's1g_cap' not described in 'ieee80211_supported_band'
Add a documentation for it.
--- include/net/cfg80211.h | 1 + 1 file changed, 1 insertion(+)
include/net/cfg80211.h +1 -0
@@ -449,6 +449,7 @@ struct ieee80211_sta_s1g_cap {* @n_bitrates: Number of bitrates in @bitrates * @ht_cap: HT capabilities in this band * @vht_cap: VHT capabilities in this band +* @s1g_cap: S1G capabilities in this band * @edmg_cap: EDMG capabilities in this band * @n_iftype_data: number of iftype data entries * @iftype_data: interface type data entries. Note that the bits in
Signature · 1 line
2.26.2
Re: [PATCH v6 68/80] nl80211: docs: add a description for s1g_cap parameter
Quoted 8 lines · Mauro Carvalho Chehab
Changeset
df78a0c0b67d("nl80211: S1G band and channel definitions") added a new parameter, but didn't add the corresponding kernel-doc markup, as repoted when doing "make htmldocs":
./include/net/cfg80211.h:471: warning: Function parameter or member
's1g_cap' not described in 'ieee80211_supported_band'Add a documentation for it.
Sorry about that. Patch looks good.
Quoted 2 lines
Fixes df78a0c0b67d ("nl80211: S1G band and channel definitions")Signed-off-by Mauro Carvalho Chehab <[email protected]>
Signature · 1 line
thomas
Johannes Berg
maintainerRe: [PATCH v6 68/80] nl80211: docs: add a description for s1g_cap parameter
In reply to Mauro Carvalho ChehabThanks Mauro.
Quoted 7 lines · Mauro Carvalho Chehab
Changeset
df78a0c0b67d("nl80211: S1G band and channel definitions") added a new parameter, but didn't add the corresponding kernel-doc markup, as repoted when doing "make htmldocs":
./include/net/cfg80211.h:471: warning: Function parameter or member 's1g_cap' not described in 'ieee80211_supported_band'Add a documentation for it.
Should I take this through my tree, or is that part of a larger set that'll go somewhere else?
johannes
Re: [PATCH v6 68/80] nl80211: docs: add a description for s1g_cap parameter
Em Tue, 13 Oct 2020 20:47:47 +0200
Johannes Berg <[email protected]> escreveu:
Quoted 8 lines
Thanks Mauro.
Quoted 4 lines · Mauro Carvalho Chehab
Changeset
df78a0c0b67d("nl80211: S1G band and channel definitions") added a new parameter, but didn't add the corresponding kernel-doc markup, as repoted when doing "make htmldocs":
Quoted 6 lines
Quoted 3 lines
./include/net/cfg80211.h:471: warning: Function parameter or member 's1g_cap' not described in 'ieee80211_supported_band'Add a documentation for it.
Should I take this through my tree, or is that part of a larger set that'll go somewhere else?
Whatever works best for you ;-)
If you don't pick it via your tree, I'm planning to send it together with the other patches likely on Thursday.
Thanks,
Mauro
Re: [PATCH v6 68/80] nl80211: docs: add a description for s1g_cap parameter
Quoted 15 lines · Mauro Carvalho Chehab
Em Tue, 13 Oct 2020 20:47:47 +0200
Johannes Berg <[email protected]> escreveu:Quoted 12 lines
Thanks Mauro.
Quoted 7 lines · Mauro Carvalho Chehab
Changeset
df78a0c0b67d("nl80211: S1G band and channel definitions") added a new parameter, but didn't add the corresponding kernel-doc markup, as repoted when doing "make htmldocs":
./include/net/cfg80211.h:471: warning: Function parameter or member 's1g_cap' not described in 'ieee80211_supported_band'Add a documentation for it.
Quoted 7 lines
Quoted 2 lines
Should I take this through my tree, or is that part of a larger set that'll go somewhere else?
Whatever works best for you ;-)
If you don't pick it via your tree, I'm planning to send it together with the other patches likely on Thursday.
OK, please do, and here's an
I don't think I can get it this quickly through net-next at this point, and there's just no point if you have stuff to send anyway :-)
Thanks!
johannes
PATCH v6 69/80 IB/srpt: docs: add a description for cq_size member
In reply to Mauro Carvalho ChehabChangeset c804af2c1d31 ("IB/srpt: use new shared CQ mechanism")
added a new member for struct srpt_rdma_ch, but didn't add the
corresponding kernel-doc markup, as repoted when doing
"make htmldocs":
./drivers/infiniband/ulp/srpt/ib_srpt.h:331: warning: Function parameter or member 'cq_size' not described in 'srpt_rdma_ch'
Add a description for it.
--- drivers/infiniband/ulp/srpt/ib_srpt.h | 1 + 1 file changed, 1 insertion(+)
drivers/infiniband/ulp/srpt/ib_srpt.h +1 -0
@@ -256,6 +256,7 @@ enum rdma_ch_state {* @rdma_cm: See below. * @rdma_cm.cm_id: RDMA CM ID associated with the channel. * @cq: IB completion queue for this channel. +* @cq_size: Size of the @cq pool. * @zw_cqe: Zero-length write CQE. * @rcu: RCU head. * @kref: kref for this channel.
Signature · 1 line
2.26.2
Bart Van Assche
maintainerRe: [PATCH v6 69/80] IB/srpt: docs: add a description for cq_size member
Quoted 19 lines · Mauro Carvalho Chehab
Changeset
c804af2c1d31("IB/srpt: use new shared CQ mechanism")
added a new member for structsrpt_rdma_ch, but didn't add the
corresponding kernel-doc markup, as repoted when doing
"make htmldocs":
./drivers/infiniband/ulp/srpt/ib_srpt.h:331: warning: Function parameter or member 'cq_size' not described in 'srpt_rdma_ch'Add a description for it.
Fixes c804af2c1d31 ("IB/srpt: use new shared CQ mechanism")Signed-off-by Mauro Carvalho Chehab <[email protected]>--- drivers/infiniband/ulp/srpt/ib_srpt.h | 1 + 1 file changed, 1 insertion(+)drivers/infiniband/ulp/srpt/ib_srpt.h +0
-0
drivers/infiniband/ulp/srpt/ib_srpt.h enum rdma_ch_state { · line 262
Quoted 7 lines
drivers/infiniband/ulp/srpt/ib_srpt.h +1
-0@@ -256,6 +256,7 @@ enum rdma_ch_state {* @rdma_cm: See below. * @rdma_cm.cm_id: RDMA CM ID associated with the channel. * @cq: IB completion queue for this channel. +* @cq_size: Size of the @cq pool. * @zw_cqe: Zero-length write CQE. * @rcu: RCU head. * @kref: kref for this channel.
That doesn't seem correct to me. My understanding is that cq_size is the number of CQEs in @cq. @cq is a completion queue and not a CQ pool.
Bart.
PATCH v6 70/80 rcu/tree: docs: document bkvcache new members at struct kfree_rcu_cpu
In reply to Mauro Carvalho ChehabChangeset 53c72b590b3a ("rcu/tree: cache specified number of objects")
added new members for struct kfree_rcu_cpu, but didn't add the
corresponding at the kernel-doc markup, as repoted when doing
"make htmldocs":
./kernel/rcu/tree.c:3113: warning: Function parameter or member 'bkvcache' not described in 'kfree_rcu_cpu' ./kernel/rcu/tree.c:3113: warning: Function parameter or member 'nr_bkv_objs' not described in 'kfree_rcu_cpu'
So, move the description for bkvcache to kernel-doc, and add a description for nr_bkv_objs.
--- kernel/rcu/tree.c | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-)
kernel/rcu/tree.c +6 -8
@@ -3022,6 +3022,12 @@ struct kfree_rcu_cpu_work {* @monitor_todo: Tracks whether a @monitor_work delayed work is pending * @initialized: The @rcu_work fields have been initialized * @count: Number of objects for which GP not started +* @bkvcache: +* A simple cache list that contains objects for reuse purpose. +* In order to save some per-cpu space the list is singular. +* Even though it is lockless an access has to be protected by the +* per-cpu lock. +* @nr_bkv_objs: number of allocated objects at @bkvcache. * * This is a per-CPU structure. The reason that it is not included in * the rcu_data structure is to permit this code to be extracted from
@@ -3037,14 +3043,6 @@ struct kfree_rcu_cpu {bool monitor_todo;bool initialized;int count; - -/* -* A simple cache list that contains objects for -* reuse purpose. In order to save some per-cpu -* space the list is singular. Even though it is -* lockless an access has to be protected by the -* per-cpu lock. -*/ struct llist_head bkvcache;int nr_bkv_objs; };
Signature · 1 line
2.26.2
Paul E. McKenney
maintainerRe: [PATCH v6 70/80] rcu/tree: docs: document bkvcache new members at struct kfree_rcu_cpu
Quoted 7 lines · Mauro Carvalho Chehab
Changeset
53c72b590b3a("rcu/tree: cache specified number of objects")
added new members for structkfree_rcu_cpu, but didn't add the
corresponding at the kernel-doc markup, as repoted when doing
"make htmldocs":
./kernel/rcu/tree.c:3113: warning: Function parameter or member 'bkvcache' not described in 'kfree_rcu_cpu'./kernel/rcu/tree.c:3113: warning: Function parameter or member 'nr_bkv_objs' not described in 'kfree_rcu_cpu'
Quoted 5 lines
So, move the description for bkvcache to kernel-doc, and add a description for
nr_bkv_objs.Fixes 53c72b590b3a ("rcu/tree: cache specified number of objects")Signed-off-by Mauro Carvalho Chehab <[email protected]>
Queued for review and testing, likely target v5.11.
Thanx, Paul
Quoted 39 lines
--- kernel/rcu/tree.c | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-)kernel/rcu/tree.c +6
-8@@ -3022,6 +3022,12 @@ struct kfree_rcu_cpu_work {* @monitor_todo: Tracks whether a @monitor_work delayed work is pending * @initialized: The @rcu_work fields have been initialized * @count: Number of objects for which GP not started +* @bkvcache: +* A simple cache list that contains objects for reuse purpose. +* In order to save some per-cpu space the list is singular. +* Even though it is lockless an access has to be protected by the +* per-cpu lock. +* @nr_bkv_objs: number of allocated objects at @bkvcache. * * This is a per-CPU structure. The reason that it is not included in * the rcu_data structure is to permit this code to be extracted from @@ -3037,14 +3043,6 @@ struct kfree_rcu_cpu {bool monitor_todo;bool initialized;int count; - -/* -* A simple cache list that contains objects for -* reuse purpose. In order to save some per-cpu -* space the list is singular. Even though it is -* lockless an access has to be protected by the -* per-cpu lock. -*/ struct llist_head bkvcache;int nr_bkv_objs; };Signature · 1 line
2.26.2
Re: [PATCH v6 70/80] rcu/tree: docs: document bkvcache new members at struct kfree_rcu_cpu
Em Tue, 13 Oct 2020 09:34:04 -0700
"Paul E. McKenney" <[email protected]> escreveu:
Quoted 8 lines · Mauro Carvalho Chehab
Quoted 7 lines
Changeset
53c72b590b3a("rcu/tree: cache specified number of objects")
added new members for structkfree_rcu_cpu, but didn't add the
corresponding at the kernel-doc markup, as repoted when doing
"make htmldocs":
./kernel/rcu/tree.c:3113: warning: Function parameter or member 'bkvcache' not described in 'kfree_rcu_cpu'./kernel/rcu/tree.c:3113: warning: Function parameter or member 'nr_bkv_objs' not described in 'kfree_rcu_cpu'
Quoted 7 lines
Quoted 5 lines
So, move the description for bkvcache to kernel-doc, and add a description for
nr_bkv_objs.Fixes 53c72b590b3a ("rcu/tree: cache specified number of objects")Signed-off-by Mauro Carvalho Chehab <[email protected]>Queued for review and testing, likely target v5.11.
Hi Paul,
I would prefer if we could get those on 5.10, if possible. We're aiming to have 5.10 free of docs warnings ;-)
If you prefer, I can send those patches to Linus with your ack.
Regards,
Mauro
Quoted 34 lines
Thanx, Paul
Quoted 31 lines
--- kernel/rcu/tree.c | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-)kernel/rcu/tree.c +6
-6@@ -3022,6 +3022,12 @@ struct kfree_rcu_cpu_work {* @monitor_todo: Tracks whether a @monitor_work delayed work is pending * @initialized: The @rcu_work fields have been initialized * @count: Number of objects for which GP not started +* @bkvcache: +* A simple cache list that contains objects for reuse purpose. +* In order to save some per-cpu space the list is singular. +* Even though it is lockless an access has to be protected by the +* per-cpu lock. +* @nr_bkv_objs: number of allocated objects at @bkvcache. * * This is a per-CPU structure. The reason that it is not included in * the rcu_data structure is to permit this code to be extracted from @@ -3037,14 +3043,6 @@ struct kfree_rcu_cpu {bool monitor_todo;bool initialized;int count; - -/* -* A simple cache list that contains objects for -* reuse purpose. In order to save some per-cpu -* space the list is singular. Even though it is -* lockless an access has to be protected by the
Quoted 8 lines
Quoted 8 lines
kernel/rcu/tree.c +0
-2-* per-cpu lock. -*/ struct llist_head bkvcache;int nr_bkv_objs; };Signature · 1 line
2.26.2
Thanks,
Mauro
Re: [PATCH v6 70/80] rcu/tree: docs: document bkvcache new members at struct kfree_rcu_cpu
Quoted 19 lines · Mauro Carvalho Chehab
Em Tue, 13 Oct 2020 09:34:04 -0700
"Paul E. McKenney" <[email protected]> escreveu:Quoted 8 lines · Mauro Carvalho Chehab
Quoted 7 lines
Changeset
53c72b590b3a("rcu/tree: cache specified number of objects")
added new members for structkfree_rcu_cpu, but didn't add the
corresponding at the kernel-doc markup, as repoted when doing
"make htmldocs":
./kernel/rcu/tree.c:3113: warning: Function parameter or member 'bkvcache' not described in 'kfree_rcu_cpu'./kernel/rcu/tree.c:3113: warning: Function parameter or member 'nr_bkv_objs' not described in 'kfree_rcu_cpu'Quoted 7 lines
Quoted 5 lines
So, move the description for bkvcache to kernel-doc, and add a description for
nr_bkv_objs.Fixes 53c72b590b3a ("rcu/tree: cache specified number of objects")Signed-off-by Mauro Carvalho Chehab <[email protected]>Queued for review and testing, likely target v5.11.
Quoted 7 lines
Hi Paul,
I would prefer if we could get those on 5.10, if possible. We're aiming to have 5.10 free of docs warnings ;-)
If you prefer, I can send those patches to Linus with your ack.
That sounds easier:
Alan's objection is quite valid, but we will address that issue in a follow-on patch that will not be on the fast track.
Thanx, Paul
Quoted 50 lines
Regards,
MauroQuoted 34 lines
Thanx, Paul
Quoted 31 lines
--- kernel/rcu/tree.c | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-)kernel/rcu/tree.c +6
-6@@ -3022,6 +3022,12 @@ struct kfree_rcu_cpu_work {* @monitor_todo: Tracks whether a @monitor_work delayed work is pending * @initialized: The @rcu_work fields have been initialized * @count: Number of objects for which GP not started +* @bkvcache: +* A simple cache list that contains objects for reuse purpose. +* In order to save some per-cpu space the list is singular. +* Even though it is lockless an access has to be protected by the +* per-cpu lock. +* @nr_bkv_objs: number of allocated objects at @bkvcache. * * This is a per-CPU structure. The reason that it is not included in * the rcu_data structure is to permit this code to be extracted from @@ -3037,14 +3043,6 @@ struct kfree_rcu_cpu {bool monitor_todo;bool initialized;int count; - -/* -* A simple cache list that contains objects for -* reuse purpose. In order to save some per-cpu -* space the list is singular. Even though it is -* lockless an access has to be protected by the Quoted 8 lines
Quoted 8 lines
kernel/rcu/tree.c +0
-2-* per-cpu lock. -*/ struct llist_head bkvcache;int nr_bkv_objs; };Signature · 1 line
2.26.2Thanks,
Mauro
PATCH v6 71/80 Input: sparse-keymap: add a description for @sw
In reply to Mauro Carvalho ChehabAdd a description for it, in order to avoids this warning:
./include/linux/input/sparse-keymap.h:43: warning: Function parameter or member 'sw' not described in 'key_entry'
--- include/linux/input/sparse-keymap.h | 1 + 1 file changed, 1 insertion(+)
include/linux/input/sparse-keymap.h +1 -0
@@ -20,6 +20,7 @@* private definitions. * @code: Device-specific data identifying the button/switch * @keycode: KEY_* code assigned to a key/button +* @sw: struct with code/value used by KE_SW and KE_VSW * @sw.code: SW_* code assigned to a switch * @sw.value: Value that should be sent in an input even when KE_SW * switch is toggled. KE_VSW switches ignore this field and
Signature · 1 line
2.26.2
PATCH v6 72/80 drm/amd/display: kernel-doc: document force_timing_sync
In reply to Mauro Carvalho ChehabAs warned when running "make htmldocs":
./drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:345: warning: Function parameter or member 'force_timing_sync' not described in 'amdgpu_display_manager'
This new struct member was not documented at kernel-doc markup.
--- drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 ++ 1 file changed, 2 insertions(+)
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +2 -0
@@ -149,6 +149,8 @@ struct amdgpu_dm_backlight_caps {* @cached_state: Caches device atomic state for suspend/resume * @cached_dc_state: Cached state of content streams * @compressor: Frame buffer compression buffer. See &struct dm_comressor_info +* @force_timing_sync: set via debugfs. When set, indicates that all connected +* displays will be forced to synchronize. */ struct amdgpu_display_manager {
Signature · 6 lines
2.26.2 _______________________________________________ amd-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/amd-gfx
Alex Deucher
AppliedRe: [PATCH v6 72/80] drm/amd/display: kernel-doc: document force_timing_sync
Applied. Thanks!
Alex
Quoted 33 lines · Mauro Carvalho Chehab
As warned when running "make htmldocs":
./drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:345: warning: Function parameter or member 'force_timing_sync' not described in 'amdgpu_display_manager'This new struct member was not documented at kernel-doc markup.
Fixes 3d4e52d0cf24 ("drm/amd/display: Add debugfs for forcing stream timing sync")Signed-off-by Mauro Carvalho Chehab <[email protected]>--- drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 ++ 1 file changed, 2 insertions(+)drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +2
-1@@ -149,6 +149,8 @@ struct amdgpu_dm_backlight_caps {* @cached_state: Caches device atomic state for suspend/resume * @cached_dc_state: Cached state of content streams * @compressor: Frame buffer compression buffer. See &struct dm_comressor_info +* @force_timing_sync: set via debugfs. When set, indicates that all connected +* displays will be forced to synchronize. */ struct amdgpu_display_manager { --2.26.2
_______________________________________________
amd-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/amd-gfx
PATCH v6 73/80 drm: kernel-doc: drm_dp_helper.h: fix a typo
In reply to Mauro Carvalho ChehabRight now, kernel-doc generates a warning:
./include/drm/drm_dp_helper.h:1786: warning: Function parameter or member 'hbr2_reset' not described in 'drm_dp_phy_test_params'
This is due to a typo:
@hb2_reset -> @hbr2_reset
--- include/drm/drm_dp_helper.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/drm/drm_dp_helper.h +1 -1
@@ -1760,7 +1760,7 @@ static inline void drm_dp_cec_unset_edid(struct drm_dp_aux *aux)* @link_rate: Requested Link rate from DPCD 0x219 * @num_lanes: Number of lanes requested by sing through DPCD 0x220 * @phy_pattern: DP Phy test pattern from DPCD 0x248 -* @hb2_reset: DP HBR2_COMPLIANCE_SCRAMBLER_RESET from DCPD 0x24A and 0x24B +* @hbr2_reset: DP HBR2_COMPLIANCE_SCRAMBLER_RESET from DCPD 0x24A and 0x24B * @custom80: DP Test_80BIT_CUSTOM_PATTERN from DPCDs 0x250 through 0x259 * @enhanced_frame_cap: flag for enhanced frame capability. */
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v6 74/80 gpu: docs: amdgpu.rst: get rid of wrong kernel-doc markups
In reply to Mauro Carvalho ChehabAs reported by kernel-doc:
./drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c:1: warning: no structured comments found ./drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c:1: warning: no structured comments found
Those files only contain
/** * DOC: */
markups, but they're included twice there: one to parse such markup, and another one to parse internal functions.
In the case of amdgpu_xgmi.c, as it has just one such markup, we can simply include the file once, and let it parse the entire file without passing arguments to kernel-doc.
This should place everything altogether.
For amdgpu_ras.c, however, we need to remove the kernel-doc with just internal. This should be re-introduced if this file ever gets new non-DOC markups.
--- Documentation/gpu/amdgpu.rst | 7 ------- 1 file changed, 7 deletions(-)
Documentation/gpu/amdgpu.rst +0 -7
@@ -74,10 +74,6 @@ AMDGPU XGMI Support =================== .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c - :doc: AMDGPU XGMI Support - -.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c - :internal: AMDGPU RAS Support ==================
@@ -115,9 +111,6 @@ RAS VRAM Bad Pages sysfs Interface .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c :doc: AMDGPU RAS sysfs gpu_vram_bad_pages Interface -.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c - :internal: - Sample Code ----------- Sample code for testing error injection can be found here:
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v6 75/80 drm: kernel-doc: add description for a new function parameter
In reply to Mauro Carvalho ChehabAs reported by "make htmldocs":
./drivers/gpu/drm/drm_prime.c:808: warning: Function parameter or member 'dev' not described in 'drm_prime_pages_to_sg'
Add a description for the new parameter.
--- drivers/gpu/drm/drm_prime.c | 1 + 1 file changed, 1 insertion(+)
drivers/gpu/drm/drm_prime.c +1 -0
@@ -793,6 +793,7 @@ static const struct dma_buf_ops drm_gem_prime_dmabuf_ops = {/** * drm_prime_pages_to_sg - converts a page array into an sg list +* @dev: DRM device * @pages: pointer to the array of page pointers to convert * @nr_pages: length of the page vector *
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v6 76/80 docs: virt: user_mode_linux_howto_v2.rst: fix a literal block markup
In reply to Mauro Carvalho ChehabThere's a missing new line for a literal block:
.../Documentation/virt/uml/user_mode_linux_howto_v2.rst:682: WARNING: Unexpected indentation.
--- Documentation/virt/uml/user_mode_linux_howto_v2.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/virt/uml/user_mode_linux_howto_v2.rst +1 -0
@@ -679,6 +679,7 @@ Starting UML We can now run UML. :: + # linux mem=2048M umid=TEST \ ubd0=Filesystem.img \ vec0:transport=tap,ifname=tap0,depth=128,gro=1 \
Signature · 7 lines
2.26.2 _______________________________________________ linux-um mailing list [email protected] http://lists.infradead.org/mailman/listinfo/linux-um
PATCH v6 77/80 workqueue: fix a kernel-doc warning
In reply to Mauro Carvalho ChehabAs warned by Sphinx:
./Documentation/core-api/workqueue:400: ./kernel/workqueue.c:1218: WARNING: Unexpected indentation.
the return code table is currently not recognized, as it lacks markups.
--- kernel/workqueue.c | 3 +++ 1 file changed, 3 insertions(+)
kernel/workqueue.c +3 -0
@@ -1212,11 +1212,14 @@ static void pwq_dec_nr_in_flight(struct pool_workqueue *pwq, int color)* stable state - idle, on timer or on worklist. * * Return: +* +* ======== ================================================================ * 1 if @work was pending and we successfully stole PENDING * 0 if @work was idle and we claimed PENDING * -EAGAIN if PENDING couldn't be grabbed at the moment, safe to busy-retry * -ENOENT if someone else is canceling @work, this state may persist * for arbitrarily long +* ======== ================================================================ * * Note: * On >= 0 return, the caller owns @work's PENDING bit. To avoid getting
Signature · 1 line
2.26.2
PATCH v6 78/80 mm/doc: fix a literal block markup
In reply to Mauro Carvalho ChehabLiteral blocks with :: markup should be indented, as otherwise Sphinx complains:
Documentation/vm/hmm.rst:363: WARNING: Literal block expected; none found.
--- Documentation/vm/hmm.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/vm/hmm.rst +1 -1
@@ -360,7 +360,7 @@ between device driver specific code and shared common code: system memory page, locks the page with ``lock_page()``, and fills in the ``dst`` array entry with:: - dst[i] = migrate_pfn(page_to_pfn(dpage)) | MIGRATE_PFN_LOCKED; + dst[i] = migrate_pfn(page_to_pfn(dpage)) | MIGRATE_PFN_LOCKED; Now that the driver knows that this page is being migrated, it can invalidate device private MMU mappings and copy device private memory
Signature · 1 line
2.26.2
PATCH v6 79/80 drm: drm_edid: remove a duplicated kernel-doc declaration
In reply to Mauro Carvalho ChehabIt is not possible to create cross-references for duplicated symbols. While Sphinx always detected it, on Sphinx 3 it generates warnings like this:
.../Documentation/gpu/drm-kms-helpers:326: ../drivers/gpu/drm/drm_edid.c:1626: WARNING: Duplicate C declaration, also defined in 'gpu/drm-kms-helpers'. Declaration is 'bool drm_edid_are_equal (const struct edid *edid1, const struct edid *edid2)'.
So, get rid of the duplicated kernel-doc markup.
--- include/drm/drm_edid.h | 7 ------- 1 file changed, 7 deletions(-)
include/drm/drm_edid.h +0 -7
@@ -359,13 +359,6 @@ drm_load_edid_firmware(struct drm_connector *connector) }#endif -/** -* drm_edid_are_equal - compare two edid blobs. -* @edid1: pointer to first blob -* @edid2: pointer to second blob -* This helper can be used during probing to determine if -* edid had changed. -*/ bool drm_edid_are_equal (const struct edid *edid1,const struct edid *edid2);int
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH v6 80/80 PM / devfreq: remove a duplicated kernel-doc markup
In reply to Mauro Carvalho ChehabThe update_devfreq() is also documented at devfreq.c, which has a more complete note.
So, drop the duplicated markup, in order to avoid this
warning:
.../Documentation/driver-api/device_link.rst: WARNING: Duplicate C declaration, also defined in 'driver-api/infrastructure'. Declaration is 'device_link_state'.
(and to cause a problem with cross-references to it)
--- include/linux/devfreq.h | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-)
include/linux/devfreq.h +1 -6
@@ -228,12 +228,7 @@ int devfreq_resume_device(struct devfreq *devfreq);void devfreq_suspend (void );void devfreq_resume (void ); -/** -* update_devfreq() - Reevaluate the device and configure frequency -* @devfreq: the devfreq device -* -* Note: devfreq->lock must be held -*/ +/* update_devfreq() - Reevaluate the device and configure frequency */ int update_devfreq (struct devfreq *devfreq);/* Helper functions for devfreq user device driver with OPP. */
Signature · 1 line
2.26.2
Quoted 8 lines · Mauro Carvalho Chehab
This series actually folds the previous Sphinx 3.x patch series with the other patches I sent fixing warnings with Sphinx 2.x and with kernel-doc and that weren't merged yet via some other tree.
It is based on the top of upstream, plus the media pull request I sent yesterday:
Quoted 7 lines
https://lore.kernel.org/lkml/[email protected]/My plan is to send a pull request with those patches after Thursday's linux next release.
On this series, I removed the patches that depend on material currently found only at linux-next.
Was a bit tricky to find the cover letter here and that you plan to send these out this merge window. I think we'll have some confusion now with Alex from amd having picked up a few already.
Anyway Acked-by: Daniel Vetter <[email protected]> for the remaining drm patches. Although I can also pick them up to drm-misc-next (but that's going to be 5.11 or so). -Daniel
Quoted 405 lines
Mauro Carvalho Chehab (79):
scripts: kernel-doc: add support for typedef enum
scripts: kernel-doc: make it more compatible with Sphinx 3.x
scripts: kernel-doc: use a less pedantic markup for funcs on Sphinx3.xscripts: kernel-doc: fix troubles with line counts
scripts: kernel-doc: reimplement -nofunction argument
scripts: kernel-doc: fix typedef identification
scripts: kernel-doc: don't mangle with parameter list
scripts: kernel-doc: allow passing desired Sphinx C domain dialect
scripts: kernel-doc: fix line number handling
scripts: kernel-doc: try to use c:function if possible
docs:cdomain.py: add support for a new Sphinx 3.1+ tag
docs:cdomain.py: extend it to handle new Sphinx 3.x tags
docs:kerneldoc.py: append the name of the parsed doc file
docs:kerneldoc.py: add support for kerneldoc -nosymbol
media: docs: make CEC documents compatible with Sphinx 3.1+
media: docs: make V4L documents more compatible with Sphinx 3.1+
media: docs: make DVB documents more compatible with Sphinx 3.1+
media: docs: make MC documents more compatible with Sphinx 3.1+
media: docs: make RC documents more compatible with Sphinx 3.1+
media:cec-core.rst: don't use c:type for structs
docs: remove some replace macros like |struct foo|
docs: get rid of :c:type explicit declarations for structs
docs:trace-uses.rst: remove bogus c-domain tags
docs:it_IT: fix namespace collisions atlocking.rst
docs: net:ieee802154.rst: fix C expressions
docs:genericirq.rst: don't documentchip.cfunctions twice
docs:kernel-api.rst: dropkernel/irq/manage.ckernel-doc tag
docs: remove sound API duplication
docs:basics.rst: move kernel-doc workqueue markups toworkqueue.rst
docs: scsi:target.rst: remove iSCSI transport class kernel-doc markup
docs:device_link.rst: remove duplicated kernel-doc include
docs:basics.rst: get rid of rcu kernel-doc macros
docs:pstore-blk.rst: fix kernel-doc tags
docs: fs:fscrypt.rst: get rid of :c:type: tags
docs:devices.rst: get rid of :c:type macros
docs: sound:writing-an-alsa-driver.rst: get rid of :c:type
docs: block:blk-mq.rst: get rid of :c:type
docs:writing-an-alsa-driver.rst: fix some bad c:func: markups
docs: fpga: replace :c:member: macros
docs:kgdb.rst: fix :c:type: usages
docs:libata.rst: fix a wrong usage of :c:type: tag
docs:infrastructure.rst: don't include firmware kernel-doc
docs: gpu:i915.rst: Fix several C duplication warnings
docs:devices.rst: fix a C reference markup
docs:it_IT:hacking.rst: fix a typo on a markup
docs:mei.rst: fix a C expression markup
docs:basics.rst: avoid duplicated C function declaration
docs:conf.py: fix c:function support with Sphinx 3.x
docs:conf.py: change the Sphinx 3.x+ text
docs:infrastructure.rst: excludedevice_link_statefromdevice.h
docs:zh_CN:amu.rst: fix document title markup
media: uAPI:buffer.rst: remove a left-over documentationmath64.h: kernel-docs: Convert some markups into normal comments
memblock: get rid of a :c:type leftover
dt-bindings: fix references to files converted to yaml
net: appletalk:Kconfig: Fix docs location
drivers: net: hamradio: fix document location
docs: powerpc:syscall64-abi.rst: fix a malformed table
block: bio: fix a warning at the kernel-doc markups
kunit:test.h: solve kernel-doc warnings
docs: bio: fix a kerneldoc markup
drivers: core: fix kernel-doc markup fordev_err_probe()
kunit:test.h: fix a bad kernel-doc markup
docs: amdgpu: fix a warning when building the documentation locking/refcount: document the new "oldp" pointer value
usb: docs: document altmode register/unregister functions
nl80211: docs: add a description fors1g_capparameter IB/srpt: docs: add a description forcq_sizemember rcu/tree: docs: document bkvcache new members at structkfree_rcu_cpu
Input: sparse-keymap: add a description for @sw drm/amd/display: kernel-doc: documentforce_timing_sync
drm: kernel-doc:drm_dp_helper.h: fix a typo
gpu: docs:amdgpu.rst: get rid of wrong kernel-doc markups
drm: kernel-doc: add description for a new function parameter
docs: virt:user_mode_linux_howto_v2.rst: fix a literal block markup
workqueue: fix a kernel-doc warning
mm/doc: fix a literal block markup
drm:drm_edid: remove a duplicated kernel-doc declaration PM / devfreq: remove a duplicated kernel-doc markupNícolas F. R. A. Prado (1):
docs:automarkup.py: make it ready for Sphinx 3.1+Documentation/admin-guide/pm/cpufreq.rst | 11 +- Documentation/admin-guide/pstore-blk.rst | 10 +- Documentation/block/blk-mq.rst | 12 +- Documentation/block/inline-encryption.rst | 8 +- Documentation/conf.py | 65 +++- Documentation/core-api/genericirq.rst | 2 + Documentation/core-api/kernel-api.rst | 6 - Documentation/core-api/workqueue.rst | 2 + Documentation/dev-tools/kgdb.rst | 6 +- .../bindings/display/tilcdc/tilcdc.txt | 2 +- .../bindings/mailbox/omap-mailbox.txt | 2 +- .../devicetree/bindings/media/i2c/tvp5150.txt | 2 +- .../bindings/pwm/google,cros-ec-pwm.yaml | 2 +- .../bindings/soc/qcom/qcom,smd-rpm.yaml | 2 +- .../bindings/sound/google,cros-ec-codec.yaml | 2 +- Documentation/doc-guide/kernel-doc.rst | 8 + Documentation/driver-api/basics.rst | 19 +- Documentation/driver-api/device_link.rst | 13 +- Documentation/driver-api/fpga/fpga-bridge.rst | 4 +- Documentation/driver-api/fpga/fpga-mgr.rst | 6 +- .../driver-api/fpga/fpga-programming.rst | 2 +- Documentation/driver-api/fpga/fpga-region.rst | 6 +- Documentation/driver-api/iio/buffers.rst | 2 +- Documentation/driver-api/iio/core.rst | 6 +- Documentation/driver-api/iio/hw-consumer.rst | 2 +- .../driver-api/iio/triggered-buffers.rst | 2 +- Documentation/driver-api/iio/triggers.rst | 4 +- Documentation/driver-api/index.rst | 1 - Documentation/driver-api/infrastructure.rst | 4 +- Documentation/driver-api/libata.rst | 2 +- Documentation/driver-api/media/cec-core.rst | 2 +- .../driver-api/media/dtv-frontend.rst | 4 +- Documentation/driver-api/media/mc-core.rst | 24 +- .../driver-api/media/v4l2-controls.rst | 2 +- Documentation/driver-api/media/v4l2-dev.rst | 8 +- .../driver-api/media/v4l2-device.rst | 6 +- Documentation/driver-api/media/v4l2-event.rst | 10 +- Documentation/driver-api/media/v4l2-fh.rst | 16 +- .../driver-api/media/v4l2-subdev.rst | 2 +- Documentation/driver-api/mei/mei.rst | 2 +- Documentation/driver-api/pm/cpuidle.rst | 65 ++-- Documentation/driver-api/pm/devices.rst | 26 +- Documentation/driver-api/regulator.rst | 4 +- Documentation/driver-api/sound.rst | 54 ---- Documentation/driver-api/target.rst | 12 - Documentation/driver-api/usb/URB.rst | 2 +- Documentation/driver-api/usb/gadget.rst | 10 +- Documentation/driver-api/usb/hotplug.rst | 2 +- Documentation/driver-api/usb/typec_bus.rst | 8 +- Documentation/filesystems/fscrypt.rst | 61 ++-- Documentation/filesystems/fsverity.rst | 2 +- Documentation/gpu/amdgpu.rst | 11 +- Documentation/gpu/i915.rst | 29 +- Documentation/networking/ieee802154.rst | 18 +- Documentation/powerpc/syscall64-abi.rst | 32 +- Documentation/sound/designs/tracepoints.rst | 22 +- .../sound/kernel-api/alsa-driver-api.rst | 1 + .../kernel-api/writing-an-alsa-driver.rst | 110 +++---- Documentation/sphinx/automarkup.py | 69 +++- Documentation/sphinx/cdomain.py | 93 +++++- Documentation/sphinx/kerneldoc.py | 15 +- Documentation/sphinx/parse-headers.pl | 2 +- Documentation/trace/ftrace-uses.rst | 12 +- .../it_IT/kernel-hacking/hacking.rst | 2 +- .../it_IT/kernel-hacking/locking.rst | 2 + .../translations/zh_CN/arm64/amu.rst | 4 +- .../media/cec/cec-func-close.rst | 10 +- .../media/cec/cec-func-ioctl.rst | 11 +- .../userspace-api/media/cec/cec-func-open.rst | 10 +- .../userspace-api/media/cec/cec-func-poll.rst | 14 +- .../media/cec/cec-ioc-adap-g-caps.rst | 10 +- .../media/cec/cec-ioc-adap-g-conn-info.rst | 11 +- .../media/cec/cec-ioc-adap-g-log-addrs.rst | 20 +- .../media/cec/cec-ioc-adap-g-phys-addr.rst | 15 +- .../media/cec/cec-ioc-dqevent.rst | 15 +- .../media/cec/cec-ioc-g-mode.rst | 16 +- .../media/cec/cec-ioc-receive.rst | 18 +- .../dvb/audio-bilingual-channel-select.rst | 7 +- .../media/dvb/audio-channel-select.rst | 8 +- .../media/dvb/audio-clear-buffer.rst | 8 +- .../media/dvb/audio-continue.rst | 7 +- .../userspace-api/media/dvb/audio-fclose.rst | 7 +- .../userspace-api/media/dvb/audio-fopen.rst | 7 +- .../userspace-api/media/dvb/audio-fwrite.rst | 7 +- .../media/dvb/audio-get-capabilities.rst | 8 +- .../media/dvb/audio-get-status.rst | 8 +- .../userspace-api/media/dvb/audio-pause.rst | 9 +- .../userspace-api/media/dvb/audio-play.rst | 7 +- .../media/dvb/audio-select-source.rst | 8 +- .../media/dvb/audio-set-av-sync.rst | 8 +- .../media/dvb/audio-set-bypass-mode.rst | 9 +- .../userspace-api/media/dvb/audio-set-id.rst | 9 +- .../media/dvb/audio-set-mixer.rst | 9 +- .../media/dvb/audio-set-mute.rst | 8 +- .../media/dvb/audio-set-streamtype.rst | 10 +- .../userspace-api/media/dvb/audio-stop.rst | 9 +- .../userspace-api/media/dvb/ca-fclose.rst | 7 +- .../userspace-api/media/dvb/ca-fopen.rst | 7 +- .../userspace-api/media/dvb/ca-get-cap.rst | 8 +- .../media/dvb/ca-get-descr-info.rst | 9 +- .../userspace-api/media/dvb/ca-get-msg.rst | 10 +- .../media/dvb/ca-get-slot-info.rst | 9 +- .../userspace-api/media/dvb/ca-reset.rst | 9 +- .../userspace-api/media/dvb/ca-send-msg.rst | 9 +- .../userspace-api/media/dvb/ca-set-descr.rst | 8 +- .../userspace-api/media/dvb/dmx-add-pid.rst | 10 +- .../userspace-api/media/dvb/dmx-expbuf.rst | 11 +- .../userspace-api/media/dvb/dmx-fclose.rst | 9 +- .../userspace-api/media/dvb/dmx-fopen.rst | 5 +- .../userspace-api/media/dvb/dmx-fread.rst | 7 +- .../userspace-api/media/dvb/dmx-fwrite.rst | 6 +- .../media/dvb/dmx-get-pes-pids.rst | 12 +- .../userspace-api/media/dvb/dmx-get-stc.rst | 12 +- .../userspace-api/media/dvb/dmx-mmap.rst | 15 +- .../userspace-api/media/dvb/dmx-munmap.rst | 14 +- .../userspace-api/media/dvb/dmx-qbuf.rst | 17 +- .../userspace-api/media/dvb/dmx-querybuf.rst | 9 +- .../media/dvb/dmx-remove-pid.rst | 10 +- .../userspace-api/media/dvb/dmx-reqbufs.rst | 9 +- .../media/dvb/dmx-set-buffer-size.rst | 10 +- .../media/dvb/dmx-set-filter.rst | 12 +- .../media/dvb/dmx-set-pes-filter.rst | 13 +- .../userspace-api/media/dvb/dmx-start.rst | 11 +- .../userspace-api/media/dvb/dmx-stop.rst | 9 +- .../media/dvb/fe-diseqc-recv-slave-reply.rst | 9 +- .../media/dvb/fe-diseqc-reset-overload.rst | 9 +- .../media/dvb/fe-diseqc-send-burst.rst | 10 +- .../media/dvb/fe-diseqc-send-master-cmd.rst | 9 +- .../dvb/fe-dishnetwork-send-legacy-cmd.rst | 10 +- .../media/dvb/fe-enable-high-lnb-voltage.rst | 10 +- .../userspace-api/media/dvb/fe-get-event.rst | 12 +- .../media/dvb/fe-get-frontend.rst | 12 +- .../userspace-api/media/dvb/fe-get-info.rst | 11 +- .../media/dvb/fe-get-property.rst | 15 +- .../userspace-api/media/dvb/fe-read-ber.rst | 9 +- .../media/dvb/fe-read-signal-strength.rst | 9 +- .../userspace-api/media/dvb/fe-read-snr.rst | 9 +- .../media/dvb/fe-read-status.rst | 11 +- .../media/dvb/fe-read-uncorrected-blocks.rst | 9 +- .../media/dvb/fe-set-frontend-tune-mode.rst | 10 +- .../media/dvb/fe-set-frontend.rst | 11 +- .../userspace-api/media/dvb/fe-set-tone.rst | 10 +- .../media/dvb/fe-set-voltage.rst | 10 +- .../media/dvb/frontend_f_close.rst | 8 +- .../media/dvb/frontend_f_open.rst | 10 +- .../userspace-api/media/dvb/net-add-if.rst | 9 +- .../userspace-api/media/dvb/net-get-if.rst | 10 +- .../userspace-api/media/dvb/net-remove-if.rst | 10 +- .../media/dvb/video-clear-buffer.rst | 8 +- .../userspace-api/media/dvb/video-command.rst | 10 +- .../media/dvb/video-continue.rst | 8 +- .../media/dvb/video-fast-forward.rst | 10 +- .../userspace-api/media/dvb/video-fclose.rst | 6 +- .../userspace-api/media/dvb/video-fopen.rst | 6 +- .../userspace-api/media/dvb/video-freeze.rst | 8 +- .../userspace-api/media/dvb/video-fwrite.rst | 6 +- .../media/dvb/video-get-capabilities.rst | 8 +- .../media/dvb/video-get-event.rst | 8 +- .../media/dvb/video-get-frame-count.rst | 8 +- .../userspace-api/media/dvb/video-get-pts.rst | 8 +- .../media/dvb/video-get-size.rst | 8 +- .../media/dvb/video-get-status.rst | 7 +- .../userspace-api/media/dvb/video-play.rst | 8 +- .../media/dvb/video-select-source.rst | 7 +- .../media/dvb/video-set-blank.rst | 8 +- .../media/dvb/video-set-display-format.rst | 8 +- .../media/dvb/video-set-format.rst | 9 +- .../media/dvb/video-set-streamtype.rst | 8 +- .../media/dvb/video-slowmotion.rst | 10 +- .../media/dvb/video-stillpicture.rst | 8 +- .../userspace-api/media/dvb/video-stop.rst | 8 +- .../media/dvb/video-try-command.rst | 8 +- .../media/mediactl/media-func-close.rst | 10 +- .../media/mediactl/media-func-ioctl.rst | 10 +- .../media/mediactl/media-func-open.rst | 10 +- .../media/mediactl/media-ioc-device-info.rst | 13 +- .../mediactl/media-ioc-enum-entities.rst | 11 +- .../media/mediactl/media-ioc-enum-links.rst | 13 +- .../media/mediactl/media-ioc-g-topology.rst | 14 +- .../mediactl/media-ioc-request-alloc.rst | 11 +- .../media/mediactl/media-ioc-setup-link.rst | 10 +- .../mediactl/media-request-ioc-queue.rst | 7 +- .../mediactl/media-request-ioc-reinit.rst | 8 +- .../media/mediactl/request-api.rst | 5 +- .../media/mediactl/request-func-close.rst | 8 +- .../media/mediactl/request-func-ioctl.rst | 8 +- .../media/mediactl/request-func-poll.rst | 12 +- .../media/rc/lirc-get-features.rst | 9 +- .../media/rc/lirc-get-rec-mode.rst | 12 +- .../media/rc/lirc-get-rec-resolution.rst | 8 +- .../media/rc/lirc-get-send-mode.rst | 14 +- .../media/rc/lirc-get-timeout.rst | 13 +- .../userspace-api/media/rc/lirc-read.rst | 10 +- .../rc/lirc-set-measure-carrier-mode.rst | 8 +- .../media/rc/lirc-set-rec-carrier-range.rst | 6 +- .../media/rc/lirc-set-rec-carrier.rst | 8 +- .../media/rc/lirc-set-rec-timeout-reports.rst | 8 +- .../media/rc/lirc-set-rec-timeout.rst | 13 +- .../media/rc/lirc-set-send-carrier.rst | 8 +- .../media/rc/lirc-set-send-duty-cycle.rst | 8 +- .../media/rc/lirc-set-transmitter-mask.rst | 8 +- .../media/rc/lirc-set-wideband-receiver.rst | 8 +- .../userspace-api/media/rc/lirc-write.rst | 7 +- .../userspace-api/media/v4l/buffer.rst | 28 +- .../userspace-api/media/v4l/dev-capture.rst | 7 +- .../userspace-api/media/v4l/dev-output.rst | 7 +- .../userspace-api/media/v4l/dev-raw-vbi.rst | 19 +- .../userspace-api/media/v4l/dev-rds.rst | 12 +- .../media/v4l/dev-sliced-vbi.rst | 31 +- .../userspace-api/media/v4l/diff-v4l.rst | 39 +-- .../userspace-api/media/v4l/dmabuf.rst | 8 +- .../userspace-api/media/v4l/format.rst | 7 +- .../userspace-api/media/v4l/func-close.rst | 8 +- .../userspace-api/media/v4l/func-ioctl.rst | 10 +- .../userspace-api/media/v4l/func-mmap.rst | 18 +- .../userspace-api/media/v4l/func-munmap.rst | 14 +- .../userspace-api/media/v4l/func-open.rst | 14 +- .../userspace-api/media/v4l/func-poll.rst | 40 ++- .../userspace-api/media/v4l/func-read.rst | 39 ++- .../userspace-api/media/v4l/func-select.rst | 42 ++- .../userspace-api/media/v4l/func-write.rst | 13 +- .../userspace-api/media/v4l/hist-v4l2.rst | 70 +--- Documentation/userspace-api/media/v4l/io.rst | 6 +- .../media/v4l/libv4l-introduction.rst | 30 +- .../userspace-api/media/v4l/mmap.rst | 26 +- .../userspace-api/media/v4l/open.rst | 15 +- Documentation/userspace-api/media/v4l/rw.rst | 18 +- .../userspace-api/media/v4l/streaming-par.rst | 5 +- .../userspace-api/media/v4l/userp.rst | 11 +- .../media/v4l/vidioc-create-bufs.rst | 11 +- .../media/v4l/vidioc-cropcap.rst | 11 +- .../media/v4l/vidioc-dbg-g-chip-info.rst | 13 +- .../media/v4l/vidioc-dbg-g-register.rst | 18 +- .../media/v4l/vidioc-decoder-cmd.rst | 19 +- .../media/v4l/vidioc-dqevent.rst | 19 +- .../media/v4l/vidioc-dv-timings-cap.rst | 17 +- .../media/v4l/vidioc-encoder-cmd.rst | 25 +- .../media/v4l/vidioc-enum-dv-timings.rst | 16 +- .../media/v4l/vidioc-enum-fmt.rst | 12 +- .../media/v4l/vidioc-enum-frameintervals.rst | 15 +- .../media/v4l/vidioc-enum-framesizes.rst | 16 +- .../media/v4l/vidioc-enum-freq-bands.rst | 12 +- .../media/v4l/vidioc-enumaudio.rst | 10 +- .../media/v4l/vidioc-enumaudioout.rst | 10 +- .../media/v4l/vidioc-enuminput.rst | 14 +- .../media/v4l/vidioc-enumoutput.rst | 13 +- .../media/v4l/vidioc-enumstd.rst | 23 +- .../userspace-api/media/v4l/vidioc-expbuf.rst | 14 +- .../media/v4l/vidioc-g-audio.rst | 18 +- .../media/v4l/vidioc-g-audioout.rst | 16 +- .../userspace-api/media/v4l/vidioc-g-crop.rst | 16 +- .../userspace-api/media/v4l/vidioc-g-ctrl.rst | 16 +- .../media/v4l/vidioc-g-dv-timings.rst | 26 +- .../userspace-api/media/v4l/vidioc-g-edid.rst | 25 +- .../media/v4l/vidioc-g-enc-index.rst | 13 +- .../media/v4l/vidioc-g-ext-ctrls.rst | 21 +- .../userspace-api/media/v4l/vidioc-g-fbuf.rst | 18 +- .../userspace-api/media/v4l/vidioc-g-fmt.rst | 22 +- .../media/v4l/vidioc-g-frequency.rst | 16 +- .../media/v4l/vidioc-g-input.rst | 15 +- .../media/v4l/vidioc-g-jpegcomp.rst | 17 +- .../media/v4l/vidioc-g-modulator.rst | 17 +- .../media/v4l/vidioc-g-output.rst | 15 +- .../userspace-api/media/v4l/vidioc-g-parm.rst | 30 +- .../media/v4l/vidioc-g-priority.rst | 16 +- .../media/v4l/vidioc-g-selection.rst | 15 +- .../media/v4l/vidioc-g-sliced-vbi-cap.rst | 12 +- .../userspace-api/media/v4l/vidioc-g-std.rst | 24 +- .../media/v4l/vidioc-g-tuner.rst | 19 +- .../media/v4l/vidioc-log-status.rst | 10 +- .../media/v4l/vidioc-overlay.rst | 10 +- .../media/v4l/vidioc-prepare-buf.rst | 10 +- .../userspace-api/media/v4l/vidioc-qbuf.rst | 17 +- .../media/v4l/vidioc-query-dv-timings.rst | 15 +- .../media/v4l/vidioc-querybuf.rst | 10 +- .../media/v4l/vidioc-querycap.rst | 16 +- .../media/v4l/vidioc-queryctrl.rst | 22 +- .../media/v4l/vidioc-querystd.rst | 15 +- .../media/v4l/vidioc-reqbufs.rst | 10 +- .../media/v4l/vidioc-s-hw-freq-seek.rst | 11 +- .../media/v4l/vidioc-streamon.rst | 14 +- .../v4l/vidioc-subdev-enum-frame-interval.rst | 10 +- .../v4l/vidioc-subdev-enum-frame-size.rst | 11 +- .../v4l/vidioc-subdev-enum-mbus-code.rst | 10 +- .../media/v4l/vidioc-subdev-g-crop.rst | 16 +- .../media/v4l/vidioc-subdev-g-fmt.rst | 17 +- .../v4l/vidioc-subdev-g-frame-interval.rst | 16 +- .../media/v4l/vidioc-subdev-g-selection.rst | 17 +- .../media/v4l/vidioc-subdev-querycap.rst | 9 +- .../media/v4l/vidioc-subscribe-event.rst | 17 +- .../virt/uml/user_mode_linux_howto_v2.rst | 1 + Documentation/vm/hmm.rst | 2 +- Documentation/vm/ksm.rst | 2 +- Documentation/vm/memory-model.rst | 6 +- MAINTAINERS | 16 +- block/bio.c | 4 +- drivers/base/core.c | 7 +- .../gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 + drivers/gpu/drm/drm_prime.c | 1 + drivers/infiniband/ulp/srpt/ib_srpt.h | 1 + drivers/net/appletalk/Kconfig | 2 +- drivers/net/hamradio/scc.c | 2 +- include/drm/drm_dp_helper.h | 2 +- include/drm/drm_edid.h | 7 - include/kunit/test.h | 16 +- include/linux/devfreq.h | 7 +- include/linux/input/sparse-keymap.h | 1 + include/linux/math64.h | 8 +- include/linux/refcount.h | 7 + include/linux/usb/typec_altmode.h | 16 + include/net/cfg80211.h | 1 + kernel/rcu/tree.c | 14 +- kernel/workqueue.c | 3 + mm/ksm.c | 2 +- mm/memblock.c | 8 +- scripts/kernel-doc | 303 +++++++++++++----- 316 files changed, 1921 insertions(+), 2285 deletions(-) delete mode 100644 Documentation/driver-api/sound.rst
Quoted 4 lines
--
2.26.2
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
Em Thu, 15 Oct 2020 17:49:23 +0200
Daniel Vetter <[email protected]> escreveu:
Quoted 11 lines · Mauro Carvalho Chehab
Quoted 10 lines
This series actually folds the previous Sphinx 3.x patch series with the other patches I sent fixing warnings with Sphinx 2.x and with kernel-doc and that weren't merged yet via some other tree.
It is based on the top of upstream, plus the media pull request I sent yesterday:
https://lore.kernel.org/lkml/[email protected]/
Quoted 8 lines
Quoted 5 lines
My plan is to send a pull request with those patches after Thursday's linux next release.
On this series, I removed the patches that depend on material currently found only at linux-next.
Was a bit tricky to find the cover letter here and that you plan to send these out this merge window.
Sorry for that. As this series touch lots of subsystems, just c/c the maintainers mean more than 50 c/c to patch 00. Some e-mail servers may not accept e-mails with too many c/c people.
Yet, checking at the c/c list of the original patch, you were copied on patch 00/80. So, maybe the e-mail server had silently dropped the original e-mail.
Quoted 2 lines
I think we'll have some confusion
now with Alex from amd having picked up a few already.
I ended moving (at least part of) the drm patches from this series into a second one, as I'm intending to submit most of those patches today or tomorrow, and the remaining ones by the end of the merge window.
Quoted 2 lines
Anyway Acked-by: Daniel Vetter <[email protected]> for the remaining drm patches.
Thank you!
Quoted 2 lines
Although I can also pick them up to drm-misc-next (but that's going to be 5.11 or so).
It would be a way better to have them merged for 5.10, in order to have a clean html build there.
Thanks,
Mauro