linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Paul Moore <paul@paul-moore.com>
To: Yang Li <yang.lee@linux.alibaba.com>
Cc: Stephen Smalley <stephen.smalley.work@gmail.com>,
	Eric Paris <eparis@parisplace.org>,
	nathan@kernel.org, ndesaulniers@google.com,
	selinux@vger.kernel.org, linux-kernel@vger.kernel.org,
	clang-built-linux@googlegroups.com
Subject: Re: [PATCH -next] selinux: Fix kernel-doc
Date: Thu, 10 Jun 2021 21:06:15 -0400	[thread overview]
Message-ID: <CAHC9VhQ_XkZ=ADhe5=PqV-zNuEGOHDZfsBnSErW3j+zz5b4Qrg@mail.gmail.com> (raw)
In-Reply-To: <1623317883-54209-1-git-send-email-yang.lee@linux.alibaba.com>

On Thu, Jun 10, 2021 at 5:38 AM Yang Li <yang.lee@linux.alibaba.com> wrote:
>
> Fix function name in ss/services.c kernel-doc comment
> to remove a warning found by running make W=1 LLVM=1.
>
> security/selinux/ss/services.c:2437: warning: expecting prototype for
> security_pkey_sid(). Prototype was for security_ib_pkey_sid() instead.
>
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
>  security/selinux/ss/services.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/security/selinux/ss/services.c b/security/selinux/ss/services.c
> index 3658488..bb043bf 100644
> --- a/security/selinux/ss/services.c
> +++ b/security/selinux/ss/services.c
> @@ -2423,7 +2423,7 @@ int security_port_sid(struct selinux_state *state,
>  }
>
>  /**
> - * security_pkey_sid - Obtain the SID for a pkey.
> + * security_ib_pkey_sid - Obtain the SID for a pkey.
>   * @subnet_prefix: Subnet Prefix
>   * @pkey_num: pkey number
>   * @out_sid: security identifier

This kdoc function header block is also missing the selinux_state
description.  Would you mind adding something like the following and
resubmitting your patch?

  * @state: SELinux state

... I suspect there are a number of function header comments with
similar problems in the SELinux code.

-- 
paul moore
www.paul-moore.com

      reply	other threads:[~2021-06-11  1:06 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-10  9:38 [PATCH -next] selinux: Fix kernel-doc Yang Li
2021-06-11  1:06 ` Paul Moore [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='CAHC9VhQ_XkZ=ADhe5=PqV-zNuEGOHDZfsBnSErW3j+zz5b4Qrg@mail.gmail.com' \
    --to=paul@paul-moore.com \
    --cc=clang-built-linux@googlegroups.com \
    --cc=eparis@parisplace.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=nathan@kernel.org \
    --cc=ndesaulniers@google.com \
    --cc=selinux@vger.kernel.org \
    --cc=stephen.smalley.work@gmail.com \
    --cc=yang.lee@linux.alibaba.com \
    /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;
as well as URLs for NNTP newsgroup(s).