Re: [PATCH 20/26] dax: Document dax dev range tuple

[Jonathan Cameron]

On Sun, 24 Mar 2024 16:18:23 -0700
Ira Weiny <ira.weiny@xxxxxxxxx> wrote:

> The device DAX structure is being enhanced to track additional DCD
> information.
> 
> The current range tuple was not fully documented.  Document it prior to
> adding information for DC.
> 
> Suggested-by: Jonathan Cameron <Jonathan.Cameron@xxxxxxxxxx>
> Signed-off-by: Ira Weiny <ira.weiny@xxxxxxxxx>

There is a style convention for nested structs.
Maybe needs tweaking for a pointer like this though... 

Perhaps poke it with kernel-doc script an see what comes out.

https://docs.kernel.org/doc-guide/kernel-doc.html#nested-structs-unions
> 
> ---
> Changes for v1
> [iweiny: new patch]
> ---
>  drivers/dax/dax-private.h | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/dax/dax-private.h b/drivers/dax/dax-private.h
> index c6319c6567fb..ac1ccf158650 100644
> --- a/drivers/dax/dax-private.h
> +++ b/drivers/dax/dax-private.h
> @@ -70,7 +70,10 @@ struct dax_mapping {
>   * @dev - device core
>   * @pgmap - pgmap for memmap setup / lifetime (driver owned)
>   * @nr_range: size of @ranges
> - * @ranges: resource-span + pgoff tuples for the instance
> + * @ranges: range tuples of memory used
> + * @pgoff: page offset
> + * @range: resource-span
> + * @mapping: device to assist in interrogating the range layout
>   */
>  struct dev_dax {
>  	struct dax_region *region;
>