[PATCH] staging: octeon: Switch unnecessary /** to /*

[PATCH] staging: octeon: Switch unnecessary /** to /*

[Cristina Moraru]

Fix kernel-doc comment used as regular comment.
Fix 'cannot understand function prototype' Warning

Signed-off-by: Cristina Moraru <cristina.moraru09@gmail.com>
---
 drivers/staging/octeon/ethernet.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/staging/octeon/ethernet.c b/drivers/staging/octeon/ethernet.c
index 87ab6c6..14eb4af 100644
--- a/drivers/staging/octeon/ethernet.c
+++ b/drivers/staging/octeon/ethernet.c
@@ -86,19 +86,19 @@ int rx_napi_weight = 32;
 module_param(rx_napi_weight, int, 0444);
 MODULE_PARM_DESC(rx_napi_weight, "The NAPI WEIGHT parameter.");
 
-/**
+/*
  * cvm_oct_poll_queue - Workqueue for polling operations.
  */
 struct workqueue_struct *cvm_oct_poll_queue;
 
-/**
+/*
  * cvm_oct_poll_queue_stopping - flag to indicate polling should stop.
  *
  * Set to one right before cvm_oct_poll_queue is destroyed.
  */
 atomic_t cvm_oct_poll_queue_stopping = ATOMIC_INIT(0);
 
-/**
+/*
  * Array of every ethernet device owned by this driver indexed by
  * the ipd input port number.
  */
-- 
1.9.1

Re: [Outreachy kernel] [PATCH] staging: octeon: Switch unnecessary /** to /*

[Julia Lawall]

On Fri, 2 Oct 2015, Cristina Moraru wrote:

> Fix kernel-doc comment used as regular comment.
> Fix 'cannot understand function prototype' Warning

Not sure to understand this one.  There seem to be only the changes on the 
comment starting characters, as described in the subject line.

julia

> 
> Signed-off-by: Cristina Moraru <cristina.moraru09@gmail.com>
> ---
>  drivers/staging/octeon/ethernet.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/staging/octeon/ethernet.c b/drivers/staging/octeon/ethernet.c
> index 87ab6c6..14eb4af 100644
> --- a/drivers/staging/octeon/ethernet.c
> +++ b/drivers/staging/octeon/ethernet.c
> @@ -86,19 +86,19 @@ int rx_napi_weight = 32;
>  module_param(rx_napi_weight, int, 0444);
>  MODULE_PARM_DESC(rx_napi_weight, "The NAPI WEIGHT parameter.");
>  
> -/**
> +/*
>   * cvm_oct_poll_queue - Workqueue for polling operations.
>   */
>  struct workqueue_struct *cvm_oct_poll_queue;
>  
> -/**
> +/*
>   * cvm_oct_poll_queue_stopping - flag to indicate polling should stop.
>   *
>   * Set to one right before cvm_oct_poll_queue is destroyed.
>   */
>  atomic_t cvm_oct_poll_queue_stopping = ATOMIC_INIT(0);
>  
> -/**
> +/*
>   * Array of every ethernet device owned by this driver indexed by
>   * the ipd input port number.
>   */
> -- 
> 1.9.1
> 
> -- 
> You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to outreachy-kernel+unsubscribe@googlegroups.com.
> To post to this group, send email to outreachy-kernel@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/1443811785-50375-1-git-send-email-cristina.moraru09%40gmail.com.
> For more options, visit https://groups.google.com/d/optout.
> 

Re: [Outreachy kernel] [PATCH] staging: octeon: Switch unnecessary /** to /*

[Cristina-Gabriela Moraru]

[-- Attachment #1: Type: text/plain, Size: 2742 bytes --]

Yes, I changed "/**" to "/*" where "/**" was used in regular comments and
not kernel-doc comments.

For example, the code:
> /**
> * cvm_oct_poll_queue - Workqueue for polling operations.
> */
> struct workqueue_struct *cvm_oct_poll_queue;


caused the following warning when I run the script kernel-doc:
> ethernet.c:92: warning: cannot understand function prototype: 'struct
workqueue_struct *cvm_oct_poll_queue;'

As far as I understood it, kernel-doc script failed to parse the comment
because it did not have the correct formatting for a kernel-doc comment for
a function or structure. But the comment was a regular comment describing
the use of one variable although it was using the reserved "/**".


2015-10-02 23:26 GMT+03:00 Julia Lawall <julia.lawall@lip6.fr>:

