lkml.org 
[lkml]   [2020]   [Jul]   [1]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v2 28/30] misc: ocxl: config: Provide correct formatting to function headers
    Date
    A nice attempt was made to provide kerneldoc headers for
    read_template_version() and read_afu_lpc_memory_info() however,
    the provided formatting does not match what is expected by
    kerneldoc.

    Fixes the following W=1 warnings:

    drivers/misc/ocxl/config.c:286: warning: Function parameter or member 'dev' not described in 'read_template_version'
    drivers/misc/ocxl/config.c:286: warning: Function parameter or member 'fn' not described in 'read_template_version'
    drivers/misc/ocxl/config.c:286: warning: Function parameter or member 'len' not described in 'read_template_version'
    drivers/misc/ocxl/config.c:286: warning: Function parameter or member 'version' not described in 'read_template_version'
    drivers/misc/ocxl/config.c:489: warning: Function parameter or member 'dev' not described in 'read_afu_lpc_memory_info'
    drivers/misc/ocxl/config.c:489: warning: Function parameter or member 'fn' not described in 'read_afu_lpc_memory_info'
    drivers/misc/ocxl/config.c:489: warning: Function parameter or member 'afu' not described in 'read_afu_lpc_memory_info'

    Cc: Frederic Barrat <fbarrat@linux.ibm.com>
    Cc: Andrew Donnellan <ajd@linux.ibm.com>
    Cc: linuxppc-dev@lists.ozlabs.org
    Signed-off-by: Lee Jones <lee.jones@linaro.org>
    ---
    drivers/misc/ocxl/config.c | 18 +++++++++---------
    1 file changed, 9 insertions(+), 9 deletions(-)

    diff --git a/drivers/misc/ocxl/config.c b/drivers/misc/ocxl/config.c
    index c8e19bfb5ef90..e3b99a39d207e 100644
    --- a/drivers/misc/ocxl/config.c
    +++ b/drivers/misc/ocxl/config.c
    @@ -273,11 +273,11 @@ static int read_afu_info(struct pci_dev *dev, struct ocxl_fn_config *fn,
    }

    /**
    - * Read the template version from the AFU
    - * dev: the device for the AFU
    - * fn: the AFU offsets
    - * len: outputs the template length
    - * version: outputs the major<<8,minor version
    + * read_template_version - Read the template version from the AFU
    + * @dev: the device for the AFU
    + * @fn: the AFU offsets
    + * @len: outputs the template length
    + * @version: outputs the major<<8,minor version
    *
    * Returns 0 on success, negative on failure
    */
    @@ -476,10 +476,10 @@ static int validate_afu(struct pci_dev *dev, struct ocxl_afu_config *afu)
    }

    /**
    - * Populate AFU metadata regarding LPC memory
    - * dev: the device for the AFU
    - * fn: the AFU offsets
    - * afu: the AFU struct to populate the LPC metadata into
    + * read_afu_lpc_memory_info - Populate AFU metadata regarding LPC memory
    + * @dev: the device for the AFU
    + * @fn: the AFU offsets
    + * @afu: the AFU struct to populate the LPC metadata into
    *
    * Returns 0 on success, negative on failure
    */
    --
    2.25.1
    \
     
     \ /
      Last update: 2020-07-01 10:32    [W:4.160 / U:0.036 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site