[PATCH] Add some missing kerneldoc comment fields for struct dev_dax

John Groves posted 1 patch 4 weeks ago
There is a newer version of this series
drivers/dax/dax-private.h | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
[PATCH] Add some missing kerneldoc comment fields for struct dev_dax
Posted by John Groves 4 weeks ago
Add the missing @align and @memmap_on_memory fields to kerneldoc comment
header for struct dev_dax.

Also, some other fields were followed by '-' and others by ':'. Fix all
to be ':' for actual kerneldoc compliance.

Fixes: 33cf94d71766 ("device-dax: make align a per-device property")
Fixes: 4eca0ef49af9 ("dax/kmem: allow kmem to add memory with memmap_on_memory")
Signed-off-by: John Groves <john@groves.net>
---
 drivers/dax/dax-private.h | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/drivers/dax/dax-private.h b/drivers/dax/dax-private.h
index 0867115aeef2..a7c4ff258737 100644
--- a/drivers/dax/dax-private.h
+++ b/drivers/dax/dax-private.h
@@ -65,16 +65,17 @@ struct dev_dax_range {
 };
 
 /**
- * struct dev_dax - instance data for a subdivision of a dax region, and
- * data while the device is activated in the driver.
- * @region - parent region
- * @dax_dev - core dax functionality
+ * struct dev_dax - instance data for a subdivision of a dax region
+ * @region: parent region
+ * @dax_dev: core dax functionality
+ * @align: alignment of this instance
  * @target_node: effective numa node if dev_dax memory range is onlined
  * @dyn_id: is this a dynamic or statically created instance
  * @id: ida allocated id when the dax_region is not static
  * @ida: mapping id allocator
- * @dev - device core
- * @pgmap - pgmap for memmap setup / lifetime (driver owned)
+ * @dev: device core
+ * @pgmap: pgmap for memmap setup / lifetime (driver owned)
+ * @memmap_on_memory: allow kmem to put the memmap in the memory
  * @nr_range: size of @ranges
  * @ranges: range tuples of memory used
  */

base-commit: 9ace4753a5202b02191d54e9fdf7f9e3d02b85eb
-- 
2.52.0
Re: [PATCH] Add some missing kerneldoc comment fields for struct dev_dax
Posted by John Groves 4 weeks ago
On 26/01/10 01:07PM, John Groves wrote:
> Add the missing @align and @memmap_on_memory fields to kerneldoc comment
> header for struct dev_dax.
> 
> Also, some other fields were followed by '-' and others by ':'. Fix all
> to be ':' for actual kerneldoc compliance.
> 
> Fixes: 33cf94d71766 ("device-dax: make align a per-device property")
> Fixes: 4eca0ef49af9 ("dax/kmem: allow kmem to add memory with memmap_on_memory")
> Signed-off-by: John Groves <john@groves.net>
> ---
>  drivers/dax/dax-private.h | 13 +++++++------
>  1 file changed, 7 insertions(+), 6 deletions(-)
> 
> diff --git a/drivers/dax/dax-private.h b/drivers/dax/dax-private.h
> index 0867115aeef2..a7c4ff258737 100644
> --- a/drivers/dax/dax-private.h
> +++ b/drivers/dax/dax-private.h
> @@ -65,16 +65,17 @@ struct dev_dax_range {
>  };
>  
>  /**
> - * struct dev_dax - instance data for a subdivision of a dax region, and
> - * data while the device is activated in the driver.
> - * @region - parent region
> - * @dax_dev - core dax functionality
> + * struct dev_dax - instance data for a subdivision of a dax region
> + * @region: parent region
> + * @dax_dev: core dax functionality
> + * @align: alignment of this instance
>   * @target_node: effective numa node if dev_dax memory range is onlined
>   * @dyn_id: is this a dynamic or statically created instance
>   * @id: ida allocated id when the dax_region is not static
>   * @ida: mapping id allocator
> - * @dev - device core
> - * @pgmap - pgmap for memmap setup / lifetime (driver owned)
> + * @dev: device core
> + * @pgmap: pgmap for memmap setup / lifetime (driver owned)
> + * @memmap_on_memory: allow kmem to put the memmap in the memory
>   * @nr_range: size of @ranges
>   * @ranges: range tuples of memory used
>   */
> 
> base-commit: 9ace4753a5202b02191d54e9fdf7f9e3d02b85eb
> -- 
> 2.52.0
> 

Oops, I somehow truncated the first line. V2 coming shortly.

Nothing to see here...

John