> On Fri, 2 Oct 2015, Cristina Moraru wrote:
>
> > Fix kernel-doc comment used as regular comment.
> > Fix 'cannot understand function prototype' Warning
>
> Not sure to understand this one.  There seem to be only the changes on the
> comment starting characters, as described in the subject line.
>
> julia
>
> >
> > Signed-off-by: Cristina Moraru <cristina.moraru09@gmail.com>
> > ---
> >  drivers/staging/octeon/ethernet.c | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> >
> > diff --git a/drivers/staging/octeon/ethernet.c
> b/drivers/staging/octeon/ethernet.c
> > index 87ab6c6..14eb4af 100644
> > --- a/drivers/staging/octeon/ethernet.c
> > +++ b/drivers/staging/octeon/ethernet.c
> > @@ -86,19 +86,19 @@ int rx_napi_weight = 32;
> >  module_param(rx_napi_weight, int, 0444);
> >  MODULE_PARM_DESC(rx_napi_weight, "The NAPI WEIGHT parameter.");
> >
> > -/**
> > +/*
> >   * cvm_oct_poll_queue - Workqueue for polling operations.
> >   */
> >  struct workqueue_struct *cvm_oct_poll_queue;
> >
> > -/**
> > +/*
> >   * cvm_oct_poll_queue_stopping - flag to indicate polling should stop.
> >   *
> >   * Set to one right before cvm_oct_poll_queue is destroyed.
> >   */
> >  atomic_t cvm_oct_poll_queue_stopping = ATOMIC_INIT(0);
> >
> > -/**
> > +/*
> >   * Array of every ethernet device owned by this driver indexed by
> >   * the ipd input port number.
> >   */
> > --
> > 1.9.1
> >
> > --
> > You received this message because you are subscribed to the Google
> Groups "outreachy-kernel" group.
> > To unsubscribe from this group and stop receiving emails from it, send
> an email to outreachy-kernel+unsubscribe@googlegroups.com.
> > To post to this group, send email to outreachy-kernel@googlegroups.com.
> > To view this discussion on the web visit
> https://groups.google.com/d/msgid/outreachy-kernel/1443811785-50375-1-git-send-email-cristina.moraru09%40gmail.com
> .
> > For more options, visit https://groups.google.com/d/optout.
> >
>

[-- Attachment #2: Type: text/html, Size: 4076 bytes --]

Re: [Outreachy kernel] [PATCH] staging: octeon: Switch unnecessary /** to /*

[Julia Lawall]

[-- Attachment #1: Type: TEXT/PLAIN, Size: 3549 bytes --]

On Sat, 3 Oct 2015, Cristina-Gabriela Moraru wrote:

> Yes, I changed "/**" to "/*" where "/**" was used in regular comments and
> not kernel-doc comments.
>
> For example, the code:
> > /**
> > * cvm_oct_poll_queue - Workqueue for polling operations.
> > */
> > struct workqueue_struct *cvm_oct_poll_queue;
>
>
> caused the following warning when I run the script kernel-doc:
> > ethernet.c:92: warning: cannot understand function prototype: 'struct
> workqueue_struct *cvm_oct_poll_queue;'

OK, it's not so clear, because your commit message doesn't say what tool
generated the warning.  One would normally think that a warning about the
function prototype would relate to the function code in some way.

But overall, there seems to be only one kind of fix, not two, so it would
be better to put only the message that best corresponds to what the fix
does.

Remember not to top post.

julia

> As far as I understood it, kernel-doc script failed to parse the comment
> because it did not have the correct formatting for a kernel-doc comment for
> a function or structure. But the comment was a regular comment describing
> the use of one variable although it was using the reserved "/**".
>
>
> 2015-10-02 23:26 GMT+03:00 Julia Lawall <julia.lawall@lip6.fr>:
>       On Fri, 2 Oct 2015, Cristina Moraru wrote:
>
>       > Fix kernel-doc comment used as regular comment.
>       > Fix 'cannot understand function prototype' Warning
>
>       Not sure to understand this one.  There seem to be only the
>       changes on the
>       comment starting characters, as described in the subject line.
>
>       julia
>
>       >
>       > Signed-off-by: Cristina Moraru <cristina.moraru09@gmail.com>
>       > ---
>       >  drivers/staging/octeon/ethernet.c | 6 +++---
>       >  1 file changed, 3 insertions(+), 3 deletions(-)
>       >
>       > diff --git a/drivers/staging/octeon/ethernet.c
>       b/drivers/staging/octeon/ethernet.c
>       > index 87ab6c6..14eb4af 100644
>       > --- a/drivers/staging/octeon/ethernet.c
>       > +++ b/drivers/staging/octeon/ethernet.c
>       > @@ -86,19 +86,19 @@ int rx_napi_weight = 32;
>       >  module_param(rx_napi_weight, int, 0444);
>       >  MODULE_PARM_DESC(rx_napi_weight, "The NAPI WEIGHT
>       parameter.");
>       >
>       > -/**
>       > +/*
>       >   * cvm_oct_poll_queue - Workqueue for polling operations.
>       >   */
>       >  struct workqueue_struct *cvm_oct_poll_queue;
>       >
>       > -/**
>       > +/*
>       >   * cvm_oct_poll_queue_stopping - flag to indicate polling
>       should stop.
>       >   *
>       >   * Set to one right before cvm_oct_poll_queue is destroyed.
>       >   */
>       >  atomic_t cvm_oct_poll_queue_stopping = ATOMIC_INIT(0);
>       >
>       > -/**
>       > +/*
>       >   * Array of every ethernet device owned by this driver
>       indexed by
>       >   * the ipd input port number.
>       >   */
>       > --
>       > 1.9.1
>       >
> > --
> > You received this message because you are subscribed to the Google
> Groups "outreachy-kernel" group.
> > To unsubscribe from this group and stop receiving emails from it,
> send an email to outreachy-kernel+unsubscribe@googlegroups.com.
> > To post to this group, send email to
> outreachy-kernel@googlegroups.com.
> > To view this discussion on the web visithttps://groups.google.com/d/msgid/outreachy-kernel/1443811785-50375-1-git-s
> end-email-cristina.moraru09%40gmail.com.
> > For more options, visit https://groups.google.com/d/optout.
> >
>
>
>
>