• Dan Williams's avatar
    cxl/pci: Clean up cxl_mem_get_partition_info() · 13e7749d
    Dan Williams authored
    Commit 0b9159d0 ("cxl/pci: Store memory capacity values") missed
    updating the kernel-doc for 'struct cxl_mem' leading to the following
    warnings:
    
    ./scripts/kernel-doc -v drivers/cxl/cxlmem.h 2>&1 | grep warn
    drivers/cxl/cxlmem.h:107: warning: Function parameter or member 'total_bytes' not described in 'cxl_mem'
    drivers/cxl/cxlmem.h:107: warning: Function parameter or member 'volatile_only_bytes' not described in 'cxl_mem'
    drivers/cxl/cxlmem.h:107: warning: Function parameter or member 'persistent_only_bytes' not described in 'cxl_mem'
    drivers/cxl/cxlmem.h:107: warning: Function parameter or member 'partition_align_bytes' not described in 'cxl_mem'
    drivers/cxl/cxlmem.h:107: warning: Function parameter or member 'active_volatile_bytes' not described in 'cxl_mem'
    drivers/cxl/cxlmem.h:107: warning: Function parameter or member 'active_persistent_bytes' not described in 'cxl_mem'
    drivers/cxl/cxlmem.h:107: warning: Function parameter or member 'next_volatile_bytes' not described in 'cxl_mem'
    drivers/cxl/cxlmem.h:107: warning: Function parameter or member 'next_persistent_bytes' not described in 'cxl_mem'
    
    Also, it is redundant to describe those same parameters in the
    kernel-doc for cxl_mem_get_partition_info(). Given the only user of that
    routine updates the values in @cxlm, just do that implicitly internal to
    the helper.
    
    Cc: Ira Weiny <ira.weiny@intel.com>
    Reported-by: default avatarBen Widawsky <ben.widawsky@intel.com>
    Reviewed-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
    Link: https://lore.kernel.org/r/163157174216.2653013.1277706528753990974.stgit@dwillia2-desk3.amr.corp.intel.comSigned-off-by: default avatarDan Williams <dan.j.williams@intel.com>
    13e7749d
pci.c 42.2 KB