iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libnvdimm/labels: Fix kernel-doc for label.h

Browse Source 
Clean up existing kernel-doc warnings before adding new CXL label data
structures.

drivers/nvdimm/label.h:66: warning: Function parameter or member 'labelsize' not described in 'nd_namespace_index'
drivers/nvdimm/label.h:66: warning: Function parameter or member 'free' not described in 'nd_namespace_index'
drivers/nvdimm/label.h:103: warning: Function parameter or member 'align' not described in 'nd_namespace_label'
drivers/nvdimm/label.h:103: warning: Function parameter or member 'reserved' not described in 'nd_namespace_label'
drivers/nvdimm/label.h:103: warning: Function parameter or member 'type_guid' not described in 'nd_namespace_label'
drivers/nvdimm/label.h:103: warning: Function parameter or member 'abstraction_guid' not described in 'nd_namespace_label'
drivers/nvdimm/label.h:103: warning: Function parameter or member 'reserved2' not described in 'nd_namespace_label'
drivers/nvdimm/label.h:103: warning: Function parameter or member 'checksum' not described in 'nd_namespace_label'

Reported-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Link: https://lore.kernel.org/r/163116431381.2460985.6990754901097922099.stgit@dwillia2-desk3.amr.corp.intel.com
Signed-off-by: Dan Williams <dan.j.williams@intel.com>
This commit is contained in:
Dan Williams 2021-09-08 22:11:53 -07:00
parent 42e192aa98
commit 999c993a85
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
drivers/nvdimm/label.h
View File

@ -34,6 +34,7 @@ enum {
* struct nd_namespace_index - label set superblock * struct nd_namespace_index - label set superblock
* @sig: NAMESPACE_INDEX\0 * @sig: NAMESPACE_INDEX\0
* @flags: placeholder * @flags: placeholder
* @labelsize: log2 size (v1 labels 128 bytes v2 labels 256 bytes)
* @seq: sequence number for this index * @seq: sequence number for this index
* @myoff: offset of this index in label area * @myoff: offset of this index in label area
* @mysize: size of this index struct * @mysize: size of this index struct
@ -43,7 +44,7 @@ enum {
* @major: label area major version * @major: label area major version
* @minor: label area minor version * @minor: label area minor version
* @checksum: fletcher64 of all fields * @checksum: fletcher64 of all fields
* @free[0]: bitmap, nlabel bits * @free: bitmap, nlabel bits
* *
* The size of free[] is rounded up so the total struct size is a * The size of free[] is rounded up so the total struct size is a
* multiple of NSINDEX_ALIGN bytes. Any bits this allocates beyond * multiple of NSINDEX_ALIGN bytes. Any bits this allocates beyond
@ -77,7 +78,12 @@ struct nd_namespace_index {
* @dpa: DPA of NVM range on this DIMM * @dpa: DPA of NVM range on this DIMM
* @rawsize: size of namespace * @rawsize: size of namespace
* @slot: slot of this label in label area * @slot: slot of this label in label area
* @unused: must be zero * @align: physical address alignment of the namespace
* @reserved: reserved
* @type_guid: copy of struct acpi_nfit_system_address.range_guid
* @abstraction_guid: personality id (btt, btt2, fsdax, devdax....)
* @reserved2: reserved
* @checksum: fletcher64 sum of this object
*/ */
struct nd_namespace_label { struct nd_namespace_label {
u8 uuid[NSLABEL_UUID_LEN]; u8 uuid[NSLABEL_UUID_LEN];