Fix several documentation build warnings with Sphinx 2.4.4
Subsystems (15)
cover Fix several documentation build warnings with Sphinx 2.4.4
This series is against next-20220701. It fixes several warnings that are currently produced while building html docs.
Each patch in this series is independent from the others, as each one touches a different file.
Mauro Carvalho Chehab (12):
docs: ext4: blockmap.rst: fix a broken table
docs: tegra194-hte.rst: don't include gpiolib.c twice
docs: device-mapper: add a blank line at writecache.rst
docs: PCI: pci-vntb-function.rst: Properly include ascii artwork
docs: PCI: pci-vntb-howto.rst: fix a title markup
docs: virt: kvm: fix a title markup at api.rst
docs: ABI: sysfs-bus-nvdimm
kunit: test.h: fix a kernel-doc markup
net: mac80211: fix a kernel-doc markup
docs: alsa: alsa-driver-api.rst: remove a kernel-doc file
docs: arm: index.rst: add google/chromebook-boot-flow
docs: leds: index.rst: add leds-qcom-lpg to it
Documentation/ABI/testing/sysfs-bus-nvdimm | 2 ++ Documentation/PCI/endpoint/pci-vntb-function.rst | 2 +- Documentation/PCI/endpoint/pci-vntb-howto.rst | 2 +- Documentation/admin-guide/device-mapper/writecache.rst | 1 + Documentation/arm/index.rst | 2 ++ Documentation/driver-api/hte/tegra194-hte.rst | 3 +-- Documentation/filesystems/ext4/blockmap.rst | 2 +- Documentation/leds/index.rst | 1 + Documentation/sound/kernel-api/alsa-driver-api.rst | 1 - Documentation/virt/kvm/api.rst | 6 +++--- include/kunit/test.h | 2 +- include/net/mac80211.h | 2 +- 12 files changed, 15 insertions(+), 11 deletions(-)
Signature · 1 line
2.36.1
PATCH 1/12 docs: ext4: blockmap.rst: fix a broken table
There's one missing space, causing a long error message when building the docs.
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/filesystems/ext4/blockmap.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/filesystems/ext4/blockmap.rst +1 -1
@@ -1,7 +1,7 @@ .. SPDX-License-Identifier: GPL-2.0 +---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| i.i_block Offset | Where It Points | +| i.i_block Offset | Where It Points | +=====================+==============================================================================================================================================================================================================================+ | 0 to 11 | Direct map to file blocks 0 to 11. | +---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signature · 1 line
2.36.1
PATCH 2/12 docs: tegra194-hte.rst: don't include gpiolib.c twice
In reply to Mauro Carvalho ChehabAll extern functions of drivers/gpio/gpiolib.c are already inside the Kernel documentation, as driver-api/gpio/index.rst already includes it.
Placing a kernel-doc here will only cause mess, as the same symbol will be placed on two parts of the document, causing breakages in cross-references.
So, instead, add a cross-reference there.
This solves those Sphinx 3.1+ warnings:
.../Documentation/driver-api/hte/tegra194-hte:28: ./drivers/gpio/gpiolib.c:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464. .../Documentation/driver-api/hte/tegra194-hte:28: ./drivers/gpio/gpiolib.c:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493. .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464. .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464. .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464. .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493. .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493. .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/driver-api/hte/tegra194-hte.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
Documentation/driver-api/hte/tegra194-hte.rst +1 -2
@@ -25,8 +25,7 @@ and userspace consumers. The kernel space consumers can directly talk to HTE subsystem while userspace consumers timestamp requests go through GPIOLIB CDEV framework to HTE subsystem. -.. kernel-doc:: drivers/gpio/gpiolib.c - :functions: gpiod_enable_hw_timestamp_ns gpiod_disable_hw_timestamp_ns +See gpiod_enable_hw_timestamp_ns() and gpiod_disable_hw_timestamp_ns(). For userspace consumers, GPIO_V2_LINE_FLAG_EVENT_CLOCK_HTE flag must be specified during IOCTL calls. Refer to ``tools/gpio/gpio-event-mon.c``, which
Signature · 1 line
2.36.1
Re: [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice
Quoted 34 lines · Mauro Carvalho Chehab
All extern functions of
drivers/gpio/gpiolib.care already inside the Kernel documentation, asdriver-api/gpio/index.rstalready includes it.Placing a kernel-doc here will only cause mess, as the same symbol will be placed on two parts of the document, causing breakages in cross-references.
So, instead, add a cross-reference there.
This solves those Sphinx 3.1+ warnings:
.../Documentation/driver-api/hte/tegra194-hte:28:./drivers/gpio/gpiolib.c:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464. .../Documentation/driver-api/hte/tegra194-hte:28:./drivers/gpio/gpiolib.c:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493..../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464..../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464..../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464..../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493..../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493..../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.Signed-off-by Mauro Carvalho Chehab <[email protected]>---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/driver-api/hte/tegra194-hte.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)Documentation/driver-api/hte/tegra194-hte.rst +0
-0
Documentation/driver-api/hte/tegra194-hte.rst and userspace consumers. The kernel space consumers can directly talk to HTE · line 31
Quoted 9 lines
Documentation/driver-api/hte/tegra194-hte.rst +1
-2@@ -25,8 +25,7 @@ and userspace consumers. The kernel space consumers can directly talk to HTE subsystem while userspace consumers timestamp requests go through GPIOLIB CDEV framework to HTE subsystem. -.. kernel-doc:: drivers/gpio/gpiolib.c - :functions: gpiod_enable_hw_timestamp_ns gpiod_disable_hw_timestamp_ns +See gpiod_enable_hw_timestamp_ns() and gpiod_disable_hw_timestamp_ns(). For userspace consumers, GPIO_V2_LINE_FLAG_EVENT_CLOCK_HTE flag must be specified during IOCTL calls. Refer to ``tools/gpio/gpio-event-mon.c``, which
Re: [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice
Quoted 38 lines · Dipen Patel
Quoted 37 lines · Mauro Carvalho Chehab
All extern functions of
drivers/gpio/gpiolib.care already inside the Kernel documentation, asdriver-api/gpio/index.rstalready includes it.Placing a kernel-doc here will only cause mess, as the same symbol will be placed on two parts of the document, causing breakages in cross-references.
So, instead, add a cross-reference there.
This solves those Sphinx 3.1+ warnings:
.../Documentation/driver-api/hte/tegra194-hte:28:./drivers/gpio/gpiolib.c:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464. .../Documentation/driver-api/hte/tegra194-hte:28:./drivers/gpio/gpiolib.c:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493..../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464..../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464..../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464..../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493..../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493..../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.Signed-off-by Mauro Carvalho Chehab <[email protected]>---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/driver-api/hte/tegra194-hte.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)Documentation/driver-api/hte/tegra194-hte.rst +0
-0@@ -25,8 +25,7 @@ and userspace consumers. The kernel space consumers can directly talk to HTE subsystem while userspace consumers timestamp requests go through GPIOLIB CDEV framework to HTE subsystem.
Quoted 8 lines
Documentation/driver-api/hte/tegra194-hte.rst and userspace consumers. The kernel space consumers can directly talk to HTE · line 31
Quoted 6 lines
Documentation/driver-api/hte/tegra194-hte.rst +1
-2-.. kernel-doc:: drivers/gpio/gpiolib.c - :functions: gpiod_enable_hw_timestamp_ns gpiod_disable_hw_timestamp_ns +See gpiod_enable_hw_timestamp_ns() and gpiod_disable_hw_timestamp_ns(). For userspace consumers, GPIO_V2_LINE_FLAG_EVENT_CLOCK_HTE flag must be specified during IOCTL calls. Refer to ``tools/gpio/gpio-event-mon.c``, whichAcked-by Dipen Patel <[email protected]>
Hi Jonathan,
here's another one that applies on top of that earlier patch. Can you apply this to your tree?
Thanks,
Thierry
Jonathan Corbet
maintainerRe: [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice
Quoted 2 lines · Thierry Reding
here's another one that applies on top of that earlier patch. Can you apply this to your tree?
Done.
Thanks,
jon
PATCH 3/12 docs: device-mapper: add a blank line at writecache.rst
In reply to Mauro Carvalho ChehabThe lack of it causes a build warning:
Documentation/admin-guide/device-mapper/writecache.rst:23: WARNING: Unexpected indentation.
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/admin-guide/device-mapper/writecache.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/admin-guide/device-mapper/writecache.rst +1 -0
@@ -20,6 +20,7 @@ Constructor parameters: size) 5. the number of optional parameters (the parameters with an argument count as two) + start_sector n (default: 0) offset from the start of cache device in 512-byte sectors high_watermark n (default: 50)
Signature · 1 line
2.36.1
PATCH 4/12 docs: PCI: pci-vntb-function.rst: Properly include ascii artwork
In reply to Mauro Carvalho ChehabAdjust identation and add a "::" in order to properly mark the ascii artwork as a code block, fixing this warning:
Documentation/PCI/endpoint/pci-vntb-function.rst:82: WARNING: Unexpected indentation.
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/PCI/endpoint/pci-vntb-function.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/PCI/endpoint/pci-vntb-function.rst +1 -1
@@ -58,7 +58,7 @@ It is same as PCI NTB Function driver Scratchpad Registers: --------------------- - It is appended after Config region. +It is appended after Config region:: +--------------------------------------------------+ Base | |
Signature · 1 line
2.36.1
Re: [PATCH 04/12] docs: PCI: pci-vntb-function.rst: Properly include ascii artwork
[+cc Jon, Frank]
Quoted 6 lines · Mauro Carvalho Chehab
Adjust identation and add a "::" in order to properly mark the ascii artwork as a code block, fixing this warning:
Documentation/PCI/endpoint/pci-vntb-function.rst:82: WARNING: Unexpected indentation.Signed-off-by Mauro Carvalho Chehab <[email protected]>
The series that adds this doc appears to be being merged via Jon (cc'd).
Quoted 24 lines
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/PCI/endpoint/pci-vntb-function.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)Documentation/PCI/endpoint/pci-vntb-function.rst +1
-1@@ -58,7 +58,7 @@ It is same as PCI NTB Function driver Scratchpad Registers: --------------------- - It is appended after Config region. +It is appended after Config region:: +--------------------------------------------------+ Base | |Signature · 1 line
2.36.1
PATCH 5/12 docs: PCI: pci-vntb-howto.rst: fix a title markup
In reply to Mauro Carvalho ChehabAs warned by Sphinx:
Documentation/PCI/endpoint/pci-vntb-howto.rst:131: WARNING: Title underline too short.
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/PCI/endpoint/pci-vntb-howto.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/PCI/endpoint/pci-vntb-howto.rst +1 -1
@@ -128,7 +128,7 @@ RootComplex Device ================== lspci Output at Host side ------------------------- +------------------------- Note that the devices listed here correspond to the values populated in "Creating pci-epf-ntb Device" section above::
Signature · 1 line
2.36.1
Re: [PATCH 05/12] docs: PCI: pci-vntb-howto.rst: fix a title markup
[+cc Jon, Frank]
Quoted 4 lines · Mauro Carvalho Chehab
As warned by Sphinx:
Documentation/PCI/endpoint/pci-vntb-howto.rst:131: WARNING: Title underline too short.Signed-off-by Mauro Carvalho Chehab <[email protected]>
Another for Jon.
Quoted 24 lines
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/PCI/endpoint/pci-vntb-howto.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)Documentation/PCI/endpoint/pci-vntb-howto.rst +1
-1@@ -128,7 +128,7 @@ RootComplex Device ================== lspci Output at Host side ------------------------- +------------------------- Note that the devices listed here correspond to the values populated in "Creating pci-epf-ntb Device" section above::Signature · 1 line
2.36.1
PATCH 6/12 docs: virt: kvm: fix a title markup at api.rst
In reply to Mauro Carvalho ChehabAs warned by Sphinx:
Documentation/virt/kvm/api.rst:8210: WARNING: Title underline too short.
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/virt/kvm/api.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/virt/kvm/api.rst +3 -3
@@ -8207,15 +8207,15 @@ dump related UV data. Also the vcpu ioctl `KVM_S390_PV_CPU_COMMAND` is available and supports the `KVM_PV_DUMP_CPU` subcommand. 8.38 KVM_CAP_VM_DISABLE_NX_HUGE_PAGES ---------------------------- +------------------------------------- :Capability KVM_CAP_VM_DISABLE_NX_HUGE_PAGES :Architectures: x86 :Type: vm :Parameters: arg[0] must be 0. :Returns 0 on success, -EPERM if the userspace process does not - have CAP_SYS_BOOT, -EINVAL if args[0] is not 0 or any vCPUs have been - created. +have CAP_SYS_BOOT, -EINVAL if args[0] is not 0 or any vCPUs have been +created. This capability disables the NX huge pages mitigation for iTLB MULTIHIT.
Signature · 1 line
2.36.1
PATCH 7/12 docs: ABI: sysfs-bus-nvdimm
In reply to Mauro Carvalho ChehabAdd blank lines, as this is required by code-block markup syntax.
Fix this warning:
Documentation/ABI/testing/sysfs-bus-nvdimm:11: WARNING: Unexpected indentation.
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/ABI/testing/sysfs-bus-nvdimm | 2 ++ 1 file changed, 2 insertions(+)
Documentation/ABI/testing/sysfs-bus-nvdimm +2 -0
@@ -18,9 +18,11 @@ Description: (RO) Attribute group to describe the magic bits Each attribute under this group defines a bit range of the perf_event_attr.config. Supported attribute is listed below:: + event = "config:0-4" - event ID For example:: + ctl_res_cnt = "event=0x1" What: /sys/bus/event_source/devices/nmemX/events
Signature · 1 line
2.36.1
Re: [PATCH 07/12] docs: ABI: sysfs-bus-nvdimm
Quoted 8 lines · Mauro Carvalho Chehab
Add blank lines, as this is required by code-block markup syntax.
Fix this warning:
Documentation/ABI/testing/sysfs-bus-nvdimm:11: WARNING: Unexpected indentation.Signed-off-by Mauro Carvalho Chehab <[email protected]>---
Patch looks fine to me.
Thanks,
Kajol Jain
Quoted 22 lines
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/ABI/testing/sysfs-bus-nvdimm | 2 ++ 1 file changed, 2 insertions(+)Documentation/ABI/testing/sysfs-bus-nvdimm +2
-0@@ -18,9 +18,11 @@ Description: (RO) Attribute group to describe the magic bits Each attribute under this group defines a bit range of the perf_event_attr.config. Supported attribute is listed below:: + event = "config:0-4" - event ID For example:: + ctl_res_cnt = "event=0x1" What: /sys/bus/event_source/devices/nmemX/events
PATCH 8/12 kunit: test.h: fix a kernel-doc markup
In reply to Mauro Carvalho ChehabFix this kernel-doc warning:
Documentation/dev-tools/kunit/api/test:9: ./include/kunit/test.h:323: WARNING: Inline interpreted text or phrase reference start-string without end-string.
Functions should use func_name() on kernel-doc markups, as documented at:
Documentation/doc-guide/kernel-doc.rst
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
include/kunit/test.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/kunit/test.h +1 -1
@@ -320,7 +320,7 @@ static inline int kunit_run_all_tests(void)* * @__suites: a statically allocated list of &struct kunit_suite. * -* This functions identically as &kunit_test_suites() except that it suppresses +* This functions identically as kunit_test_suites() except that it suppresses * modpost warnings for referencing functions marked __init or data marked * __initdata; this is OK because currently KUnit only runs tests upon boot * during the init phase or upon loading a module during the init phase.
Signature · 1 line
2.36.1
Re: [PATCH 08/12] kunit: test.h: fix a kernel-doc markup
Quoted 9 lines · Mauro Carvalho Chehab
Fix this kernel-doc warning:
Documentation/dev-tools/kunit/api/test:9:./include/kunit/test.h:323: WARNING: Inline interpreted text or phrase reference start-string without end-string.Functions should use
func_name()on kernel-doc markups, as documented at:
Documentation/doc-guide/kernel-doc.rst
Quoted 6 lines
Signed-off-by Mauro Carvalho Chehab <[email protected]>---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
FYI, this is identical to:
https://lore.kernel.org/all/[email protected]/
It doesn't matter which one goes through, so if this patch is applied (e.g. to the docs tree as a part of this series), I'll make sure the other one doesn't end up in the KUnit tree.
Cheers,
-- David
Quoted 23 lines
include/kunit/test.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)include/kunit/test.h +1
-2@@ -320,7 +320,7 @@ static inline int kunit_run_all_tests(void)* * @__suites: a statically allocated list of &struct kunit_suite. * -* This functions identically as &kunit_test_suites() except that it suppresses +* This functions identically as kunit_test_suites() except that it suppresses * modpost warnings for referencing functions marked __init or data marked * __initdata; this is OK because currently KUnit only runs tests upon boot * during the init phase or upon loading a module during the init phase. -- 2.36.1
--
You received this message because you are subscribed to the Google Groups "KUnit Development" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected].
To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/32a67e9ee77cc6c435d08a2cb5ef12559b417fee.1656759989.git.mchehab%40kernel.org.
Shuah Khan
maintainerRe: [PATCH 08/12] kunit: test.h: fix a kernel-doc markup
Quoted 22 lines · David Gow
Quoted 9 lines · Mauro Carvalho Chehab
Fix this kernel-doc warning:
Documentation/dev-tools/kunit/api/test:9:./include/kunit/test.h:323: WARNING: Inline interpreted text or phrase reference start-string without end-string.Functions should use
func_name()on kernel-doc markups, as documented at:
Documentation/doc-guide/kernel-doc.rstQuoted 6 lines
Signed-off-by Mauro Carvalho Chehab <[email protected]>---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Reviewed-by David Gow <[email protected]>FYI, this is identical to:
https://lore.kernel.org/all/[email protected]/
Quoted 7 lines
It doesn't matter which one goes through, so if this patch is applied (e.g. to the docs tree as a part of this series), I'll make sure the other one doesn't end up in the KUnit tree.
Cheers,
-- David
Applied this now to linux-kselftest kunit branch for 5.20-rc1
thanks,
-- Shuah
PATCH 9/12 net: mac80211: fix a kernel-doc markup
In reply to Mauro Carvalho ChehabThe markup to reference a var should be just @foo, and not @foo[]. Using the later causes a kernel-doc warning:
Documentation/driver-api/80211/mac80211:32: ./include/net/mac80211.h:4045: WARNING: Inline strong start-string without end-string.
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
include/net/mac80211.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/net/mac80211.h +1 -1
@@ -4045,7 +4045,7 @@ struct ieee80211_prep_tx_info {* removing the old link information is still valid (link_conf pointer), * but may immediately disappear after the function returns. The old or * new links bitmaps may be 0 if going from/to a non-MLO situation. -* The @old[] array contains pointers to the old bss_conf structures +* The @old array contains pointers to the old bss_conf structures * that were already removed, in case they're needed. * This callback can sleep. * @change_sta_links: Change the valid links of a station, similar to
Signature · 1 line
2.36.1
PATCH 10/12 docs: alsa: alsa-driver-api.rst: remove a kernel-doc file
In reply to Mauro Carvalho ChehabThis file:
sound/core/compress_offload.c
Doesn't define any docs, as everything is inside the header file. So, drop it, in order to remove a Sphinx warning.
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/sound/kernel-api/alsa-driver-api.rst | 1 - 1 file changed, 1 deletion(-)
Documentation/sound/kernel-api/alsa-driver-api.rst +0 -1
@@ -86,7 +86,6 @@ Compress Offload Compress Offload API -------------------- -.. kernel-doc:: sound/core/compress_offload.c .. kernel-doc:: include/uapi/sound/compress_offload.h .. kernel-doc:: include/uapi/sound/compress_params.h .. kernel-doc:: include/sound/compress_driver.h
Signature · 1 line
2.36.1
Re: [PATCH 10/12] docs: alsa: alsa-driver-api.rst: remove a kernel-doc file
Quoted 8 lines · Mauro Carvalho Chehab
This file:
sound/core/compress_offload.cDoesn't define any docs, as everything is inside the header file. So, drop it, in order to remove a Sphinx warning.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Hmm, it looks rather like that some comments (at least for exported functions) should be marked with kerneldoc markers instead.
I'm going to fix those comments.
thanks,
Takashi
Quoted 23 lines
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/sound/kernel-api/alsa-driver-api.rst | 1 - 1 file changed, 1 deletion(-)Documentation/sound/kernel-api/alsa-driver-api.rst +0
-1@@ -86,7 +86,6 @@ Compress Offload Compress Offload API -------------------- -.. kernel-doc:: sound/core/compress_offload.c .. kernel-doc:: include/uapi/sound/compress_offload.h .. kernel-doc:: include/uapi/sound/compress_params.h .. kernel-doc:: include/sound/compress_driver.hSignature · 1 line
2.36.1
Re: [PATCH 10/12] docs: alsa: alsa-driver-api.rst: remove a kernel-doc file
Em Mon, 04 Jul 2022 14:54:19 +0200
Takashi Iwai <[email protected]> escreveu:
Quoted 9 lines
Quoted 7 lines · Mauro Carvalho Chehab
This file:
sound/core/compress_offload.cDoesn't define any docs, as everything is inside the header file. So, drop it, in order to remove a Sphinx warning.
Quoted 6 lines
Quoted 1 line
Signed-off-by Mauro Carvalho Chehab <[email protected]>Hmm, it looks rather like that some comments (at least for exported functions) should be marked with kerneldoc markers instead.
I'm going to fix those comments.
Go for it: adding kerneldoc markers is indeed a better solution :-)
Regards,
Mauro
Quoted 29 lines
thanks,
Takashi
Quoted 23 lines
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/sound/kernel-api/alsa-driver-api.rst | 1 - 1 file changed, 1 deletion(-)Documentation/sound/kernel-api/alsa-driver-api.rst +0
-1@@ -86,7 +86,6 @@ Compress Offload Compress Offload API -------------------- -.. kernel-doc:: sound/core/compress_offload.c .. kernel-doc:: include/uapi/sound/compress_offload.h .. kernel-doc:: include/uapi/sound/compress_params.h .. kernel-doc:: include/sound/compress_driver.hSignature · 1 line
2.36.1
PATCH 11/12 docs: arm: index.rst: add google/chromebook-boot-flow
In reply to Mauro Carvalho ChehabThis document was added without placing it at arm book.
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/arm/index.rst | 2 ++ 1 file changed, 2 insertions(+)
Documentation/arm/index.rst +2 -0
@@ -31,6 +31,8 @@ SoC-specific documents .. toctree:: :maxdepth: 1 + google/chromebook-boot-flow + ixp4xx marvell
Signature · 1 line
2.36.1
Re: [PATCH 11/12] docs: arm: index.rst: add google/chromebook-boot-flow
Hi,
Quoted 18 lines · Mauro Carvalho Chehab
This document was added without placing it at arm book.
Fixes 59228d3b9060 ("dt-bindings: Document how Chromebooks with depthcharge boot")Signed-off-by Mauro Carvalho Chehab <[email protected]>---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/arm/index.rst | 2 ++ 1 file changed, 2 insertions(+)Documentation/arm/index.rst +0
-0
Documentation/arm/index.rst SoC-specific documents · line 35
Quoted 5 lines
Documentation/arm/index.rst +2
-0@@ -31,6 +31,8 @@ SoC-specific documents .. toctree:: :maxdepth: 1 + google/chromebook-boot-flow +
Sure, seems reasonable. It's not truly SoC-specific but I guess there's no better place for it.
Re: [PATCH 11/12] docs: arm: index.rst: add google/chromebook-boot-flow
Hi,
Quoted 25 lines · Doug Anderson
Hi,
Quoted 21 lines · Mauro Carvalho Chehab
This document was added without placing it at arm book.
Fixes 59228d3b9060 ("dt-bindings: Document how Chromebooks with depthcharge boot")Signed-off-by Mauro Carvalho Chehab <[email protected]>---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/arm/index.rst | 2 ++ 1 file changed, 2 insertions(+)Documentation/arm/index.rst +0
-0@@ -31,6 +31,8 @@ SoC-specific documents .. toctree:: :maxdepth: 1
Quoted 7 lines
Documentation/arm/index.rst SoC-specific documents · line 35
Quoted 2 lines
Documentation/arm/index.rst +2
-0+ google/chromebook-boot-flow +Sure, seems reasonable. It's not truly SoC-specific but I guess there's no better place for it.
Reviewed-by Douglas Anderson <[email protected]>
Just to be clear, this probably should go into the Qualcomm tree.
-Doug
Bjorn Andersson
AppliedRe: (subset) [PATCH 11/12] docs: arm: index.rst: add google/chromebook-boot-flow
In reply to Mauro Carvalho ChehabQuoted 3 lines · Mauro Carvalho Chehab
This document was added without placing it at arm book.
Applied, thanks!
[11/12] docs: arm: index.rst: add google/chromebook-boot-flow
commit: 1e061d985fee50cfcb91a1d2aedbfd43d2f11aaa
Best regards,
Signature · 1 line
Bjorn Andersson <[email protected]>
PATCH 12/12 docs: leds: index.rst: add leds-qcom-lpg to it
In reply to Mauro Carvalho ChehabThis document was added without placing it at leds index.
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/[email protected]/
Documentation/leds/index.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/leds/index.rst +1 -0
@@ -25,4 +25,5 @@ LEDs leds-lp5562 leds-lp55xx leds-mlxcpld + leds-qcom-lpg leds-sc27xx
Signature · 1 line
2.36.1
Quoted 6 lines · Mauro Carvalho Chehab
This series is against next-20220701. It fixes several warnings that are currently produced while building html docs.
Each patch in this series is independent from the others, as each one touches a different file.
Quoted 14 lines
Mauro Carvalho Chehab (12):
docs: ext4:blockmap.rst: fix a broken table
docs:tegra194-hte.rst: don't includegpiolib.ctwice
docs: device-mapper: add a blank line atwritecache.rst
docs: PCI:pci-vntb-function.rst: Properly include ascii artwork
docs: PCI:pci-vntb-howto.rst: fix a title markup
docs: virt: kvm: fix a title markup atapi.rst
docs: ABI: sysfs-bus-nvdimm
kunit:test.h: fix a kernel-doc markup
net: mac80211: fix a kernel-doc markup
docs: alsa:alsa-driver-api.rst: remove a kernel-doc file
docs: arm:index.rst: add google/chromebook-boot-flow
docs: leds:index.rst: add leds-qcom-lpg to it
Hi Mauro,
Thanks for cleaning up these warning above. However, I have already submitted some of these cleanups (pending reviews or integration):
[1]: https://lore.kernel.org/linux-doc/[email protected]/
[2]: https://lore.kernel.org/linux-doc/[email protected]/
[3]: https://lore.kernel.org/linux-doc/[email protected]/
[4]: https://lore.kernel.org/linux-doc/[email protected]/
There's still a warning left:
Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.
But I think the Date: field that triggered the warning above looks OK.
Regardless of that, the build successed.
Signature · 1 line
An old man doll... just what I always wanted! - Clara