diff mbox series

[2/3] net: core: dst_cache_set_ip6: Rename 'addr' parameter to 'saddr' for consistency

Message ID 20180304022953.4508-2-j.neuschaefer@gmx.net
State Accepted, archived
Delegated to: David Miller
Headers show
Series [1/3] net: core: dst_cache: Fix a typo in a comment | expand

Commit Message

J. Neuschäfer March 4, 2018, 2:29 a.m. UTC
The other dst_cache_{get,set}_ip{4,6} functions, and the doc comment for
dst_cache_set_ip6 use 'saddr' for their source address parameter. Rename
the parameter to increase consistency.

This fixes the following kernel-doc warnings:

./include/net/dst_cache.h:58: warning: Function parameter or member 'addr' not described in 'dst_cache_set_ip6'
./include/net/dst_cache.h:58: warning: Excess function parameter 'saddr' description in 'dst_cache_set_ip6'

Fixes: 911362c70df5 ("net: add dst_cache support")
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 include/net/dst_cache.h | 2 +-
 net/core/dst_cache.c    | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

Comments

David Miller March 5, 2018, 5:53 p.m. UTC | #1
From: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Date: Sun,  4 Mar 2018 03:29:52 +0100

> The other dst_cache_{get,set}_ip{4,6} functions, and the doc comment for
> dst_cache_set_ip6 use 'saddr' for their source address parameter. Rename
> the parameter to increase consistency.
> 
> This fixes the following kernel-doc warnings:
> 
> ./include/net/dst_cache.h:58: warning: Function parameter or member 'addr' not described in 'dst_cache_set_ip6'
> ./include/net/dst_cache.h:58: warning: Excess function parameter 'saddr' description in 'dst_cache_set_ip6'
> 
> Fixes: 911362c70df5 ("net: add dst_cache support")
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>

Applied to net-next.
diff mbox series

Patch

diff --git a/include/net/dst_cache.h b/include/net/dst_cache.h
index 844906fbf8c9..67634675e919 100644
--- a/include/net/dst_cache.h
+++ b/include/net/dst_cache.h
@@ -54,7 +54,7 @@  void dst_cache_set_ip4(struct dst_cache *dst_cache, struct dst_entry *dst,
  *	local BH must be disabled.
  */
 void dst_cache_set_ip6(struct dst_cache *dst_cache, struct dst_entry *dst,
-		       const struct in6_addr *addr);
+		       const struct in6_addr *saddr);
 
 /**
  *	dst_cache_get_ip6 - perform cache lookup and fetch ipv6 source address
diff --git a/net/core/dst_cache.c b/net/core/dst_cache.c
index 554d36449231..64cef977484a 100644
--- a/net/core/dst_cache.c
+++ b/net/core/dst_cache.c
@@ -107,7 +107,7 @@  EXPORT_SYMBOL_GPL(dst_cache_set_ip4);
 
 #if IS_ENABLED(CONFIG_IPV6)
 void dst_cache_set_ip6(struct dst_cache *dst_cache, struct dst_entry *dst,
-		       const struct in6_addr *addr)
+		       const struct in6_addr *saddr)
 {
 	struct dst_cache_pcpu *idst;
 
@@ -117,7 +117,7 @@  void dst_cache_set_ip6(struct dst_cache *dst_cache, struct dst_entry *dst,
 	idst = this_cpu_ptr(dst_cache->cache);
 	dst_cache_per_cpu_dst_set(this_cpu_ptr(dst_cache->cache), dst,
 				  rt6_get_cookie((struct rt6_info *)dst));
-	idst->in6_saddr = *addr;
+	idst->in6_saddr = *saddr;
 }
 EXPORT_SYMBOL_GPL(dst_cache_set_ip6);