Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Wed, 29 Mar 2023 16:09:13 +0200
From:   Greg Kroah-Hartman <gregkh@linuxfoundation.org>
To:     Conor Dooley <conor.dooley@microchip.com>
Cc:     corbet@lwn.net, conor@kernel.org,
        Russ Weight <russell.h.weight@intel.com>,
        Tianfei zhang <tianfei.zhang@intel.com>,
        Luis Chamberlain <mcgrof@kernel.org>,
        linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] docs: driver-api: firmware_loader: fix missing argument
 in usage example
Message-ID: <ZCRGiSyMuXrk9yCI@kroah.com>
References: <20230329123425.4177084-1-conor.dooley@microchip.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20230329123425.4177084-1-conor.dooley@microchip.com>
Precedence: bulk

On Wed, Mar 29, 2023 at 01:34:26PM +0100, Conor Dooley wrote:
> By the time firmware-upload support landed in commit 97730bbb242c
> ("firmware_loader: Add firmware-upload support"), the arguments for
> firmware_upload_register() had changed, and while this is automagically
> represented in the kernel doc bits, the usage example was not kept in
> sync.
> Add the missing argument as per the driver.
> 
> Fixes: 97730bbb242c ("firmware_loader: Add firmware-upload support")
> Signed-off-by: Conor Dooley <conor.dooley@microchip.com>
> ---
> >From skimming the threads adding this stuff, looks like THIS_MODULE was
> always needed, so either I'm missing something or the doc stuff wasn't
> matching in any of the submitted versions.
> 
> CC: Jonathan Corbet <corbet@lwn.net>
> CC: Russ Weight <russell.h.weight@intel.com>
> CC: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> CC: Tianfei zhang <tianfei.zhang@intel.com>
> CC: Luis Chamberlain <mcgrof@kernel.org>
> CC: linux-doc@vger.kernel.org
> CC: linux-kernel@vger.kernel.org
> ---
>  Documentation/driver-api/firmware/fw_upload.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/driver-api/firmware/fw_upload.rst b/Documentation/driver-api/firmware/fw_upload.rst
> index 76922591e446..edf1d0c5e7c3 100644
> --- a/Documentation/driver-api/firmware/fw_upload.rst
> +++ b/Documentation/driver-api/firmware/fw_upload.rst
> @@ -57,7 +57,8 @@ function calls firmware_upload_unregister() such as::
>  		len = (truncate) ? truncate - fw_name : strlen(fw_name);
>  		sec->fw_name = kmemdup_nul(fw_name, len, GFP_KERNEL);
>  
> -		fwl = firmware_upload_register(sec->dev, sec->fw_name, &m10bmc_ops, sec);
> +		fwl = firmware_upload_register(THIS_MODULE, sec->dev, sec->fw_name,
> +					       &m10bmc_ops, sec);

Good catch.  As this touches the firmware documentation, I can take it
in my tree, thanks!

greg k-h