| Message ID | 20240705-i40e-kdoc-v1-1-529d0808a1ef@kernel.org |
|---|---|
| State | Accepted |
| Delegated to: | Anthony Nguyen |
| Headers | show |
| Series | [iwl-next] i40e: correct i40e_addr_to_hkey() name in kdoc | expand |
On 7/5/24 15:15, Simon Horman wrote: > Correct name of i40e_addr_to_hkey() in it's kdoc. > > kernel-doc -none reports: > > drivers/net/ethernet/intel/i40e/i40e.h:739: warning: expecting prototype for i40e_mac_to_hkey(). Prototype was for i40e_addr_to_hkey() instead > > Signed-off-by: Simon Horman <horms@kernel.org> thank you, Reviewed-by: Przemek Kitszel <przemyslaw.kitszel@intel.com> (unrelated digression below) > --- > drivers/net/ethernet/intel/i40e/i40e.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/drivers/net/ethernet/intel/i40e/i40e.h b/drivers/net/ethernet/intel/i40e/i40e.h > index bca2084cc54b..d546567e0286 100644 > --- a/drivers/net/ethernet/intel/i40e/i40e.h > +++ b/drivers/net/ethernet/intel/i40e/i40e.h > @@ -735,7 +735,7 @@ __i40e_pf_next_veb(struct i40e_pf *pf, int *idx) > _i++, _veb = __i40e_pf_next_veb(_pf, &_i)) > > /** > - * i40e_mac_to_hkey - Convert a 6-byte MAC Address to a u64 hash key > + * i40e_addr_to_hkey - Convert a 6-byte MAC Address to a u64 hash key > * @macaddr: the MAC Address as the base key > * > * Simply copies the address and returns it as a u64 for hashing > I really look forward to the day that sender will be able to add metadata to the patch displaying options - here changing context to 5 would make review an instant thing, as now there is no signature line: static inline u64 i40e_addr_to_hkey(const u8 *macaddr). But if Simon will send like that, this will be lost when applied to Tony's tree. I'm picking such trivial patch to bring the topic to don't derail any which will have it's own on-topic discussion, but this is for the benefit of reviewers of bigger changes of course.
diff --git a/drivers/net/ethernet/intel/i40e/i40e.h b/drivers/net/ethernet/intel/i40e/i40e.h index bca2084cc54b..d546567e0286 100644 --- a/drivers/net/ethernet/intel/i40e/i40e.h +++ b/drivers/net/ethernet/intel/i40e/i40e.h @@ -735,7 +735,7 @@ __i40e_pf_next_veb(struct i40e_pf *pf, int *idx) _i++, _veb = __i40e_pf_next_veb(_pf, &_i)) /** - * i40e_mac_to_hkey - Convert a 6-byte MAC Address to a u64 hash key + * i40e_addr_to_hkey - Convert a 6-byte MAC Address to a u64 hash key * @macaddr: the MAC Address as the base key * * Simply copies the address and returns it as a u64 for hashing
Correct name of i40e_addr_to_hkey() in it's kdoc. kernel-doc -none reports: drivers/net/ethernet/intel/i40e/i40e.h:739: warning: expecting prototype for i40e_mac_to_hkey(). Prototype was for i40e_addr_to_hkey() instead Signed-off-by: Simon Horman <horms@kernel.org> --- drivers/net/ethernet/intel/i40e/i40e.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)