[PATCH 1/2] libnvdimm: nd.h: clean up kernel-doc warnings

[PATCH 1/2] libnvdimm: nd.h: clean up kernel-doc warnings

[Randy Dunlap]

Add missing struct member, function parameters, and function return
values to eliminate all kernel-doc warnings:

Warning: include/linux/nd.h:124 struct member 'common' not described in 'nd_namespace_io'
Warning: include/linux/nd.h:124 Excess struct member 'dev' description in 'nd_namespace_io'
Warning: include/linux/nd.h:166 function parameter 'flags' not described in 'nvdimm_read_bytes'
Warning: include/linux/nd.h:166 No description found for return value of 'nvdimm_read_bytes'
Warning: include/linux/nd.h:185 function parameter 'flags' not described in 'nvdimm_write_bytes'
Warning: include/linux/nd.h:185 No description found for return value of 'nvdimm_write_bytes'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Dan Williams <djbw@kernel.org>
Cc: Vishal Verma <vishal.l.verma@intel.com>
Cc: Dave Jiang <dave.jiang@intel.com>
Cc: Alison Schofield <alison.schofield@intel.com>
Cc: Ira Weiny <iweiny@kernel.org>
Cc: nvdimm@lists.linux.dev

 include/linux/nd.h |    8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

--- linux-next-20260720.orig/include/linux/nd.h
+++ linux-next-20260720/include/linux/nd.h
@@ -110,7 +110,7 @@ static inline struct nd_namespace_common
 
 /**
  * struct nd_namespace_io - device representation of a persistent memory range
- * @dev: namespace device created by the nd region driver
+ * @common: namespace device core infrastructure created by the nd region driver
  * @res: struct resource conversion of a NFIT SPA table
  * @size: cached resource_size(@res) for fast path size checks
  * @addr: virtual address to access the namespace range
@@ -158,8 +158,11 @@ static inline struct nd_namespace_pmem *
  * @offset: namespace-relative starting offset
  * @buf: buffer to fill
  * @size: transfer length
+ * @flags: process (0) or atomic (1) context
  *
  * @buf is up-to-date upon return from this routine.
+ *
+ * Returns: %0 on success or a negative error code on failure
  */
 static inline int nvdimm_read_bytes(struct nd_namespace_common *ndns,
 		resource_size_t offset, void *buf, size_t size,
@@ -174,11 +177,14 @@ static inline int nvdimm_read_bytes(stru
  * @offset: namespace-relative starting offset
  * @buf: buffer to drain
  * @size: transfer length
+ * @flags: process (0) or atomic (1) context
  *
  * NVDIMM Namepaces disks do not implement sectors internally.  Depending on
  * the @ndns, the contents of @buf may be in cpu cache, platform buffers,
  * or on backing memory media upon return from this routine.  Flushing
  * to media is handled internal to the @ndns driver, if at all.
+ *
+ * Returns: %0 on success or a negative error code on failure
  */
 static inline int nvdimm_write_bytes(struct nd_namespace_common *ndns,
 		resource_size_t offset, void *buf, size_t size,

[PATCH 2/2] nvdimm-btt: clean up kernel-doc warnings

[Randy Dunlap]

Add one missing kernel-doc description and drop one that shouldn't be
here in order to avoid kernel-doc warnings:

Warning: ./drivers/nvdimm/btt.h:232 struct member 'nd_region' not described in 'btt'
Warning: ./drivers/nvdimm/btt.h:232 Excess struct member 'lanes' description in 'btt'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Vishal Verma <vishal.l.verma@intel.com>
Cc: Dan Williams <djbw@kernel.org>
Cc: Dave Jiang <dave.jiang@intel.com>
Cc: Alison Schofield <alison.schofield@intel.com>
Cc: Ira Weiny <iweiny@kernel.org>
Cc: nvdimm@lists.linux.dev

 drivers/nvdimm/btt.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20260720.orig/drivers/nvdimm/btt.h
+++ linux-next-20260720/drivers/nvdimm/btt.h
@@ -210,7 +210,7 @@ struct badblocks;
  * @lbasize:		LBA size as requested and presented to upper layers.
  *			This is sector_size + size of any metadata.
  * @sector_size:	The Linux sector size - 512 or 4096
- * @lanes:		Per-lane spinlocks
+ * @nd_region:		&struct nd_region pointer
  * @init_lock:		Mutex used for the BTT initialization
  * @init_state:		Flag describing the initialization state for the BTT
  * @num_arenas:		Number of arenas in the BTT instance

Re: [PATCH 2/2] nvdimm-btt: clean up kernel-doc warnings

[Dave Jiang]

On 7/21/26 10:21 AM, Randy Dunlap wrote:
> Add one missing kernel-doc description and drop one that shouldn't be
> here in order to avoid kernel-doc warnings:
> 
> Warning: ./drivers/nvdimm/btt.h:232 struct member 'nd_region' not described in 'btt'
> Warning: ./drivers/nvdimm/btt.h:232 Excess struct member 'lanes' description in 'btt'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Reviewed-by: Dave Jiang <dave.jiang@intel.com>

> ---
> Cc: Vishal Verma <vishal.l.verma@intel.com>
> Cc: Dan Williams <djbw@kernel.org>
> Cc: Dave Jiang <dave.jiang@intel.com>
> Cc: Alison Schofield <alison.schofield@intel.com>
> Cc: Ira Weiny <iweiny@kernel.org>
> Cc: nvdimm@lists.linux.dev
> 
>  drivers/nvdimm/btt.h |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> --- linux-next-20260720.orig/drivers/nvdimm/btt.h
> +++ linux-next-20260720/drivers/nvdimm/btt.h
> @@ -210,7 +210,7 @@ struct badblocks;
>   * @lbasize:		LBA size as requested and presented to upper layers.
>   *			This is sector_size + size of any metadata.
>   * @sector_size:	The Linux sector size - 512 or 4096
> - * @lanes:		Per-lane spinlocks
> + * @nd_region:		&struct nd_region pointer
>   * @init_lock:		Mutex used for the BTT initialization
>   * @init_state:		Flag describing the initialization state for the BTT
>   * @num_arenas:		Number of arenas in the BTT instance

Re: [PATCH 2/2] nvdimm-btt: clean up kernel-doc warnings

[Alison Schofield]

On Tue, Jul 21, 2026 at 10:21:32AM -0700, Randy Dunlap wrote:
> Add one missing kernel-doc description and drop one that shouldn't be
> here in order to avoid kernel-doc warnings:
> 
> Warning: ./drivers/nvdimm/btt.h:232 struct member 'nd_region' not described in 'btt'
> Warning: ./drivers/nvdimm/btt.h:232 Excess struct member 'lanes' description in 'btt'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Thanks, applied:
https://git.kernel.org/pub/scm/linux/kernel/git/nvdimm/nvdimm.git/patch/?id=1c454cec28d6ef9f04c32b10d268e699e09573a4

Re: [PATCH 1/2] libnvdimm: nd.h: clean up kernel-doc warnings

[Dave Jiang]

On 7/21/26 10:21 AM, Randy Dunlap wrote:
> Add missing struct member, function parameters, and function return
> values to eliminate all kernel-doc warnings:
> 
> Warning: include/linux/nd.h:124 struct member 'common' not described in 'nd_namespace_io'
> Warning: include/linux/nd.h:124 Excess struct member 'dev' description in 'nd_namespace_io'
> Warning: include/linux/nd.h:166 function parameter 'flags' not described in 'nvdimm_read_bytes'
> Warning: include/linux/nd.h:166 No description found for return value of 'nvdimm_read_bytes'
> Warning: include/linux/nd.h:185 function parameter 'flags' not described in 'nvdimm_write_bytes'
> Warning: include/linux/nd.h:185 No description found for return value of 'nvdimm_write_bytes'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Reviewed-by: Dave Jiang <dave.jiang@intel.com>

> ---
> Cc: Dan Williams <djbw@kernel.org>
> Cc: Vishal Verma <vishal.l.verma@intel.com>
> Cc: Dave Jiang <dave.jiang@intel.com>
> Cc: Alison Schofield <alison.schofield@intel.com>
> Cc: Ira Weiny <iweiny@kernel.org>
> Cc: nvdimm@lists.linux.dev
> 
>  include/linux/nd.h |    8 +++++++-
>  1 file changed, 7 insertions(+), 1 deletion(-)
> 
> --- linux-next-20260720.orig/include/linux/nd.h
> +++ linux-next-20260720/include/linux/nd.h
> @@ -110,7 +110,7 @@ static inline struct nd_namespace_common
>  
>  /**
>   * struct nd_namespace_io - device representation of a persistent memory range
> - * @dev: namespace device created by the nd region driver
> + * @common: namespace device core infrastructure created by the nd region driver
>   * @res: struct resource conversion of a NFIT SPA table
>   * @size: cached resource_size(@res) for fast path size checks
>   * @addr: virtual address to access the namespace range
> @@ -158,8 +158,11 @@ static inline struct nd_namespace_pmem *
>   * @offset: namespace-relative starting offset
>   * @buf: buffer to fill
>   * @size: transfer length
> + * @flags: process (0) or atomic (1) context
>   *
>   * @buf is up-to-date upon return from this routine.
> + *
> + * Returns: %0 on success or a negative error code on failure
>   */
>  static inline int nvdimm_read_bytes(struct nd_namespace_common *ndns,
>  		resource_size_t offset, void *buf, size_t size,
> @@ -174,11 +177,14 @@ static inline int nvdimm_read_bytes(stru
>   * @offset: namespace-relative starting offset
>   * @buf: buffer to drain
>   * @size: transfer length
> + * @flags: process (0) or atomic (1) context
>   *
>   * NVDIMM Namepaces disks do not implement sectors internally.  Depending on
>   * the @ndns, the contents of @buf may be in cpu cache, platform buffers,
>   * or on backing memory media upon return from this routine.  Flushing
>   * to media is handled internal to the @ndns driver, if at all.
> + *
> + * Returns: %0 on success or a negative error code on failure
>   */
>  static inline int nvdimm_write_bytes(struct nd_namespace_common *ndns,
>  		resource_size_t offset, void *buf, size_t size,

Re: [PATCH 1/2] libnvdimm: nd.h: clean up kernel-doc warnings

[Alison Schofield]

On Tue, Jul 21, 2026 at 10:21:31AM -0700, Randy Dunlap wrote:
> Add missing struct member, function parameters, and function return
> values to eliminate all kernel-doc warnings:
> 
> Warning: include/linux/nd.h:124 struct member 'common' not described in 'nd_namespace_io'
> Warning: include/linux/nd.h:124 Excess struct member 'dev' description in 'nd_namespace_io'
> Warning: include/linux/nd.h:166 function parameter 'flags' not described in 'nvdimm_read_bytes'
> Warning: include/linux/nd.h:166 No description found for return value of 'nvdimm_read_bytes'
> Warning: include/linux/nd.h:185 function parameter 'flags' not described in 'nvdimm_write_bytes'
> Warning: include/linux/nd.h:185 No description found for return value of 'nvdimm_write_bytes'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Thanks, applied:
https://git.kernel.org/pub/scm/linux/kernel/git/nvdimm/nvdimm.git/patch/?id=1c454cec28d6ef9f04c32b10d268e699e09573a4