lkml.org 
[lkml]   [2024]   [Jan]   [18]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    SubjectRe: [PATCH 4/5] wifi: ath10k: Fix htt_data_tx_completion kernel-doc warning
    From


    On 1/18/24 08:12, Jeff Johnson wrote:
    > Currently kernel-doc reports:
    > drivers/net/wireless/ath/ath10k/htt.h:911: warning: Cannot understand * @brief target -> host TX completion indication message definition
    > on line 911 - I thought it was a doc line
    >
    > This is because even though struct htt_data_tx_completion uses the
    > kernel-doc marker "/**", it doesn't actual use kernel-doc syntax for
    > the documentation. Rather than try to update this legacy driver
    > documentation to use kernel-doc style, just replace the comment
    > marker.
    >
    > No functional changes, compile tested only.
    >
    > Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>

    Acked-by: Randy Dunlap <rdunlap@infradead.org>

    Thanks.

    > ---
    > drivers/net/wireless/ath/ath10k/htt.h | 2 +-
    > 1 file changed, 1 insertion(+), 1 deletion(-)
    >
    > diff --git a/drivers/net/wireless/ath/ath10k/htt.h b/drivers/net/wireless/ath/ath10k/htt.h
    > index eb0ce2f49315..603f6de62b0a 100644
    > --- a/drivers/net/wireless/ath/ath10k/htt.h
    > +++ b/drivers/net/wireless/ath/ath10k/htt.h
    > @@ -906,7 +906,7 @@ struct htt_data_tx_completion_ext {
    > __le16 msdus_rssi[];
    > } __packed;
    >
    > -/**
    > +/*
    > * @brief target -> host TX completion indication message definition
    > *
    > * @details
    >

    --
    #Randy

    \
     
     \ /
      Last update: 2024-01-18 18:21    [W:2.228 / U:0.020 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site