[PATCH 2.6.25-rc3-mm1] IPC: fix a kernel-doc warning

[PATCH 2.6.25-rc3-mm1] IPC: fix a kernel-doc warning

[Pierre Peiffer]

Hi,

This patch fixes this warning produced by kernel-doc (thanks Randy Dunlap):

Warning(linux-2.6.25-rc3-mm1//ipc/util.c:845):
No description found for parameter 'extrat_perm'

It is due to an inconsistency in a variable name between the C-code and
the associated comment.

Signed-off-by: Pierre Peiffer <peifferp@gmail.com>
---
 ipc/util.c |    4 ++--
 ipc/util.h |    2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

Index: b/ipc/util.c
===================================================================
--- a/ipc/util.c
+++ b/ipc/util.c
@@ -841,7 +841,7 @@
  *    or an err-code without any lock held otherwise.
  */
 struct kern_ipc_perm *ipcctl_pre_down(struct ipc_ids *ids, int id, int cmd,
-				      struct ipc64_perm *perm, int extrat_perm)
+				      struct ipc64_perm *perm, int extra_perm)
 {
 	struct kern_ipc_perm *ipcp;
 	int err;
@@ -858,7 +858,7 @@
 		goto out_unlock;

 	if (cmd == IPC_SET) {
-		err = audit_ipc_set_perm(extrat_perm, perm->uid,
+		err = audit_ipc_set_perm(extra_perm, perm->uid,
 					 perm->gid, perm->mode);
 		if (err)
 			goto out_unlock;
Index: b/ipc/util.h
===================================================================
--- a/ipc/util.h
+++ b/ipc/util.h
@@ -114,7 +114,7 @@
 void ipc64_perm_to_ipc_perm(struct ipc64_perm *in, struct ipc_perm *out);
 void ipc_update_perm(struct ipc64_perm *in, struct kern_ipc_perm *out);
 struct kern_ipc_perm *ipcctl_pre_down(struct ipc_ids *ids, int id, int cmd,
-				      struct ipc64_perm *perm, int extrat_perm);
+				      struct ipc64_perm *perm, int extra_perm);

 #if defined(__ia64__) || defined(__x86_64__) || defined(__hppa__) ||
defined(__XTENSA__)
   /* On IA-64, we always use the "64-bit version" of the IPC structures.  */

-- 
Pierre

Re: [PATCH 2.6.25-rc3-mm1] IPC: fix a kernel-doc warning

[Randy Dunlap]

Pierre Peiffer wrote:
> Hi,
> 
> This patch fixes this warning produced by kernel-doc (thanks Randy Dunlap):
> 
> Warning(linux-2.6.25-rc3-mm1//ipc/util.c:845):
> No description found for parameter 'extrat_perm'
> 
> It is due to an inconsistency in a variable name between the C-code and
> the associated comment.
> 
> Signed-off-by: Pierre Peiffer <peifferp@gmail.com>

Thanks, looks good.
Acked-by: Randy Dunlap <randy.dunlap@oracle.com>

> ---
>  ipc/util.c |    4 ++--
>  ipc/util.h |    2 +-
>  2 files changed, 3 insertions(+), 3 deletions(-)
> 
> Index: b/ipc/util.c
> ===================================================================
> --- a/ipc/util.c
> +++ b/ipc/util.c
> @@ -841,7 +841,7 @@
>   *    or an err-code without any lock held otherwise.
>   */
>  struct kern_ipc_perm *ipcctl_pre_down(struct ipc_ids *ids, int id, int cmd,
> -				      struct ipc64_perm *perm, int extrat_perm)
> +				      struct ipc64_perm *perm, int extra_perm)
>  {
>  	struct kern_ipc_perm *ipcp;
>  	int err;
> @@ -858,7 +858,7 @@
>  		goto out_unlock;
> 
>  	if (cmd == IPC_SET) {
> -		err = audit_ipc_set_perm(extrat_perm, perm->uid,
> +		err = audit_ipc_set_perm(extra_perm, perm->uid,
>  					 perm->gid, perm->mode);
>  		if (err)
>  			goto out_unlock;
> Index: b/ipc/util.h
> ===================================================================
> --- a/ipc/util.h
> +++ b/ipc/util.h
> @@ -114,7 +114,7 @@
>  void ipc64_perm_to_ipc_perm(struct ipc64_perm *in, struct ipc_perm *out);
>  void ipc_update_perm(struct ipc64_perm *in, struct kern_ipc_perm *out);
>  struct kern_ipc_perm *ipcctl_pre_down(struct ipc_ids *ids, int id, int cmd,
> -				      struct ipc64_perm *perm, int extrat_perm);
> +				      struct ipc64_perm *perm, int extra_perm);
> 
>  #if defined(__ia64__) || defined(__x86_64__) || defined(__hppa__) ||
> defined(__XTENSA__)
>    /* On IA-64, we always use the "64-bit version" of the IPC structures.  */
> 


-- 
~Randy