[PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4

[PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4

[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.

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(-)

-- 
2.36.1

[PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4

[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.

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(-)

-- 
2.36.1

[dm-devel] [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4

[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.

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(-)

-- 
2.36.1


--
dm-devel mailing list
dm-devel@redhat.com
https://listman.redhat.com/mailman/listinfo/dm-devel

[PATCH 01/12] docs: ext4: blockmap.rst: fix a broken table

[Mauro Carvalho Chehab]

There's one missing space, causing a long error message when
building the docs.

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

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/cover.1656759988.git.mchehab@kernel.org/

 Documentation/filesystems/ext4/blockmap.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/filesystems/ext4/blockmap.rst b/Documentation/filesystems/ext4/blockmap.rst
index 2bd990402a5c..cc596541ce79 100644
--- a/Documentation/filesystems/ext4/blockmap.rst
+++ b/Documentation/filesystems/ext4/blockmap.rst
@@ -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.                                                                                                                                                                                           |
 +---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-- 
2.36.1

[PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice

[Mauro Carvalho Chehab]

All 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.

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

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/cover.1656759988.git.mchehab@kernel.org/

 Documentation/driver-api/hte/tegra194-hte.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/Documentation/driver-api/hte/tegra194-hte.rst b/Documentation/driver-api/hte/tegra194-hte.rst
index d29b7fe86f31..f2d617265546 100644
--- a/Documentation/driver-api/hte/tegra194-hte.rst
+++ b/Documentation/driver-api/hte/tegra194-hte.rst
@@ -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
-- 
2.36.1

[PATCH 03/12] docs: device-mapper: add a blank line at writecache.rst

[Mauro Carvalho Chehab]

The lack of it causes a build warning:

	Documentation/admin-guide/device-mapper/writecache.rst:23: WARNING: Unexpected indentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

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/cover.1656759988.git.mchehab@kernel.org/

 Documentation/admin-guide/device-mapper/writecache.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/admin-guide/device-mapper/writecache.rst b/Documentation/admin-guide/device-mapper/writecache.rst
index 10429779a91a..6bf78b0446ac 100644
--- a/Documentation/admin-guide/device-mapper/writecache.rst
+++ b/Documentation/admin-guide/device-mapper/writecache.rst
@@ -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)
-- 
2.36.1

[dm-devel] [PATCH 03/12] docs: device-mapper: add a blank line at writecache.rst

[Mauro Carvalho Chehab]

The lack of it causes a build warning:

	Documentation/admin-guide/device-mapper/writecache.rst:23: WARNING: Unexpected indentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

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/cover.1656759988.git.mchehab@kernel.org/

 Documentation/admin-guide/device-mapper/writecache.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/admin-guide/device-mapper/writecache.rst b/Documentation/admin-guide/device-mapper/writecache.rst
index 10429779a91a..6bf78b0446ac 100644
--- a/Documentation/admin-guide/device-mapper/writecache.rst
+++ b/Documentation/admin-guide/device-mapper/writecache.rst
@@ -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)
-- 
2.36.1

--
dm-devel mailing list
dm-devel@redhat.com
https://listman.redhat.com/mailman/listinfo/dm-devel

[PATCH 04/12] docs: PCI: pci-vntb-function.rst: Properly include ascii artwork

[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 <mchehab@kernel.org>
---

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/cover.1656759988.git.mchehab@kernel.org/

 Documentation/PCI/endpoint/pci-vntb-function.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/PCI/endpoint/pci-vntb-function.rst b/Documentation/PCI/endpoint/pci-vntb-function.rst
index cad8013e8839..7b2ac70e2c57 100644
--- a/Documentation/PCI/endpoint/pci-vntb-function.rst
+++ b/Documentation/PCI/endpoint/pci-vntb-function.rst
@@ -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
   |                                                  |
-- 
2.36.1

[PATCH 05/12] docs: PCI: pci-vntb-howto.rst: fix a title markup

[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 <mchehab@kernel.org>
---

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/cover.1656759988.git.mchehab@kernel.org/

 Documentation/PCI/endpoint/pci-vntb-howto.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/PCI/endpoint/pci-vntb-howto.rst b/Documentation/PCI/endpoint/pci-vntb-howto.rst
index b4a679144692..31a0bae868f9 100644
--- a/Documentation/PCI/endpoint/pci-vntb-howto.rst
+++ b/Documentation/PCI/endpoint/pci-vntb-howto.rst
@@ -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::
-- 
2.36.1

[PATCH 06/12] docs: virt: kvm: fix a title markup at api.rst

[Mauro Carvalho Chehab]

As warned by Sphinx:

	Documentation/virt/kvm/api.rst:8210: WARNING: Title underline too short.

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

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/cover.1656759988.git.mchehab@kernel.org/

 Documentation/virt/kvm/api.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index 1a0f68d23999..3466f7124833 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -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.
 
-- 
2.36.1

[PATCH 07/12] docs: ABI: sysfs-bus-nvdimm

[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 <mchehab@kernel.org>
---

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/cover.1656759988.git.mchehab@kernel.org/

 Documentation/ABI/testing/sysfs-bus-nvdimm | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-bus-nvdimm b/Documentation/ABI/testing/sysfs-bus-nvdimm
index 1c1f5acbf53d..eeabba807e4b 100644
--- a/Documentation/ABI/testing/sysfs-bus-nvdimm
+++ b/Documentation/ABI/testing/sysfs-bus-nvdimm
@@ -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
-- 
2.36.1

[PATCH 08/12] kunit: test.h: fix a kernel-doc markup

[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

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

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/cover.1656759988.git.mchehab@kernel.org/

 include/kunit/test.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/kunit/test.h b/include/kunit/test.h
index 8ffcd7de9607..f1c1a95df9b8 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -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

[PATCH 09/12] net: mac80211: fix a kernel-doc markup

[Mauro Carvalho Chehab]

The 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.

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

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/cover.1656759988.git.mchehab@kernel.org/

 include/net/mac80211.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/net/mac80211.h b/include/net/mac80211.h
index 9d8b5b0ee1cb..3e19b0001b41 100644
--- a/include/net/mac80211.h
+++ b/include/net/mac80211.h
@@ -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
-- 
2.36.1

[PATCH 10/12] docs: alsa: alsa-driver-api.rst: remove a kernel-doc file

[Mauro Carvalho Chehab]

This 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.

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

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/cover.1656759988.git.mchehab@kernel.org/

 Documentation/sound/kernel-api/alsa-driver-api.rst | 1 -
 1 file changed, 1 deletion(-)

diff --git a/Documentation/sound/kernel-api/alsa-driver-api.rst b/Documentation/sound/kernel-api/alsa-driver-api.rst
index d24c64df7069..3cf8eb4ecaf4 100644
--- a/Documentation/sound/kernel-api/alsa-driver-api.rst
+++ b/Documentation/sound/kernel-api/alsa-driver-api.rst
@@ -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
-- 
2.36.1

[PATCH 10/12] docs: alsa: alsa-driver-api.rst: remove a kernel-doc file

[Mauro Carvalho Chehab]

This 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.

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

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/cover.1656759988.git.mchehab@kernel.org/

 Documentation/sound/kernel-api/alsa-driver-api.rst | 1 -
 1 file changed, 1 deletion(-)

diff --git a/Documentation/sound/kernel-api/alsa-driver-api.rst b/Documentation/sound/kernel-api/alsa-driver-api.rst
index d24c64df7069..3cf8eb4ecaf4 100644
--- a/Documentation/sound/kernel-api/alsa-driver-api.rst
+++ b/Documentation/sound/kernel-api/alsa-driver-api.rst
@@ -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
-- 
2.36.1

[PATCH 11/12] docs: arm: index.rst: add google/chromebook-boot-flow

[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 <mchehab@kernel.org>
---

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/cover.1656759988.git.mchehab@kernel.org/

 Documentation/arm/index.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/arm/index.rst b/Documentation/arm/index.rst
index 2bda5461a80b..495ada7915e1 100644
--- a/Documentation/arm/index.rst
+++ b/Documentation/arm/index.rst
@@ -31,6 +31,8 @@ SoC-specific documents
 .. toctree::
    :maxdepth: 1
 
+   google/chromebook-boot-flow
+
    ixp4xx
 
    marvell
-- 
2.36.1

[PATCH 12/12] docs: leds: index.rst: add leds-qcom-lpg to it

[Mauro Carvalho Chehab]

This document was added without placing it at leds index.

Fixes: 24e2d05d1b68 ("leds: Add driver for Qualcomm LPG")
Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

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/cover.1656759988.git.mchehab@kernel.org/

 Documentation/leds/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst
index e5d63b940045..014e009b0761 100644
--- a/Documentation/leds/index.rst
+++ b/Documentation/leds/index.rst
@@ -25,4 +25,5 @@ LEDs
    leds-lp5562
    leds-lp55xx
    leds-mlxcpld
+   leds-qcom-lpg
    leds-sc27xx
-- 
2.36.1

Re: [PATCH 08/12] kunit: test.h: fix a kernel-doc markup

[David Gow]

[-- Attachment #1: Type: text/plain, Size: 2221 bytes --]

On Sat, Jul 2, 2022 at 7:07 PM Mauro Carvalho Chehab <mchehab@kernel.org> wrote:
>
> 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
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
> ---
>
> 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/cover.1656759988.git.mchehab@kernel.org/
>

Reviewed-by: David Gow <davidgow@google.com>

FYI, this is identical to:
https://lore.kernel.org/all/20220702051205.3292468-1-davidgow@google.com/

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

>  include/kunit/test.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/kunit/test.h b/include/kunit/test.h
> index 8ffcd7de9607..f1c1a95df9b8 100644
> --- a/include/kunit/test.h
> +++ b/include/kunit/test.h
> @@ -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 kunit-dev+unsubscribe@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/32a67e9ee77cc6c435d08a2cb5ef12559b417fee.1656759989.git.mchehab%40kernel.org.

[-- Attachment #2: S/MIME Cryptographic Signature --]
[-- Type: application/pkcs7-signature, Size: 4003 bytes --]

Re: [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4

[Bagas Sanjaya]

On Sat, Jul 02, 2022 at 12:07:32PM +0100, Mauro Carvalho Chehab wrote:
> 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
> 

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/20220702042350.23187-1-bagasdotme@gmail.com/
[2]: https://lore.kernel.org/linux-doc/20220612000125.9777-1-bagasdotme@gmail.com/
[3]: https://lore.kernel.org/linux-doc/20220627095151.19339-1-bagasdotme@gmail.com/
[4]: https://lore.kernel.org/linux-doc/20220627082928.11239-1-bagasdotme@gmail.com/

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.

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4

[Bagas Sanjaya]

On Sat, Jul 02, 2022 at 12:07:32PM +0100, Mauro Carvalho Chehab wrote:
> 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
> 

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/20220702042350.23187-1-bagasdotme@gmail.com/
[2]: https://lore.kernel.org/linux-doc/20220612000125.9777-1-bagasdotme@gmail.com/
[3]: https://lore.kernel.org/linux-doc/20220627095151.19339-1-bagasdotme@gmail.com/
[4]: https://lore.kernel.org/linux-doc/20220627082928.11239-1-bagasdotme@gmail.com/

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.

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

Re: [dm-devel] [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4

[Bagas Sanjaya]

On Sat, Jul 02, 2022 at 12:07:32PM +0100, Mauro Carvalho Chehab wrote:
> 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
> 

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/20220702042350.23187-1-bagasdotme@gmail.com/
[2]: https://lore.kernel.org/linux-doc/20220612000125.9777-1-bagasdotme@gmail.com/
[3]: https://lore.kernel.org/linux-doc/20220627095151.19339-1-bagasdotme@gmail.com/
[4]: https://lore.kernel.org/linux-doc/20220627082928.11239-1-bagasdotme@gmail.com/

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.

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

--
dm-devel mailing list
dm-devel@redhat.com
https://listman.redhat.com/mailman/listinfo/dm-devel

Re: [PATCH 10/12] docs: alsa: alsa-driver-api.rst: remove a kernel-doc file

[Takashi Iwai]

On Sat, 02 Jul 2022 13:07:42 +0200,
Mauro Carvalho Chehab wrote:
> 
> This 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.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>

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

> ---
> 
> 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/cover.1656759988.git.mchehab@kernel.org/
> 
>  Documentation/sound/kernel-api/alsa-driver-api.rst | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/Documentation/sound/kernel-api/alsa-driver-api.rst b/Documentation/sound/kernel-api/alsa-driver-api.rst
> index d24c64df7069..3cf8eb4ecaf4 100644
> --- a/Documentation/sound/kernel-api/alsa-driver-api.rst
> +++ b/Documentation/sound/kernel-api/alsa-driver-api.rst
> @@ -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
> -- 
> 2.36.1
> 

Re: [PATCH 10/12] docs: alsa: alsa-driver-api.rst: remove a kernel-doc file

[Takashi Iwai]

On Sat, 02 Jul 2022 13:07:42 +0200,
Mauro Carvalho Chehab wrote:
> 
> This 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.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>

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

> ---
> 
> 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/cover.1656759988.git.mchehab@kernel.org/
> 
>  Documentation/sound/kernel-api/alsa-driver-api.rst | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/Documentation/sound/kernel-api/alsa-driver-api.rst b/Documentation/sound/kernel-api/alsa-driver-api.rst
> index d24c64df7069..3cf8eb4ecaf4 100644
> --- a/Documentation/sound/kernel-api/alsa-driver-api.rst
> +++ b/Documentation/sound/kernel-api/alsa-driver-api.rst
> @@ -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
> -- 
> 2.36.1
> 

Re: [PATCH 11/12] docs: arm: index.rst: add google/chromebook-boot-flow

[Doug Anderson]

Hi,

On Sat, Jul 2, 2022 at 4:07 AM Mauro Carvalho Chehab <mchehab@kernel.org> wrote:
>
> 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 <mchehab@kernel.org>
> ---
>
> 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/cover.1656759988.git.mchehab@kernel.org/
>
>  Documentation/arm/index.rst | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/Documentation/arm/index.rst b/Documentation/arm/index.rst
> index 2bda5461a80b..495ada7915e1 100644
> --- a/Documentation/arm/index.rst
> +++ b/Documentation/arm/index.rst
> @@ -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.

Reviewed-by: Douglas Anderson <dianders@chromium.org>

Re: [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice

[Dipen Patel]

On 7/2/22 4:07 AM, Mauro Carvalho Chehab wrote:
> All 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.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
> ---
>
> 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/cover.1656759988.git.mchehab@kernel.org/
>
>  Documentation/driver-api/hte/tegra194-hte.rst | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/Documentation/driver-api/hte/tegra194-hte.rst b/Documentation/driver-api/hte/tegra194-hte.rst
> index d29b7fe86f31..f2d617265546 100644
> --- a/Documentation/driver-api/hte/tegra194-hte.rst
> +++ b/Documentation/driver-api/hte/tegra194-hte.rst
> @@ -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

Acked-by: Dipen Patel <dipenp@nvidia.com>

Re: [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice

[Thierry Reding]

[-- Attachment #1: Type: text/plain, Size: 3188 bytes --]

On Wed, Jul 06, 2022 at 01:48:58PM -0700, Dipen Patel wrote:
> On 7/2/22 4:07 AM, Mauro Carvalho Chehab wrote:
> > All 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.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
> > ---
> >
> > 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/cover.1656759988.git.mchehab@kernel.org/
> >
> >  Documentation/driver-api/hte/tegra194-hte.rst | 3 +--
> >  1 file changed, 1 insertion(+), 2 deletions(-)
> >
> > diff --git a/Documentation/driver-api/hte/tegra194-hte.rst b/Documentation/driver-api/hte/tegra194-hte.rst
> > index d29b7fe86f31..f2d617265546 100644
> > --- a/Documentation/driver-api/hte/tegra194-hte.rst
> > +++ b/Documentation/driver-api/hte/tegra194-hte.rst
> > @@ -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
> 
> Acked-by: Dipen Patel <dipenp@nvidia.com>

Hi Jonathan,

here's another one that applies on top of that earlier patch. Can you
apply this to your tree?

Thanks,
Thierry

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH 11/12] docs: arm: index.rst: add google/chromebook-boot-flow

[Doug Anderson]

Hi,

On Wed, Jul 6, 2022 at 9:34 AM Doug Anderson <dianders@chromium.org> wrote:
>
> Hi,
>
> On Sat, Jul 2, 2022 at 4:07 AM Mauro Carvalho Chehab <mchehab@kernel.org> wrote:
> >
> > 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 <mchehab@kernel.org>
> > ---
> >
> > 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/cover.1656759988.git.mchehab@kernel.org/
> >
> >  Documentation/arm/index.rst | 2 ++
> >  1 file changed, 2 insertions(+)
> >
> > diff --git a/Documentation/arm/index.rst b/Documentation/arm/index.rst
> > index 2bda5461a80b..495ada7915e1 100644
> > --- a/Documentation/arm/index.rst
> > +++ b/Documentation/arm/index.rst
> > @@ -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.
>
> Reviewed-by: Douglas Anderson <dianders@chromium.org>

Just to be clear, this probably should go into the Qualcomm tree.

-Doug

Re: [PATCH 07/12] docs: ABI: sysfs-bus-nvdimm

[kajoljain]

On 7/2/22 16:37, Mauro Carvalho Chehab wrote:
> 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 <mchehab@kernel.org>
> ---
> 

Patch looks fine to me.

Reviewed-By: Kajol Jain<kjain@linux.ibm.com>

Thanks,
Kajol Jain

> 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/cover.1656759988.git.mchehab@kernel.org/
> 
>  Documentation/ABI/testing/sysfs-bus-nvdimm | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-nvdimm b/Documentation/ABI/testing/sysfs-bus-nvdimm
> index 1c1f5acbf53d..eeabba807e4b 100644
> --- a/Documentation/ABI/testing/sysfs-bus-nvdimm
> +++ b/Documentation/ABI/testing/sysfs-bus-nvdimm
> @@ -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

Re: [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice

[Jonathan Corbet]

Thierry Reding <thierry.reding@gmail.com> writes:

> here's another one that applies on top of that earlier patch. Can you
> apply this to your tree?

Done.

Thanks,

jon

Re: [PATCH 08/12] kunit: test.h: fix a kernel-doc markup

[Shuah Khan]

On 7/2/22 7:18 AM, David Gow wrote:
> On Sat, Jul 2, 2022 at 7:07 PM Mauro Carvalho Chehab <mchehab@kernel.org> wrote:
>>
>> 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
>>
>> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
>> ---
>>
>> 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/cover.1656759988.git.mchehab@kernel.org/
>>
> 
> Reviewed-by: David Gow <davidgow@google.com>
> 
> FYI, this is identical to:
> https://lore.kernel.org/all/20220702051205.3292468-1-davidgow@google.com/
> 
> 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

Re: (subset) [PATCH 11/12] docs: arm: index.rst: add google/chromebook-boot-flow

[Bjorn Andersson]

On Sat, 2 Jul 2022 12:07:43 +0100, Mauro Carvalho Chehab wrote:
> 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,
-- 
Bjorn Andersson <bjorn.andersson@linaro.org>

Re: [PATCH 10/12] docs: alsa: alsa-driver-api.rst: remove a kernel-doc file

[Mauro Carvalho Chehab]

Em Mon, 04 Jul 2022 14:54:19 +0200
Takashi Iwai <tiwai@suse.de> escreveu:

> On Sat, 02 Jul 2022 13:07:42 +0200,
> Mauro Carvalho Chehab wrote:
> > 
> > This 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.
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>  
> 
> 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

> 
> 
> thanks,
> 
> Takashi
> 
> > ---
> > 
> > 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/cover.1656759988.git.mchehab@kernel.org/
> > 
> >  Documentation/sound/kernel-api/alsa-driver-api.rst | 1 -
> >  1 file changed, 1 deletion(-)
> > 
> > diff --git a/Documentation/sound/kernel-api/alsa-driver-api.rst b/Documentation/sound/kernel-api/alsa-driver-api.rst
> > index d24c64df7069..3cf8eb4ecaf4 100644
> > --- a/Documentation/sound/kernel-api/alsa-driver-api.rst
> > +++ b/Documentation/sound/kernel-api/alsa-driver-api.rst
> > @@ -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
> > -- 
> > 2.36.1
> >   

Re: [PATCH 10/12] docs: alsa: alsa-driver-api.rst: remove a kernel-doc file

[Mauro Carvalho Chehab]

Em Mon, 04 Jul 2022 14:54:19 +0200
Takashi Iwai <tiwai@suse.de> escreveu:

> On Sat, 02 Jul 2022 13:07:42 +0200,
> Mauro Carvalho Chehab wrote:
> > 
> > This 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.
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>  
> 
> 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

> 
> 
> thanks,
> 
> Takashi
> 
> > ---
> > 
> > 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/cover.1656759988.git.mchehab@kernel.org/
> > 
> >  Documentation/sound/kernel-api/alsa-driver-api.rst | 1 -
> >  1 file changed, 1 deletion(-)
> > 
> > diff --git a/Documentation/sound/kernel-api/alsa-driver-api.rst b/Documentation/sound/kernel-api/alsa-driver-api.rst
> > index d24c64df7069..3cf8eb4ecaf4 100644
> > --- a/Documentation/sound/kernel-api/alsa-driver-api.rst
> > +++ b/Documentation/sound/kernel-api/alsa-driver-api.rst
> > @@ -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
> > -- 
> > 2.36.1
> >   

Re: [PATCH 04/12] docs: PCI: pci-vntb-function.rst: Properly include ascii artwork

[Bjorn Helgaas]

[+cc Jon, Frank]

On Sat, Jul 02, 2022 at 12:07:36PM +0100, Mauro Carvalho Chehab wrote:
> 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 <mchehab@kernel.org>

The series that adds this doc appears to be being merged via Jon
(cc'd).

> ---
> 
> 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/cover.1656759988.git.mchehab@kernel.org/
> 
>  Documentation/PCI/endpoint/pci-vntb-function.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/PCI/endpoint/pci-vntb-function.rst b/Documentation/PCI/endpoint/pci-vntb-function.rst
> index cad8013e8839..7b2ac70e2c57 100644
> --- a/Documentation/PCI/endpoint/pci-vntb-function.rst
> +++ b/Documentation/PCI/endpoint/pci-vntb-function.rst
> @@ -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
>    |                                                  |
> -- 
> 2.36.1
> 

Re: [PATCH 05/12] docs: PCI: pci-vntb-howto.rst: fix a title markup

[Bjorn Helgaas]

[+cc Jon, Frank]

On Sat, Jul 02, 2022 at 12:07:37PM +0100, Mauro Carvalho Chehab wrote:
> As warned by Sphinx:
> 	Documentation/PCI/endpoint/pci-vntb-howto.rst:131: WARNING: Title underline too short.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>

Another for Jon.

> ---
> 
> 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/cover.1656759988.git.mchehab@kernel.org/
> 
>  Documentation/PCI/endpoint/pci-vntb-howto.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/PCI/endpoint/pci-vntb-howto.rst b/Documentation/PCI/endpoint/pci-vntb-howto.rst
> index b4a679144692..31a0bae868f9 100644
> --- a/Documentation/PCI/endpoint/pci-vntb-howto.rst
> +++ b/Documentation/PCI/endpoint/pci-vntb-howto.rst
> @@ -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::
> -- 
> 2.36.1
>