linux-kernel - Re: [PATCH 08/14] fpga: region: kernel-doc fixes

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Thu, 24 May 2018 10:09:08 -0700
From:   Moritz Fischer <mdf@...nel.org>
To:     Alan Tull <atull@...nel.org>
Cc:     Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Jonathan Corbet <corbet@....net>,
        Moritz Fischer <mdf@...nel.org>, linux-kernel@...r.kernel.org,
        linux-fpga@...r.kernel.org
Subject: Re: [PATCH 08/14] fpga: region: kernel-doc fixes

On Wed, May 16, 2018 at 06:50:01PM -0500, Alan Tull wrote:
> Fix formatting and some cleanup for the kernel-doc documentation in
> fpga-region.c
> 
> Signed-off-by: Alan Tull <atull@...nel.org>
Acked-by: Moritz Fischer <mdf@...nel.org>
> ---
>  drivers/fpga/fpga-region.c | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/fpga/fpga-region.c b/drivers/fpga/fpga-region.c
> index 0878f62..112fa3a 100644
> --- a/drivers/fpga/fpga-region.c
> +++ b/drivers/fpga/fpga-region.c
> @@ -81,13 +81,16 @@ static void fpga_region_put(struct fpga_region *region)
>  
>  /**
>   * fpga_region_program_fpga - program FPGA
> + *
>   * @region: FPGA region
> + *
>   * Program an FPGA using fpga image info (region->info).
>   * If the region has a get_bridges function, the exclusive reference for the
>   * bridges will be held if programming succeeds.  This is intended to prevent
>   * reprogramming the region until the caller considers it safe to do so.
>   * The caller will need to call fpga_bridges_put() before attempting to
>   * reprogram the region.
> + *
>   * Return 0 for success or negative error code.
>   */
>  int fpga_region_program_fpga(struct fpga_region *region)
> @@ -216,7 +219,7 @@ void fpga_region_free(struct fpga_region *region)
>  }
>  EXPORT_SYMBOL_GPL(fpga_region_free);
>  
> -/*
> +/**
>   * fpga_region_register - register a FPGA region
>   * @region: FPGA region created by fpga_region_create
>   * Return: 0 or -errno
> @@ -228,7 +231,7 @@ int fpga_region_register(struct fpga_region *region)
>  }
>  EXPORT_SYMBOL_GPL(fpga_region_register);
>  
> -/*
> +/**
>   * fpga_region_unregister - unregister a FPGA region
>   * @region: FPGA region
>   */
> -- 
> 2.7.4
> 

Thanks,
Moritz