From: David Miller <davem@davemloft.net>
To: elder@linaro.org
Cc: kuba@kernel.org, evgreen@chromium.org, subashab@codeaurora.org,
cpratapa@codeaurora.org, bjorn.andersson@linaro.org,
netdev@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH net-next] net: ipa: fix kerneldoc comments
Date: Mon, 13 Jul 2020 17:12:05 -0700 (PDT) [thread overview]
Message-ID: <20200713.171205.730061541247000028.davem@davemloft.net> (raw)
In-Reply-To: <20200713122418.505734-1-elder@linaro.org>
From: Alex Elder <elder@linaro.org>
Date: Mon, 13 Jul 2020 07:24:18 -0500
> This commit affects comments (and in one case, whitespace) only.
>
> Throughout the IPA code, return statements are documented using
> "@Return:", whereas they should use "Return:" instead. Fix these
> mistakes.
>
> In function definitions, some parameters are missing their comment
> to describe them. And in structure definitions, some fields are
> missing their comment to describe them. Add these missing
> descriptions.
>
> Some arguments changed name and type along the way, but their
> descriptions were not updated (an endpoint pointer is now used in
> many places that previously used an endpoint ID). Fix these
> incorrect parameter descriptions.
>
> In the description for the ipa_clock structure, one field had a
> semicolon instead of a colon in its description. Fix this.
>
> Add a missing function description for ipa_gsi_endpoint_data_empty().
>
> All of these issues were identified when building with "W=1".
>
> Signed-off-by: Alex Elder <elder@linaro.org>
Applied, thanks Alex.
prev parent reply other threads:[~2020-07-14 0:12 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-13 12:24 Alex Elder
2020-07-14 0:12 ` David Miller [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200713.171205.730061541247000028.davem@davemloft.net \
--to=davem@davemloft.net \
--cc=bjorn.andersson@linaro.org \
--cc=cpratapa@codeaurora.org \
--cc=elder@linaro.org \
--cc=evgreen@chromium.org \
--cc=kuba@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=subashab@codeaurora.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®