Documentation: amdgpu_device_suspend: Fix sphinx warning
Subsystems (17)
PATCH 1/25 Documentation: amdgpu_device_suspend: Fix sphinx warning
From: "Daniel W. S. Almeida" <[email protected]>
Fix this warning:
warning: Excess function parameter 'suspend' description in 'amdgpu_device_suspend'
--- drivers/gpu/drm/amd/amdgpu/amdgpu_device.c | 1 - 1 file changed, 1 deletion(-)
drivers/gpu/drm/amd/amdgpu/amdgpu_device.c +0 -1
@@ -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).
Signature · 1 line
2.27.0
PATCH 2/25 Documentation: amdgpu_device_resume: Fix sphinx warning
From: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
warning: Excess function parameter 'resume' description in 'amdgpu_device_resume'
--- drivers/gpu/drm/amd/amdgpu/amdgpu_device.c | 1 - 1 file changed, 1 deletion(-)
drivers/gpu/drm/amd/amdgpu/amdgpu_device.c +0 -1
@@ -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).
Signature · 1 line
2.27.0
PATCH 3/25 Documentation: amdgpu_vram_mgr_del: fix sphinx warnings
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
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'
--- drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c | 2 -- 1 file changed, 2 deletions(-)
drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c +0 -2
@@ -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.
Signature · 1 line
2.27.0
PATCH 4/25 Documentation: amdgpu_gtt_mgr_del: fix sphinx warnings
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
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'
--- drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c | 2 -- 1 file changed, 2 deletions(-)
drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c +0 -2
@@ -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.
Signature · 1 line
2.27.0
PATCH 5/25 Documentation: serial_core.c: uart_get_rs485_mode: Fix sphinx warnings
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
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'
--- drivers/tty/serial/serial_core.c | 2 -- 1 file changed, 2 deletions(-)
drivers/tty/serial/serial_core.c +0 -2
@@ -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.
Signature · 1 line
2.27.0
Randy Dunlap
reviewerRe: [PATCH 05/25] Documentation: serial_core.c: uart_get_rs485_mode: Fix sphinx warnings
Quoted 11 lines · Daniel W. S. Almeida
From: "Daniel W. S. Almeida" <[email protected]>
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 <[email protected]>
I have already fixed this one and it has been merged.
Quoted 18 lines
--- drivers/tty/serial/serial_core.c | 2 -- 1 file changed, 2 deletions(-)drivers/tty/serial/serial_core.c +0
-2@@ -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.
Signature · 2 lines
~Randy Reported-by: Randy Dunlap <[email protected]>
PATCH 6/25 Documentation: usbstring: usb_validate_langid: Fix sphinx warnings
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
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'
--- drivers/usb/gadget/usbstring.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/usb/gadget/usbstring.c +2 -2
@@ -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. */
Signature · 1 line
2.27.0
Randy Dunlap
reviewerRe: [PATCH 06/25] Documentation: usbstring: usb_validate_langid: Fix sphinx warnings
Quoted 11 lines · Daniel W. S. Almeida
From: "Daniel W. S. Almeida" <[email protected]>
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 <[email protected]>
Hi Daniel,
This is already fixed in Greg's tree.
thanks.
Quoted 27 lines
--- drivers/usb/gadget/usbstring.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)drivers/usb/gadget/usbstring.c +2
-2@@ -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. */
Signature · 2 lines
~Randy Reported-by: Randy Dunlap <[email protected]>
PATCH 7/25 Documentation: gpio/driver.h: fix sphinx warnings
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
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'
--- include/linux/gpio/driver.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/gpio/driver.h +1 -1
@@ -481,7 +481,7 @@ extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,/** * gpiochip_add_data() - register a gpio_chip -* @chip: the chip to register, with chip->base initialized +* @gc: the chip to register, with chip->base initialized * @data: driver-private data associated with this chip * * Context: potentially before irqs will work
Signature · 1 line
2.27.0
Randy Dunlap
reviewerRe: [PATCH 07/25] Documentation: gpio/driver.h: fix sphinx warnings
Quoted 11 lines · Daniel W. S. Almeida
From: "Daniel W. S. Almeida" <[email protected]>
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 <[email protected]>
Mauro has already fixed this one.
Quoted 18 lines
--- include/linux/gpio/driver.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)include/linux/gpio/driver.h +1
-1@@ -481,7 +481,7 @@ extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,/** * gpiochip_add_data() - register a gpio_chip -* @chip: the chip to register, with chip->base initialized +* @gc: the chip to register, with chip->base initialized * @data: driver-private data associated with this chip * * Context: potentially before irqs will work
Signature · 1 line
~Randy
Re: [PATCH 07/25] Documentation: gpio/driver.h: fix sphinx warnings
Quoted 8 lines · Randy Dunlap
Quoted 7 lines · Daniel W. S. Almeida
From: "Daniel W. S. Almeida" <[email protected]>
Fix the following warnings:
warning: Function parameter or member 'gc' not described in '
gpiochip_add_data'
Quoted 6 lines
Quoted 4 lines
warning: Excess function parameter 'chip' description in '
gpiochip_add_data'Signed-off-by Daniel W. S. Almeida <[email protected]>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(-)
include/linux/gpio/driver.h +1 -1
@@ -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
Randy Dunlap
reviewerRe: [PATCH 07/25] Documentation: gpio/driver.h: fix sphinx warnings
Quoted 30 lines · Joe Perches
Quoted 8 lines · Randy Dunlap
Quoted 7 lines · Daniel W. S. Almeida
From: "Daniel W. S. Almeida" <[email protected]>
Fix the following warnings:
warning: Function parameter or member 'gc' not described in '
gpiochip_add_data'Quoted 6 lines
Quoted 4 lines
warning: Excess function parameter 'chip' description in '
gpiochip_add_data'Signed-off-by Daniel W. S. Almeida <[email protected]>Mauro has already fixed this one.
Not quite fixed though.
Both patches did not update the text for
chip->basewhere it should have been changed togc->base--- include/linux/gpio/driver.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)include/linux/gpio/driver.h +0
-0
include/linux/gpio/driver.h extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data, · line 503
Quoted 8 lines
include/linux/gpio/driver.h +1
-1@@ -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 <[email protected]>
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'
---
MAURO!
include/linux/gpio/driver.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
include/linux/gpio/driver.h +4 -4
@@ -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
PATCH 8/25 Documentation: events/block.h: fix sphinx warning
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
warning: Excess function parameter 'error' description in 'trace_block_bio_complete'
--- include/trace/events/block.h | 2 -- 1 file changed, 2 deletions(-)
include/trace/events/block.h +0 -2
@@ -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> -
Signature · 1 line
2.27.0
Randy Dunlap
reviewerRe: [PATCH 08/25] Documentation: events/block.h: fix sphinx warning
Quoted 8 lines · Daniel W. S. Almeida
From: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
warning: Excess function parameter 'error' description in '
trace_block_bio_complete'Signed-off-by Daniel W. S. Almeida <[email protected]>
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.
Quoted 22 lines
--- include/trace/events/block.h | 2 -- 1 file changed, 2 deletions(-)include/trace/events/block.h +0
-2@@ -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> -
Signature · 1 line
~Randy
A message that is not in the archive (sent off-list or not yet received): RO1PR80MB35622AF97F6C440884FF4B46A07C0@RO1PR80MB3562.lamprd80.prod.outlook.com
Jonathan Corbet
maintainerRe: [PATCH 08/25] Documentation: events/block.h: fix sphinx warning
Quoted 1 line · On Fri, 17 Jul 2020 19:44:58 +0000 Daniel Lima de Almeida…
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
PATCH 9/25 Documentation: rcu/tree.c: rcu_nmi_enter: fix sphinx warning
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
warning: Excess function parameter 'irq' description in 'rcu_nmi_enter'
--- kernel/rcu/tree.c | 1 - 1 file changed, 1 deletion(-)
kernel/rcu/tree.c +0 -1
@@ -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
Signature · 1 line
2.27.0
Randy Dunlap
reviewerRe: [PATCH 09/25] Documentation: rcu/tree.c: rcu_nmi_enter: fix sphinx warning
Quoted 7 lines · Daniel W. S. Almeida
From: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
warning: Excess function parameter 'irq' description in '
rcu_nmi_enter'Signed-off-by Daniel W. S. Almeida <[email protected]>
At least 2 people have already fixed this one...
Quoted 17 lines
--- kernel/rcu/tree.c | 1 - 1 file changed, 1 deletion(-)kernel/rcu/tree.c +0
-1@@ -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
Signature · 1 line
~Randy
PATCH 10/25 Documentation: rculist.h: fix sphinx warning
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
warning: bad line: [@right ][node2 ... ]
This was missing a '*' at the start.
--- include/linux/rculist.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/rculist.h +1 -1
@@ -512,7 +512,7 @@ static inline void hlist_replace_rcu(struct hlist_node *old,* @right: The hlist head on the right * * The lists start out as [@left ][node1 ... ] and -[@right ][node2 ... ] +* [@right ][node2 ... ] * The lists end up as [@left ][node2 ... ] * [@right ][node1 ... ] */
Signature · 1 line
2.27.0
Randy Dunlap
reviewerRe: [PATCH 10/25] Documentation: rculist.h: fix sphinx warning
Quoted 9 lines · Daniel W. S. Almeida
From: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
warning: bad line: [@right ][node2 ... ]
This was missing a '*' at the start.
Signed-off-by Daniel W. S. Almeida <[email protected]>
Mauro and I both fixed this one. His patch was merged.
Quoted 18 lines
--- include/linux/rculist.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)include/linux/rculist.h +1
-1@@ -512,7 +512,7 @@ static inline void hlist_replace_rcu(struct hlist_node *old,* @right: The hlist head on the right * * The lists start out as [@left ][node1 ... ] and -[@right ][node2 ... ] +* [@right ][node2 ... ] * The lists end up as [@left ][node2 ... ] * [@right ][node1 ... ] */
Signature · 1 line
~Randy
PATCH 11/25 Documentation: vmalloc.c: fix sphinx warning
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
warning: Excess function parameter 'prot' description in 'vm_map_ram'
--- mm/vmalloc.c | 1 - 1 file changed, 1 deletion(-)
mm/vmalloc.c +0 -1
@@ -1862,7 +1862,6 @@ EXPORT_SYMBOL(vm_unmap_ram);* @pages: an array of pointers to the pages to be mapped * @count: number of pages * @node: prefer to allocate data structures on this node -* @prot: memory protection to use. PAGE_KERNEL for regular RAM * * If you use this function for less than VMAP_MAX_ALLOC pages, it could be * faster than vmap so it's good. But if you mix long-life and short-life
Signature · 1 line
2.27.0
PATCH 12/25 Documentation/admin-guide/mm/index.rst: Fix sphinx warning
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
WARNING: toctree contains reference to nonexisting document 'admin-guide/mm/nommu-map'
--- Documentation/admin-guide/mm/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/mm/index.rst +1 -1
@@ -31,7 +31,7 @@ the Linux memory management. idle_page_tracking ksm memory-hotplug - nommu-map + nommu-mmap numa_memory_policy numaperf pagemap
Signature · 1 line
2.27.0
PATCH 13/25 Documentation: watch_queue.rst: fix sphinx warnings
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
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
--- Documentation/watch_queue.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-)
Documentation/watch_queue.rst +4 -5
@@ -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
Signature · 1 line
2.27.0
Randy Dunlap
reviewerRe: [PATCH 13/25] Documentation: watch_queue.rst: fix sphinx warnings
Quoted 39 lines · Daniel W. S. Almeida
From: "Daniel W. S. Almeida" <[email protected]>
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 <[email protected]>--- Documentation/watch_queue.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-)Documentation/watch_queue.rst +1
-2@@ -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.
Documentation/watch_queue.rst The following functions are provided to manage watches: · line 186
Quoted 10 lines
Documentation/watch_queue.rst +3
-3- * ``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.
Signature · 1 line
~Randy
Jonathan Corbet
maintainerRe: [PATCH 13/25] Documentation: watch_queue.rst: fix sphinx warnings
Quoted 7 lines · On Fri, 17 Jul 2020 12:42:52 -0700 Randy Dunlap <[email protected]> wrote:
Quoted 7 lines
Documentation/watch_queue.rst +3
-3- * ``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);``
Quoted 5 lines
Quoted 3 lines
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
PATCH 14/25 Documentation: kvm/api.rst: Fix sphinx warnings
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following warnings:
WARNING: Definition list ends without a blank line; unexpected unindent
--- Documentation/virt/kvm/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/api.rst +1 -1
@@ -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;
Signature · 1 line
2.27.0
PATCH 15/25 Documentation: staging/tee.rst: fix sphinx warnings
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
tee.rst:65: WARNING: Unexpected indentation.
tee.rst:69: WARNING: Block quote ends without a
blank line; unexpected unindent.
--- Documentation/staging/tee.rst | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-)
Documentation/staging/tee.rst +11 -7
@@ -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.
Signature · 1 line
2.27.0
PATCH 16/25 Documentation/process/index.rst: Fix sphinx warning
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
WARNING: toctree contains reference to nonexisting document 'process/unaligned-memory-access'
--- Documentation/process/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/process/index.rst +2 -2
@@ -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
Signature · 1 line
2.27.0
PATCH 17/25 Documentation/bpf/bpf_devel_QA.rst: fix sphinx warning
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following sphinx warning:
bpf_devel_QA.rst:444: WARNING: Unknown target name:
"documentation/bpf/btf.rst"
--- Documentation/bpf/bpf_devel_QA.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/bpf/bpf_devel_QA.rst +1 -0
@@ -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!
Signature · 1 line
2.27.0
PATCH 18/25 Documentation/bpf/ringbuf.rst: fix sphinx warnings
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following warnings:
ringbuf.rst:197: WARNING: Unknown target name: "bench_ringbuf.c"
--- Documentation/bpf/ringbuf.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
Documentation/bpf/ringbuf.rst +4 -1
@@ -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
Signature · 1 line
2.27.0
PATCH 19/25 Documentation/core-api/printk-formats.rst: fix sphinx warning
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
WARNING: Definition list ends without a blank line; unexpected unindent.
--- Documentation/core-api/printk-formats.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
Documentation/core-api/printk-formats.rst +3 -1
@@ -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.
Signature · 1 line
2.27.0
PATCH 20/25 Documentation/admin-guide/device-mapper/dm-ebs.rst: fix sphinx warnings
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
/Documentation/admin-guide/device-mapper/dm-ebs.rst:
WARNING: document isn't included in any toctree
--- Documentation/admin-guide/device-mapper/index.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/admin-guide/device-mapper/index.rst +1 -0
@@ -11,6 +11,7 @@ Device Mapper dm-clone dm-crypt dm-dust + dm-ebs dm-flakey dm-init dm-integrity
Signature · 1 line
2.27.0
PATCH 21/25 Documentation/admin-guide/index.rst: fix sphinx warning
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
Documentation/admin-guide/pstore-blk.rst:
WARNING: document isn't included in any toctree
--- Documentation/admin-guide/index.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/admin-guide/index.rst +1 -0
@@ -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
Signature · 1 line
2.27.0
PATCH 22/25 Documentation/bpf/index.rst: fix sphinx warning:
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning
Documentation/bpf/ringbuf.rst: WARNING: document isn't included in any toctree
--- Documentation/bpf/index.rst | 8 ++++++++ 1 file changed, 8 insertions(+)
Documentation/bpf/index.rst +8 -0
@@ -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/
Signature · 1 line
2.27.0
PATCH 23/25 Documentation/firmware-guide/acpi/index.rst: fix sphinx warning
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
Documentation/firmware-guide/acpi/intel-pmc-mux.rst:
WARNING: document isn't included in any toctree
--- Documentation/firmware-guide/acpi/index.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/firmware-guide/acpi/index.rst +1 -0
@@ -26,3 +26,4 @@ ACPI Support lpit video_extension extcon-intel-int3496 + intel-pmc-mux
Signature · 1 line
2.27.0
PATCH 24/25 Documentation/trace/index.rst: fix sphinx warning
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following warning:
Documentation/trace/histogram-design.rst:
WARNING: document isn't included in any toctree
--- Documentation/trace/index.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/trace/index.rst +1 -0
@@ -19,6 +19,7 @@ Linux Tracing Technologies events-msr mmiotrace histogram + histogram-design boottime-trace hwlat_detector intel_th
Signature · 1 line
2.27.0
PATCH 25/25 Documentation/index.rst: Add watch_queue
In reply to Daniel W. S. AlmeidaFrom: "Daniel W. S. Almeida" <[email protected]>
Fix the following sphinx warning:
Documentation/watch_queue.rst:
WARNING: document isn't included in any toctree
--- Documentation/index.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/index.rst +1 -0
@@ -193,6 +193,7 @@ to ReStructured Text format, or are simply too old. :maxdepth: 2 staging/index + watch_queue Translations
Signature · 1 line
2.27.0
Jonathan Corbet
maintainerQuoted 17 lines · On Fri, 17 Jul 2020 15:56:00 -0300 "Daniel W. S. Almeida"…
From: "Daniel W. S. Almeida" <[email protected]>
Fix this warning:
warning: Excess function parameter 'suspend' description in '
amdgpu_device_suspend'Signed-off-by Daniel W. S. Almeida <[email protected]>--- drivers/gpu/drm/amd/amdgpu/amdgpu_device.c | 1 - 1 file changed, 1 deletion(-)drivers/gpu/drm/amd/amdgpu/amdgpu_device.c +0
-0
drivers/gpu/drm/amd/amdgpu/amdgpu_device.c void amdgpu_device_fini(struct amdgpu_device *adev) · line 3380
Quoted 5 lines
drivers/gpu/drm/amd/amdgpu/amdgpu_device.c +0
-1@@ -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