[PATCH 01/25] Documentation: amdgpu_device_suspend: Fix sphinx warning

[PATCH 01/25] Documentation: amdgpu_device_suspend: Fix sphinx warning

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix this warning:

warning: Excess function parameter 'suspend' description in
'amdgpu_device_suspend'

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 drivers/gpu/drm/amd/amdgpu/amdgpu_device.c | 1 -
 1 file changed, 1 deletion(-)

diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
index a027a8f7b2819..9e67abe8d0aad 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
@@ -3377,7 +3377,6 @@ void amdgpu_device_fini(struct amdgpu_device *adev)
  * amdgpu_device_suspend - initiate device suspend
  *
  * @dev: drm dev pointer
- * @suspend: suspend state
  * @fbcon : notify the fbdev of suspend
  *
  * Puts the hw in the suspend state (all asics).
-- 
2.27.0

[PATCH 02/25] Documentation: amdgpu_device_resume: Fix sphinx warning

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warning:
warning: Excess function parameter 'resume' description in
'amdgpu_device_resume'

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 drivers/gpu/drm/amd/amdgpu/amdgpu_device.c | 1 -
 1 file changed, 1 deletion(-)

diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
index 9e67abe8d0aad..dd7da7b4b696d 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
@@ -3473,7 +3473,6 @@ int amdgpu_device_suspend(struct drm_device *dev, bool fbcon)
  * amdgpu_device_resume - initiate device resume
  *
  * @dev: drm dev pointer
- * @resume: resume state
  * @fbcon : notify the fbdev of resume
  *
  * Bring the hw back to operating state (all asics).
-- 
2.27.0

[PATCH 03/25] Documentation: amdgpu_vram_mgr_del: fix sphinx warnings

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warnings:

warning: Excess function parameter 'tbo' description in
'amdgpu_vram_mgr_del'

warning: Excess function parameter 'place' description in
'amdgpu_vram_mgr_del'

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c | 2 --
 1 file changed, 2 deletions(-)

diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c
index d399e58931705..97ad8ffe6c6c0 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c
@@ -407,8 +407,6 @@ static int amdgpu_vram_mgr_new(struct ttm_mem_type_manager *man,
  * amdgpu_vram_mgr_del - free ranges
  *
  * @man: TTM memory type manager
- * @tbo: TTM BO we need this range for
- * @place: placement flags and restrictions
  * @mem: TTM memory object
  *
  * Free the allocated VRAM again.
-- 
2.27.0

[PATCH 04/25] Documentation: amdgpu_gtt_mgr_del: fix sphinx warnings

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warnings:

warning: Excess function parameter 'tbo' description in
'amdgpu_gtt_mgr_del'

warning: Excess function parameter 'place' description in
'amdgpu_gtt_mgr_del'

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c | 2 --
 1 file changed, 2 deletions(-)

diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c
index 627104401e843..bc01a06546aaf 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c
@@ -268,8 +268,6 @@ static int amdgpu_gtt_mgr_new(struct ttm_mem_type_manager *man,
  * amdgpu_gtt_mgr_del - free ranges
  *
  * @man: TTM memory type manager
- * @tbo: TTM BO we need this range for
- * @place: placement flags and restrictions
  * @mem: TTM memory object
  *
  * Free the allocated GTT again.
-- 
2.27.0

[PATCH 05/25] Documentation: serial_core.c: uart_get_rs485_mode: Fix sphinx warnings

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warnings:

warning: Excess function parameter 'dev' description in
'uart_get_rs485_mode'

warning: Excess function parameter 'rs485conf' description in
'uart_get_rs485_mode'

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 drivers/tty/serial/serial_core.c | 2 --
 1 file changed, 2 deletions(-)

diff --git a/drivers/tty/serial/serial_core.c b/drivers/tty/serial/serial_core.c
index 57840cf903881..97df0c0e30e9b 100644
--- a/drivers/tty/serial/serial_core.c
+++ b/drivers/tty/serial/serial_core.c
@@ -3289,8 +3289,6 @@ EXPORT_SYMBOL(uart_remove_one_port);
 
 /**
  * uart_get_rs485_mode() - retrieve rs485 properties for given uart
- * @dev: uart device
- * @rs485conf: output parameter
  *
  * This function implements the device tree binding described in
  * Documentation/devicetree/bindings/serial/rs485.txt.
-- 
2.27.0

[PATCH 06/25] Documentation: usbstring: usb_validate_langid: Fix sphinx warnings

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warnings:

warning: Function parameter or member 'langid' not described in
'usb_validate_langid'

warning: Excess function parameter 'lang' description in
'usb_validate_langid'

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 drivers/usb/gadget/usbstring.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/usb/gadget/usbstring.c b/drivers/usb/gadget/usbstring.c
index 58a4d33250902..2e9735abfeb95 100644
--- a/drivers/usb/gadget/usbstring.c
+++ b/drivers/usb/gadget/usbstring.c
@@ -16,7 +16,7 @@
 
 
 /**
- * usb_gadget_get_string - fill out a string descriptor 
+ * usb_gadget_get_string - fill out a string descriptor
  * @table: of c strings encoded using UTF-8
  * @id: string id, from low byte of wValue in get string descriptor
  * @buf: at least 256 bytes, must be 16-bit aligned
@@ -68,7 +68,7 @@ EXPORT_SYMBOL_GPL(usb_gadget_get_string);
 
 /**
  * usb_validate_langid - validate usb language identifiers
- * @lang: usb language identifier
+ * @langid: usb language identifier
  *
  * Returns true for valid language identifier, otherwise false.
  */
-- 
2.27.0

[PATCH 07/25] Documentation: gpio/driver.h: fix sphinx warnings

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warnings:

warning: Function parameter or member 'gc' not described in
'gpiochip_add_data'

warning: Excess function parameter 'chip' description in
'gpiochip_add_data'

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 include/linux/gpio/driver.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
index c4f272af7af59..c11261f3c7247 100644
--- a/include/linux/gpio/driver.h
+++ b/include/linux/gpio/driver.h
@@ -481,7 +481,7 @@ extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 
 /**
  * gpiochip_add_data() - register a gpio_chip
- * @chip: the chip to register, with chip->base initialized
+ * @gc: the chip to register, with chip->base initialized
  * @data: driver-private data associated with this chip
  *
  * Context: potentially before irqs will work
-- 
2.27.0

[PATCH 08/25] Documentation: events/block.h: fix sphinx warning

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warning:

warning: Excess function parameter 'error' description in
'trace_block_bio_complete'

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 include/trace/events/block.h | 2 --
 1 file changed, 2 deletions(-)

diff --git a/include/trace/events/block.h b/include/trace/events/block.h
index 1257f26bb887b..f69569b70d44d 100644
--- a/include/trace/events/block.h
+++ b/include/trace/events/block.h
@@ -254,7 +254,6 @@ TRACE_EVENT(block_bio_bounce,
  * block_bio_complete - completed all work on the block operation
  * @q: queue holding the block operation
  * @bio: block operation completed
- * @error: io error value
  *
  * This tracepoint indicates there is no further work to do on this
  * block IO operation @bio.
@@ -639,4 +638,3 @@ TRACE_EVENT(block_rq_remap,
 
 /* This part must be outside protection */
 #include <trace/define_trace.h>
-
-- 
2.27.0

[PATCH 09/25] Documentation: rcu/tree.c: rcu_nmi_enter: fix sphinx warning

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warning:

warning: Excess function parameter 'irq' description in 'rcu_nmi_enter'

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 kernel/rcu/tree.c | 1 -
 1 file changed, 1 deletion(-)

diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
index c716eadc7617f..4540659640fe9 100644
--- a/kernel/rcu/tree.c
+++ b/kernel/rcu/tree.c
@@ -944,7 +944,6 @@ void __rcu_irq_enter_check_tick(void)
 
 /**
  * rcu_nmi_enter - inform RCU of entry to NMI context
- * @irq: Is this call from rcu_irq_enter?
  *
  * If the CPU was idle from RCU's viewpoint, update rdp->dynticks and
  * rdp->dynticks_nmi_nesting to let the RCU grace-period handling know
-- 
2.27.0

[PATCH 10/25] Documentation: rculist.h: fix sphinx warning

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warning:

warning: bad line: [@right ][node2 ... ]

This was missing a '*' at the start.

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 include/linux/rculist.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/rculist.h b/include/linux/rculist.h
index df587d181844b..7eed65b5f7130 100644
--- a/include/linux/rculist.h
+++ b/include/linux/rculist.h
@@ -512,7 +512,7 @@ static inline void hlist_replace_rcu(struct hlist_node *old,
  * @right: The hlist head on the right
  *
  * The lists start out as [@left  ][node1 ... ] and
-                          [@right ][node2 ... ]
+ *                        [@right ][node2 ... ]
  * The lists end up as    [@left  ][node2 ... ]
  *                        [@right ][node1 ... ]
  */
-- 
2.27.0

[PATCH 11/25] Documentation: vmalloc.c: fix sphinx warning

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warning:

warning: Excess function parameter 'prot' description in
'vm_map_ram'

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 mm/vmalloc.c | 1 -
 1 file changed, 1 deletion(-)

diff --git a/mm/vmalloc.c b/mm/vmalloc.c
index 3091c2ca60dfd..957a0be772702 100644
--- a/mm/vmalloc.c
+++ b/mm/vmalloc.c
@@ -1862,7 +1862,6 @@ EXPORT_SYMBOL(vm_unmap_ram);
  * @pages: an array of pointers to the pages to be mapped
  * @count: number of pages
  * @node: prefer to allocate data structures on this node
- * @prot: memory protection to use. PAGE_KERNEL for regular RAM
  *
  * If you use this function for less than VMAP_MAX_ALLOC pages, it could be
  * faster than vmap so it's good.  But if you mix long-life and short-life
-- 
2.27.0

[PATCH 12/25] Documentation/admin-guide/mm/index.rst: Fix sphinx warning

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warning:

WARNING: toctree contains reference to nonexisting document
'admin-guide/mm/nommu-map'

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/admin-guide/mm/index.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst
index 774dad6d3d291..cd727cfc1b040 100644
--- a/Documentation/admin-guide/mm/index.rst
+++ b/Documentation/admin-guide/mm/index.rst
@@ -31,7 +31,7 @@ the Linux memory management.
    idle_page_tracking
    ksm
    memory-hotplug
-   nommu-map
+   nommu-mmap
    numa_memory_policy
    numaperf
    pagemap
-- 
2.27.0

[PATCH 13/25] Documentation: watch_queue.rst: fix sphinx warnings

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warnings:

watch_queue.rst:107: WARNING: Inline literal start-string
without end-string.

watch_queue.rst:107: WARNING: Inline emphasis start-string
without end-string

watch_queue.rst:184: WARNING: Inline literal start-string
without end-string.

watch_queue.rst:184: WARNING: Inline emphasis start-string
without end-string

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/watch_queue.rst | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/Documentation/watch_queue.rst b/Documentation/watch_queue.rst
index 849fad6893efa..4c3098b8fa947 100644
--- a/Documentation/watch_queue.rst
+++ b/Documentation/watch_queue.rst
@@ -103,8 +103,7 @@ watch that specific key).
 
 To manage a watch list, the following functions are provided:
 
-  * ``void init_watch_list(struct watch_list *wlist,
-			   void (*release_watch)(struct watch *wlist));``
+  * ``void init_watch_list(struct watch_list *wlist, void (*release_watch)(struct watch *wlist));``
 
     Initialise a watch list.  If ``release_watch`` is not NULL, then this
     indicates a function that should be called when the watch_list object is
@@ -179,9 +178,9 @@ The following functions are provided to manage watches:
     driver-settable fields in the watch struct must have been set before this
     is called.
 
-  * ``int remove_watch_from_object(struct watch_list *wlist,
-				   struct watch_queue *wqueue,
-				   u64 id, false);``
+  * ``int remove_watch_from_object(struct watch_list *wlist,``
+				 ``struct watch_queue *wqueue,``
+				 ``u64 id, false);``
 
     Remove a watch from a watch list, where the watch must match the specified
     watch queue (``wqueue``) and object identifier (``id``).  A notification
-- 
2.27.0

[PATCH 14/25] Documentation: kvm/api.rst: Fix sphinx warnings

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warnings:

WARNING: Definition list ends without a blank line; unexpected unindent

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/virt/kvm/api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index 29a35bddf3069..6b6698a56590d 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -4336,7 +4336,7 @@ Errors:
   #define KVM_STATE_NESTED_VMX_SMM_GUEST_MODE	0x00000001
   #define KVM_STATE_NESTED_VMX_SMM_VMXON	0x00000002
 
-#define KVM_STATE_VMX_PREEMPTION_TIMER_DEADLINE 0x00000001
+  #define KVM_STATE_VMX_PREEMPTION_TIMER_DEADLINE 0x00000001
 
   struct kvm_vmx_nested_state_hdr {
 	__u32 flags;
-- 
2.27.0

[PATCH 15/25] Documentation: staging/tee.rst: fix sphinx warnings

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

tee.rst:65: WARNING: Unexpected indentation.

tee.rst:69: WARNING: Block quote ends without a
blank line; unexpected unindent.

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/staging/tee.rst | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

diff --git a/Documentation/staging/tee.rst b/Documentation/staging/tee.rst
index 62e8ba64d04f9..4d4b5f8896032 100644
--- a/Documentation/staging/tee.rst
+++ b/Documentation/staging/tee.rst
@@ -61,13 +61,17 @@ represented as a device identified via Universally Unique Identifier (UUID) and
 client drivers register a table of supported device UUIDs.
 
 TEE bus infrastructure registers following APIs:
--  match(): iterates over the client driver UUID table to find a corresponding
-   match for device UUID. If a match is found, then this particular device is
-   probed via corresponding probe API registered by the client driver. This
-   process happens whenever a device or a client driver is registered with TEE
-   bus.
--  uevent(): notifies user-space (udev) whenever a new device is registered on
-   TEE bus for auto-loading of modularized client drivers.
+
+match():
+  iterates over the client driver UUID table to find a corresponding
+  match for device UUID. If a match is found, then this particular device is
+  probed via corresponding probe API registered by the client driver. This
+  process happens whenever a device or a client driver is registered with TEE
+  bus.
+
+uevent():
+  notifies user-space (udev) whenever a new device is registered on
+  TEE bus for auto-loading of modularized client drivers.
 
 TEE bus device enumeration is specific to underlying TEE implementation, so it
 is left open for TEE drivers to provide corresponding implementation.
-- 
2.27.0

[PATCH 16/25] Documentation/process/index.rst: Fix sphinx warning

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warning:

WARNING: toctree contains reference to nonexisting document
'process/unaligned-memory-access'

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/process/index.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst
index f07c9250c3acb..dd231ffc8422d 100644
--- a/Documentation/process/index.rst
+++ b/Documentation/process/index.rst
@@ -32,7 +32,7 @@ Below are the essential guides that every developer should read.
    kernel-enforcement-statement
    kernel-driver-statement
 
-Other guides to the community that are of interest to most developers are: 
+Other guides to the community that are of interest to most developers are:
 
 .. toctree::
    :maxdepth: 1
@@ -61,7 +61,7 @@ lack of a better place.
    botching-up-ioctls
    clang-format
    ../riscv/patch-acceptance
-   unaligned-memory-access
+   ../core-api/unaligned-memory-access
 
 .. only::  subproject and html
 
-- 
2.27.0

[PATCH 17/25] Documentation/bpf/bpf_devel_QA.rst: fix sphinx warning

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following sphinx warning:

bpf_devel_QA.rst:444: WARNING: Unknown target name:
"documentation/bpf/btf.rst"

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/bpf/bpf_devel_QA.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
index 0b3db91dc1002..a26aa1b9b2595 100644
--- a/Documentation/bpf/bpf_devel_QA.rst
+++ b/Documentation/bpf/bpf_devel_QA.rst
@@ -643,5 +643,6 @@ when:
 .. _selftests: ../../tools/testing/selftests/bpf/
 .. _Documentation/dev-tools/kselftest.rst:
    https://www.kernel.org/doc/html/latest/dev-tools/kselftest.html
+.. _Documentation/bpf/btf.rst: btf.rst
 
 Happy BPF hacking!
-- 
2.27.0

[PATCH 18/25] Documentation/bpf/ringbuf.rst: fix sphinx warnings

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warnings:

ringbuf.rst:197: WARNING: Unknown target name: "bench_ringbuf.c"

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/bpf/ringbuf.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/Documentation/bpf/ringbuf.rst b/Documentation/bpf/ringbuf.rst
index 75f943f0009df..8e7c15a927740 100644
--- a/Documentation/bpf/ringbuf.rst
+++ b/Documentation/bpf/ringbuf.rst
@@ -200,10 +200,13 @@ a self-pacing notifications of new data being availability.
 being available after commit only if consumer has already caught up right up to
 the record being committed. If not, consumer still has to catch up and thus
 will see new data anyways without needing an extra poll notification.
-Benchmarks (see tools/testing/selftests/bpf/benchs/bench_ringbuf.c_) show that
+Benchmarks (see `tools/testing/selftests/bpf/benchs/bench_ringbufs.c`_) show that
 this allows to achieve a very high throughput without having to resort to
 tricks like "notify only every Nth sample", which are necessary with perf
 buffer. For extreme cases, when BPF program wants more manual control of
 notifications, commit/discard/output helpers accept ``BPF_RB_NO_WAKEUP`` and
 ``BPF_RB_FORCE_WAKEUP`` flags, which give full control over notifications of
 data availability, but require extra caution and diligence in using this API.
+
+.. Links
+.. _tools/testing/selftests/bpf/benchs/bench_ringbufs.c: benchs/bench_ringbufs.c
\ No newline at end of file
-- 
2.27.0

[PATCH 19/25] Documentation/core-api/printk-formats.rst: fix sphinx warning

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warning:

WARNING: Definition list ends without a blank line;
unexpected unindent.

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/core-api/printk-formats.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
index 8c9aba262b1ea..01b86bd9719cf 100644
--- a/Documentation/core-api/printk-formats.rst
+++ b/Documentation/core-api/printk-formats.rst
@@ -494,9 +494,11 @@ Time and date
 	%pt[RT]t		HH:MM:SS
 	%pt[RT][dt][r]
 
-For printing date and time as represented by
+For printing date and time as represented by::
+
 	R  struct rtc_time structure
 	T  time64_t type
+
 in human readable format.
 
 By default year will be incremented by 1900 and month by 1.
-- 
2.27.0

[PATCH 20/25] Documentation/admin-guide/device-mapper/dm-ebs.rst: fix sphinx warnings

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warning:

/Documentation/admin-guide/device-mapper/dm-ebs.rst:
WARNING: document isn't included in any toctree

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/admin-guide/device-mapper/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/admin-guide/device-mapper/index.rst b/Documentation/admin-guide/device-mapper/index.rst
index ec62fcc8eecee..6cf8adc86fa80 100644
--- a/Documentation/admin-guide/device-mapper/index.rst
+++ b/Documentation/admin-guide/device-mapper/index.rst
@@ -11,6 +11,7 @@ Device Mapper
     dm-clone
     dm-crypt
     dm-dust
+    dm-ebs
     dm-flakey
     dm-init
     dm-integrity
-- 
2.27.0

[PATCH 21/25] Documentation/admin-guide/index.rst: fix sphinx warning

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warning:

Documentation/admin-guide/pstore-blk.rst:
WARNING: document isn't included in any toctree

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/admin-guide/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 58c7f9fc2396c..ed1cf94ea50c2 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -41,6 +41,7 @@ problems and bugs in particular.
    init
    kdump/index
    perf/index
+   pstore-blk
 
 This is the beginning of a section with information of interest to
 application developers.  Documents covering various aspects of the kernel
-- 
2.27.0

[PATCH 22/25] Documentation/bpf/index.rst: fix sphinx warning:

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warning

Documentation/bpf/ringbuf.rst: WARNING: document isn't
included in any toctree

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/bpf/index.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/Documentation/bpf/index.rst b/Documentation/bpf/index.rst
index 38b4db8be7a2b..0f60b95e83c40 100644
--- a/Documentation/bpf/index.rst
+++ b/Documentation/bpf/index.rst
@@ -58,6 +58,14 @@ Testing and debugging BPF
    s390
 
 
+Other
+=====
+
+.. toctree::
+   :maxdepth: 1
+
+   ringbuf
+
 .. Links:
 .. _Documentation/networking/filter.rst: ../networking/filter.txt
 .. _man-pages: https://www.kernel.org/doc/man-pages/
-- 
2.27.0

[PATCH 23/25] Documentation/firmware-guide/acpi/index.rst: fix sphinx warning

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warning:

Documentation/firmware-guide/acpi/intel-pmc-mux.rst:
WARNING: document isn't included in any toctree

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/firmware-guide/acpi/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst
index ad3b5afdae77e..f72b5f1769fb2 100644
--- a/Documentation/firmware-guide/acpi/index.rst
+++ b/Documentation/firmware-guide/acpi/index.rst
@@ -26,3 +26,4 @@ ACPI Support
    lpit
    video_extension
    extcon-intel-int3496
+   intel-pmc-mux
-- 
2.27.0

[PATCH 24/25] Documentation/trace/index.rst: fix sphinx warning

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following warning:

Documentation/trace/histogram-design.rst:
WARNING: document isn't included in any toctree

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/trace/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
index 7d83156c9ac1f..f44794c8fd840 100644
--- a/Documentation/trace/index.rst
+++ b/Documentation/trace/index.rst
@@ -19,6 +19,7 @@ Linux Tracing Technologies
    events-msr
    mmiotrace
    histogram
+   histogram-design
    boottime-trace
    hwlat_detector
    intel_th
-- 
2.27.0

[PATCH 25/25] Documentation/index.rst: Add watch_queue

[Daniel W. S. Almeida]

From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

Fix the following sphinx warning:

Documentation/watch_queue.rst:
WARNING: document isn't included in any toctree

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
---
 Documentation/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/index.rst b/Documentation/index.rst
index 3b491af0122de..57719744774c2 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -193,6 +193,7 @@ to ReStructured Text format, or are simply too old.
    :maxdepth: 2
 
    staging/index
+   watch_queue
 
 
 Translations
-- 
2.27.0

Re: [PATCH 01/25] Documentation: amdgpu_device_suspend: Fix sphinx warning

[Jonathan Corbet]

On Fri, 17 Jul 2020 15:56:00 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

> From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
> 
> Fix this warning:
> 
> warning: Excess function parameter 'suspend' description in
> 'amdgpu_device_suspend'
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> ---
>  drivers/gpu/drm/amd/amdgpu/amdgpu_device.c | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
> index a027a8f7b2819..9e67abe8d0aad 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
> @@ -3377,7 +3377,6 @@ void amdgpu_device_fini(struct amdgpu_device *adev)
>   * amdgpu_device_suspend - initiate device suspend
>   *
>   * @dev: drm dev pointer
> - * @suspend: suspend state
>   * @fbcon : notify the fbdev of suspend

Thanks for working to improve the docs build!  I do have a couple of
requests, though:

 - Use get_maintainer.pl to create a proper list of recipients for your
   patches.  Neither Mauro nor I should be applying patches to the DRM
   subsystem.

 - Please work on your subject lines; "fix warning" is rarely useful.
   What you have done here is to correct a kerneldoc comment, so the
   subject line should say "remove excess parameter in kerneldoc comment"
   or some such.  Also look at commits in the DRM subsystem and try to
   follow their conventions in general.

Those comments apply in similar form to the rest of the patches as well.

Thanks,

jon

Re: [PATCH 05/25] Documentation: serial_core.c: uart_get_rs485_mode: Fix sphinx warnings

[Randy Dunlap]

On 7/17/20 11:56 AM, Daniel W. S. Almeida wrote:
> From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
> 
> Fix the following warnings:
> 
> warning: Excess function parameter 'dev' description in
> 'uart_get_rs485_mode'
> 
> warning: Excess function parameter 'rs485conf' description in
> 'uart_get_rs485_mode'
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

I have already fixed this one and it has been merged.

> ---
>  drivers/tty/serial/serial_core.c | 2 --
>  1 file changed, 2 deletions(-)
> 
> diff --git a/drivers/tty/serial/serial_core.c b/drivers/tty/serial/serial_core.c
> index 57840cf903881..97df0c0e30e9b 100644
> --- a/drivers/tty/serial/serial_core.c
> +++ b/drivers/tty/serial/serial_core.c
> @@ -3289,8 +3289,6 @@ EXPORT_SYMBOL(uart_remove_one_port);
>  
>  /**
>   * uart_get_rs485_mode() - retrieve rs485 properties for given uart
> - * @dev: uart device
> - * @rs485conf: output parameter
>   *
>   * This function implements the device tree binding described in
>   * Documentation/devicetree/bindings/serial/rs485.txt.
> 


-- 
~Randy
Reported-by: Randy Dunlap <rdunlap@infradead.org>

Re: [PATCH 06/25] Documentation: usbstring: usb_validate_langid: Fix sphinx warnings

[Randy Dunlap]

On 7/17/20 11:56 AM, Daniel W. S. Almeida wrote:
> From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
> 
> Fix the following warnings:
> 
> warning: Function parameter or member 'langid' not described in
> 'usb_validate_langid'
> 
> warning: Excess function parameter 'lang' description in
> 'usb_validate_langid'
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Hi Daniel,

This is already fixed in Greg's tree.

thanks.

> ---
>  drivers/usb/gadget/usbstring.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/usb/gadget/usbstring.c b/drivers/usb/gadget/usbstring.c
> index 58a4d33250902..2e9735abfeb95 100644
> --- a/drivers/usb/gadget/usbstring.c
> +++ b/drivers/usb/gadget/usbstring.c
> @@ -16,7 +16,7 @@
>  
>  
>  /**
> - * usb_gadget_get_string - fill out a string descriptor 
> + * usb_gadget_get_string - fill out a string descriptor
>   * @table: of c strings encoded using UTF-8
>   * @id: string id, from low byte of wValue in get string descriptor
>   * @buf: at least 256 bytes, must be 16-bit aligned
> @@ -68,7 +68,7 @@ EXPORT_SYMBOL_GPL(usb_gadget_get_string);
>  
>  /**
>   * usb_validate_langid - validate usb language identifiers
> - * @lang: usb language identifier
> + * @langid: usb language identifier
>   *
>   * Returns true for valid language identifier, otherwise false.
>   */
> 


-- 
~Randy
Reported-by: Randy Dunlap <rdunlap@infradead.org>

Re: [PATCH 07/25] Documentation: gpio/driver.h: fix sphinx warnings

[Randy Dunlap]

On 7/17/20 11:56 AM, Daniel W. S. Almeida wrote:
> From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
> 
> Fix the following warnings:
> 
> warning: Function parameter or member 'gc' not described in
> 'gpiochip_add_data'
> 
> warning: Excess function parameter 'chip' description in
> 'gpiochip_add_data'
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Mauro has already fixed this one.

> ---
>  include/linux/gpio/driver.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
> index c4f272af7af59..c11261f3c7247 100644
> --- a/include/linux/gpio/driver.h
> +++ b/include/linux/gpio/driver.h
> @@ -481,7 +481,7 @@ extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
>  
>  /**
>   * gpiochip_add_data() - register a gpio_chip
> - * @chip: the chip to register, with chip->base initialized
> + * @gc: the chip to register, with chip->base initialized
>   * @data: driver-private data associated with this chip
>   *
>   * Context: potentially before irqs will work
> 


-- 
~Randy

Re: [PATCH 08/25] Documentation: events/block.h: fix sphinx warning

[Randy Dunlap]

On 7/17/20 11:56 AM, Daniel W. S. Almeida wrote:
> From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
> 
> Fix the following warning:
> 
> warning: Excess function parameter 'error' description in
> 'trace_block_bio_complete'
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

I have already fixed this one and it has been merged.

It seems that you should be using a more recent tree to make
patches against...

Thanks.

> ---
>  include/trace/events/block.h | 2 --
>  1 file changed, 2 deletions(-)
> 
> diff --git a/include/trace/events/block.h b/include/trace/events/block.h
> index 1257f26bb887b..f69569b70d44d 100644
> --- a/include/trace/events/block.h
> +++ b/include/trace/events/block.h
> @@ -254,7 +254,6 @@ TRACE_EVENT(block_bio_bounce,
>   * block_bio_complete - completed all work on the block operation
>   * @q: queue holding the block operation
>   * @bio: block operation completed
> - * @error: io error value
>   *
>   * This tracepoint indicates there is no further work to do on this
>   * block IO operation @bio.
> @@ -639,4 +638,3 @@ TRACE_EVENT(block_rq_remap,
>  
>  /* This part must be outside protection */
>  #include <trace/define_trace.h>
> -
> 


-- 
~Randy

Re: [PATCH 09/25] Documentation: rcu/tree.c: rcu_nmi_enter: fix sphinx warning

[Randy Dunlap]

On 7/17/20 11:56 AM, Daniel W. S. Almeida wrote:
> From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
> 
> Fix the following warning:
> 
> warning: Excess function parameter 'irq' description in 'rcu_nmi_enter'
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

At least 2 people have already fixed this one...

> ---
>  kernel/rcu/tree.c | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
> index c716eadc7617f..4540659640fe9 100644
> --- a/kernel/rcu/tree.c
> +++ b/kernel/rcu/tree.c
> @@ -944,7 +944,6 @@ void __rcu_irq_enter_check_tick(void)
>  
>  /**
>   * rcu_nmi_enter - inform RCU of entry to NMI context
> - * @irq: Is this call from rcu_irq_enter?
>   *
>   * If the CPU was idle from RCU's viewpoint, update rdp->dynticks and
>   * rdp->dynticks_nmi_nesting to let the RCU grace-period handling know
> 


-- 
~Randy

Re: [PATCH 10/25] Documentation: rculist.h: fix sphinx warning

[Randy Dunlap]

On 7/17/20 11:56 AM, Daniel W. S. Almeida wrote:
> From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
> 
> Fix the following warning:
> 
> warning: bad line: [@right ][node2 ... ]
> 
> This was missing a '*' at the start.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

Mauro and I both fixed this one.  His patch was merged.

> ---
>  include/linux/rculist.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/rculist.h b/include/linux/rculist.h
> index df587d181844b..7eed65b5f7130 100644
> --- a/include/linux/rculist.h
> +++ b/include/linux/rculist.h
> @@ -512,7 +512,7 @@ static inline void hlist_replace_rcu(struct hlist_node *old,
>   * @right: The hlist head on the right
>   *
>   * The lists start out as [@left  ][node1 ... ] and
> -                          [@right ][node2 ... ]
> + *                        [@right ][node2 ... ]
>   * The lists end up as    [@left  ][node2 ... ]
>   *                        [@right ][node1 ... ]
>   */
> 


-- 
~Randy

Re: [PATCH 13/25] Documentation: watch_queue.rst: fix sphinx warnings

[Randy Dunlap]

On 7/17/20 11:56 AM, Daniel W. S. Almeida wrote:
> From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
> 
> Fix the following warnings:
> 
> watch_queue.rst:107: WARNING: Inline literal start-string
> without end-string.
> 
> watch_queue.rst:107: WARNING: Inline emphasis start-string
> without end-string
> 
> watch_queue.rst:184: WARNING: Inline literal start-string
> without end-string.
> 
> watch_queue.rst:184: WARNING: Inline emphasis start-string
> without end-string
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> ---
>  Documentation/watch_queue.rst | 9 ++++-----
>  1 file changed, 4 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/watch_queue.rst b/Documentation/watch_queue.rst
> index 849fad6893efa..4c3098b8fa947 100644
> --- a/Documentation/watch_queue.rst
> +++ b/Documentation/watch_queue.rst
> @@ -103,8 +103,7 @@ watch that specific key).
>  
>  To manage a watch list, the following functions are provided:
>  
> -  * ``void init_watch_list(struct watch_list *wlist,
> -			   void (*release_watch)(struct watch *wlist));``
> +  * ``void init_watch_list(struct watch_list *wlist, void (*release_watch)(struct watch *wlist));``
>  
>      Initialise a watch list.  If ``release_watch`` is not NULL, then this
>      indicates a function that should be called when the watch_list object is
> @@ -179,9 +178,9 @@ The following functions are provided to manage watches:
>      driver-settable fields in the watch struct must have been set before this
>      is called.
>  
> -  * ``int remove_watch_from_object(struct watch_list *wlist,
> -				   struct watch_queue *wqueue,
> -				   u64 id, false);``
> +  * ``int remove_watch_from_object(struct watch_list *wlist,``
> +				 ``struct watch_queue *wqueue,``
> +				 ``u64 id, false);``
>  
>      Remove a watch from a watch list, where the watch must match the specified
>      watch queue (``wqueue``) and object identifier (``id``).  A notification
> 

Wow. If that's what it takes, well, OK, but it's sad IMHO.

-- 
~Randy

Re: [PATCH 07/25] Documentation: gpio/driver.h: fix sphinx warnings

[Joe Perches]

On Fri, 2020-07-17 at 12:37 -0700, Randy Dunlap wrote:
> On 7/17/20 11:56 AM, Daniel W. S. Almeida wrote:
> > From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
> > 
> > Fix the following warnings:
> > 
> > warning: Function parameter or member 'gc' not described in
> > 'gpiochip_add_data'
> > 
> > warning: Excess function parameter 'chip' description in
> > 'gpiochip_add_data'
> > 
> > Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> 
> Mauro has already fixed this one.

Not quite fixed though.

Both patches did not update the text for chip->base where
it should have been changed to gc->base

---
 include/linux/gpio/driver.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
index db82451776fc..91ae7ad8730d 100644
--- a/include/linux/gpio/driver.h
+++ b/include/linux/gpio/driver.h
@@ -497,7 +497,7 @@ extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 
 /**
  * gpiochip_add_data() - register a gpio_chip
- * @gc: the chip to register, with chip->base initialized
+ * @gc: the chip to register, with gc->base initialized
  * @data: driver-private data associated with this chip
  *
  * Context: potentially before irqs will work

Re: [PATCH 13/25] Documentation: watch_queue.rst: fix sphinx warnings

[Jonathan Corbet]

On Fri, 17 Jul 2020 12:42:52 -0700
Randy Dunlap <rdunlap@infradead.org> wrote:

> > -  * ``int remove_watch_from_object(struct watch_list *wlist,
> > -				   struct watch_queue *wqueue,
> > -				   u64 id, false);``
> > +  * ``int remove_watch_from_object(struct watch_list *wlist,``
> > +				 ``struct watch_queue *wqueue,``
> > +				 ``u64 id, false);``
> >  
> >      Remove a watch from a watch list, where the watch must match the specified
> >      watch queue (``wqueue``) and object identifier (``id``).  A notification
> >   
> 
> Wow. If that's what it takes, well, OK, but it's sad IMHO.

It seems like it might be better to remove the quoting altogether?  Either
that or just make a literal block.

jon

Re: [PATCH 08/25] Documentation: events/block.h: fix sphinx warning

[Jonathan Corbet]

On Fri, 17 Jul 2020 19:44:58 +0000
Daniel Lima de Almeida <dwlsalmeida@gmail.com> wrote:

> I was working on top of 'docs_next' if I recall correctly. Any suggestions?

Always look at linux-next to see what's going on.

Since most of those patches are not appropriate for docs-next, I don't
have them, but you should always see the current state of affairs in
linux-next.

jon

Re: [PATCH 07/25] Documentation: gpio/driver.h: fix sphinx warnings

[Randy Dunlap]

On 7/17/20 12:48 PM, Joe Perches wrote:
> On Fri, 2020-07-17 at 12:37 -0700, Randy Dunlap wrote:
>> On 7/17/20 11:56 AM, Daniel W. S. Almeida wrote:
>>> From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
>>>
>>> Fix the following warnings:
>>>
>>> warning: Function parameter or member 'gc' not described in
>>> 'gpiochip_add_data'
>>>
>>> warning: Excess function parameter 'chip' description in
>>> 'gpiochip_add_data'
>>>
>>> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
>>
>> Mauro has already fixed this one.
> 
> Not quite fixed though.
> 
> Both patches did not update the text for chip->base where
> it should have been changed to gc->base
> 
> ---
>  include/linux/gpio/driver.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
> index db82451776fc..91ae7ad8730d 100644
> --- a/include/linux/gpio/driver.h
> +++ b/include/linux/gpio/driver.h
> @@ -497,7 +497,7 @@ extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
>  
>  /**
>   * gpiochip_add_data() - register a gpio_chip
> - * @gc: the chip to register, with chip->base initialized
> + * @gc: the chip to register, with gc->base initialized
>   * @data: driver-private data associated with this chip
>   *
>   * Context: potentially before irqs will work

I had a patch for this but apparently I didn't send it since
Mauro's patch had been merged. My patch is dated June 15-2020:


From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warnings in <linux/gpio/driver.h>:

../include/linux/gpio/driver.h:512: warning: Function parameter or member 'gc' not described in 'gpiochip_add_data'
../include/linux/gpio/driver.h:512: warning: Excess function parameter 'chip' description in 'gpiochip_add_data'

Fixes: 959bc7b22bd2 ("gpio: Automatically add lockdep keys")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Thierry Reding <treding@nvidia.com>
Cc: Linus Walleij <linus.walleij@linaro.org>
---
MAURO!
 include/linux/gpio/driver.h |    8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

--- linux-next-20200615.orig/include/linux/gpio/driver.h
+++ linux-next-20200615/include/linux/gpio/driver.h
@@ -481,25 +481,25 @@ extern int gpiochip_add_data_with_key(st
 
 /**
  * gpiochip_add_data() - register a gpio_chip
- * @chip: the chip to register, with chip->base initialized
+ * @gc: the gpio chip to register, with gc->base initialized
  * @data: driver-private data associated with this chip
  *
  * Context: potentially before irqs will work
  *
  * When gpiochip_add_data() is called very early during boot, so that GPIOs
- * can be freely used, the chip->parent device must be registered before
+ * can be freely used, the gc->parent device must be registered before
  * the gpio framework's arch_initcall().  Otherwise sysfs initialization
  * for GPIOs will fail rudely.
  *
  * gpiochip_add_data() must only be called after gpiolib initialization,
  * ie after core_initcall().
  *
- * If chip->base is negative, this requests dynamic assignment of
+ * If gc->base is negative, this requests dynamic assignment of
  * a range of valid GPIOs.
  *
  * Returns:
  * A negative errno if the chip can't be registered, such as because the
- * chip->base is invalid or already associated with a different chip.
+ * gc->base is invalid or already associated with a different chip.
  * Otherwise it returns zero as a success code.
  */
 #ifdef CONFIG_LOCKDEP