| Message ID | 20210901185315.57137-1-edwin.peer@broadcom.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 5240118f08a07669537677be19edbf008682f8bd |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | [net] bnxt_en: fix kernel doc warnings in bnxt_hwrm.c | expand |
| Context | Check | Description |
|---|---|---|
| netdev/cover_letter | success | Link |
| netdev/fixes_present | success | Link |
| netdev/patch_count | success | Link |
| netdev/tree_selection | success | Clearly marked for net |
| netdev/subject_prefix | success | Link |
| netdev/cc_maintainers | success | CCed 5 of 5 maintainers |
| netdev/source_inline | success | Was 0 now: 0 |
| netdev/verify_signedoff | success | Link |
| netdev/module_param | success | Was 0 now: 0 |
| netdev/build_32bit | success | Errors and warnings before: 4 this patch: 0 |
| netdev/kdoc | success | Errors and warnings before: 4 this patch: 0 |
| netdev/verify_fixes | success | Link |
| netdev/checkpatch | success | total: 0 errors, 0 warnings, 0 checks, 26 lines checked |
| netdev/build_allmodconfig_warn | success | Errors and warnings before: 4 this patch: 0 |
| netdev/header_inline | success | Link |
On 9/1/2021 11:53 AM, Edwin Peer wrote: > Parameter names in the comments did not match the function arguments. > > Fixes: 213808170840 ("bnxt_en: add support for HWRM request slices") > Signed-off-by: Edwin Peer <edwin.peer@broadcom.com> > Reported-by: Jakub Kicinski <kuba@kernel.org> > Reviewed-by: Michael Chan <michael.chan@broadcom.com> Reviewed-by: Florian Fainelli <f.fainelli@gmail.com> # Just because you copied me internally ;)
Hello: This patch was applied to netdev/net.git (refs/heads/master): On Wed, 1 Sep 2021 11:53:15 -0700 you wrote: > Parameter names in the comments did not match the function arguments. > > Fixes: 213808170840 ("bnxt_en: add support for HWRM request slices") > Signed-off-by: Edwin Peer <edwin.peer@broadcom.com> > Reported-by: Jakub Kicinski <kuba@kernel.org> > Reviewed-by: Michael Chan <michael.chan@broadcom.com> > > [...] Here is the summary with links: - [net] bnxt_en: fix kernel doc warnings in bnxt_hwrm.c https://git.kernel.org/netdev/net/c/5240118f08a0 You are awesome, thank you! -- Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html
diff --git a/drivers/net/ethernet/broadcom/bnxt/bnxt_hwrm.c b/drivers/net/ethernet/broadcom/bnxt/bnxt_hwrm.c index acef61abe35d..bb7327b82d0b 100644 --- a/drivers/net/ethernet/broadcom/bnxt/bnxt_hwrm.c +++ b/drivers/net/ethernet/broadcom/bnxt/bnxt_hwrm.c @@ -145,11 +145,11 @@ void hwrm_req_timeout(struct bnxt *bp, void *req, unsigned int timeout) * @bp: The driver context. * @req: The request for which calls to hwrm_req_dma_slice() will have altered * allocation flags. - * @flags: A bitmask of GFP flags. These flags are passed to - * dma_alloc_coherent() whenever it is used to allocate backing memory - * for slices. Note that calls to hwrm_req_dma_slice() will not always - * result in new allocations, however, memory suballocated from the - * request buffer is already __GFP_ZERO. + * @gfp: A bitmask of GFP flags. These flags are passed to dma_alloc_coherent() + * whenever it is used to allocate backing memory for slices. Note that + * calls to hwrm_req_dma_slice() will not always result in new allocations, + * however, memory suballocated from the request buffer is already + * __GFP_ZERO. * * Sets the GFP allocation flags associated with the request for subsequent * calls to hwrm_req_dma_slice(). This can be useful for specifying __GFP_ZERO @@ -698,8 +698,8 @@ int hwrm_req_send_silent(struct bnxt *bp, void *req) * @bp: The driver context. * @req: The request for which indirect data will be associated. * @size: The size of the allocation. - * @dma: The bus address associated with the allocation. The HWRM API has no - * knowledge about the type of the request and so cannot infer how the + * @dma_handle: The bus address associated with the allocation. The HWRM API has + * no knowledge about the type of the request and so cannot infer how the * caller intends to use the indirect data. Thus, the caller is * responsible for configuring the request object appropriately to * point to the associated indirect memory. Note, DMA handle has the
Parameter names in the comments did not match the function arguments. Fixes: 213808170840 ("bnxt_en: add support for HWRM request slices") Signed-off-by: Edwin Peer <edwin.peer@broadcom.com> Reported-by: Jakub Kicinski <kuba@kernel.org> Reviewed-by: Michael Chan <michael.chan@broadcom.com> --- drivers/net/ethernet/broadcom/bnxt/bnxt_hwrm.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)