Add some missing kerneldoc comment fields for struct dev_dax
PATCH 1/1 Add some missing kerneldoc comment fields for struct dev_dax
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 <[email protected]>
--- drivers/dax/dax-private.h | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-)
drivers/dax/dax-private.h +7 -6
@@ -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
Signature · 1 line
2.52.0
Quoted 42 lines · John Groves
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 <[email protected]>--- drivers/dax/dax-private.h | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-)drivers/dax/dax-private.h +7
-6@@ -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 */
Quoted 4 lines
base-commit:
9ace4753a5202b02191d54e9fdf7f9e3d02b85ebSignature · 1 line
2.52.0
Oops, I somehow truncated the first line. V2 coming shortly.
Nothing to see here...
John