[PATCH v2] ipw2x00: Minor documentation update

[PATCH v2] ipw2x00: Minor documentation update

[Souptick Joarder]

Kernel test robot throws below warning ->

drivers/net/wireless/intel/ipw2x00/ipw2100.c:5359: warning: This comment
starts with '/**', but isn't a kernel-doc comment. Refer
Documentation/doc-guide/kernel-doc.rst

Minor update in documentation.

Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
---
v2:
	Updated docs.

 drivers/net/wireless/intel/ipw2x00/ipw2100.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/net/wireless/intel/ipw2x00/ipw2100.c b/drivers/net/wireless/intel/ipw2x00/ipw2100.c
index 23fbddd..eeac9e3 100644
--- a/drivers/net/wireless/intel/ipw2x00/ipw2100.c
+++ b/drivers/net/wireless/intel/ipw2x00/ipw2100.c
@@ -5356,7 +5356,7 @@ struct ipw2100_wep_key {
 #define WEP_STR_128(x) x[0],x[1],x[2],x[3],x[4],x[5],x[6],x[7],x[8],x[9],x[10]
 
 /**
- * Set a the wep key
+ * ipw2100_set_key() - Set the wep key
  *
  * @priv: struct to work on
  * @idx: index of the key we want to set
-- 
1.9.1

Re: [PATCH v2] ipw2x00: Minor documentation update

[Randy Dunlap]

On 4/25/21 3:54 AM, Souptick Joarder wrote:
> Kernel test robot throws below warning ->
> 
> drivers/net/wireless/intel/ipw2x00/ipw2100.c:5359: warning: This comment
> starts with '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
> 
> Minor update in documentation.
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com>
> Cc: Randy Dunlap <rdunlap@infradead.org>

Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
> v2:
> 	Updated docs.
> 
>  drivers/net/wireless/intel/ipw2x00/ipw2100.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/net/wireless/intel/ipw2x00/ipw2100.c b/drivers/net/wireless/intel/ipw2x00/ipw2100.c
> index 23fbddd..eeac9e3 100644
> --- a/drivers/net/wireless/intel/ipw2x00/ipw2100.c
> +++ b/drivers/net/wireless/intel/ipw2x00/ipw2100.c
> @@ -5356,7 +5356,7 @@ struct ipw2100_wep_key {
>  #define WEP_STR_128(x) x[0],x[1],x[2],x[3],x[4],x[5],x[6],x[7],x[8],x[9],x[10]
>  
>  /**
> - * Set a the wep key
> + * ipw2100_set_key() - Set the wep key
>   *
>   * @priv: struct to work on
>   * @idx: index of the key we want to set
> 


-- 
~Randy

Re: [PATCH v2] ipw2x00: Minor documentation update

[Kalle Valo]

Souptick Joarder <jrdr.linux@gmail.com> wrote:

> Kernel test robot throws below warning ->
> 
> drivers/net/wireless/intel/ipw2x00/ipw2100.c:5359: warning: This comment
> starts with '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
> 
> Minor update in documentation.
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com>
> Cc: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>

Fails to apply, please rebase.

Recorded preimage for 'drivers/net/wireless/intel/ipw2x00/ipw2100.c'
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch' to see the failed patch
Applying: ipw2x00: Minor documentation update
Using index info to reconstruct a base tree...
M	drivers/net/wireless/intel/ipw2x00/ipw2100.c
Falling back to patching base and 3-way merge...
Auto-merging drivers/net/wireless/intel/ipw2x00/ipw2100.c
CONFLICT (content): Merge conflict in drivers/net/wireless/intel/ipw2x00/ipw2100.c
Patch failed at 0001 ipw2x00: Minor documentation update

Patch set to Changes Requested.

-- 
https://patchwork.kernel.org/project/linux-wireless/patch/1619348088-6887-1-git-send-email-jrdr.linux@gmail.com/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches

Re: [PATCH v2] ipw2x00: Minor documentation update

[Souptick Joarder]

On Tue, Jun 15, 2021 at 7:05 PM Kalle Valo <kvalo@codeaurora.org> wrote:
>
> Souptick Joarder <jrdr.linux@gmail.com> wrote:
>
> > Kernel test robot throws below warning ->
> >
> > drivers/net/wireless/intel/ipw2x00/ipw2100.c:5359: warning: This comment
> > starts with '/**', but isn't a kernel-doc comment. Refer
> > Documentation/doc-guide/kernel-doc.rst
> >
> > Minor update in documentation.
> >
> > Reported-by: kernel test robot <lkp@intel.com>
> > Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com>
> > Cc: Randy Dunlap <rdunlap@infradead.org>
> > Acked-by: Randy Dunlap <rdunlap@infradead.org>
>
> Fails to apply, please rebase.

Sure.
>
> Recorded preimage for 'drivers/net/wireless/intel/ipw2x00/ipw2100.c'
> error: Failed to merge in the changes.
> hint: Use 'git am --show-current-patch' to see the failed patch
> Applying: ipw2x00: Minor documentation update
> Using index info to reconstruct a base tree...
> M       drivers/net/wireless/intel/ipw2x00/ipw2100.c
> Falling back to patching base and 3-way merge...
> Auto-merging drivers/net/wireless/intel/ipw2x00/ipw2100.c
> CONFLICT (content): Merge conflict in drivers/net/wireless/intel/ipw2x00/ipw2100.c
> Patch failed at 0001 ipw2x00: Minor documentation update
>
> Patch set to Changes Requested.
>
> --
> https://patchwork.kernel.org/project/linux-wireless/patch/1619348088-6887-1-git-send-email-jrdr.linux@gmail.com/
>
> https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
>