[PATCH] staging: octeon: Remove extra line from kernel-doc

[PATCH] staging: octeon: Remove extra line from kernel-doc

[Cristina Moraru]

Fix 'bad line' kernel-doc warning

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

diff --git a/drivers/staging/octeon/ethernet.c b/drivers/staging/octeon/ethernet.c
index 7274fda..a8da250 100644
--- a/drivers/staging/octeon/ethernet.c
+++ b/drivers/staging/octeon/ethernet.c
@@ -368,7 +368,7 @@ static void cvm_oct_common_set_multicast_list(struct net_device *dev)
  * cvm_oct_common_set_mac_address - set the hardware MAC address for a device
  * @dev:    The device in question.
  * @addr:   Address structure to change it too.
-
+ *
  * Returns Zero on success
  */
 static int cvm_oct_set_mac_filter(struct net_device *dev)
-- 
1.9.1

Re: [Outreachy kernel] [PATCH] staging: octeon: Remove extra line from kernel-doc

[Greg KH]

On Sun, Oct 04, 2015 at 09:56:18PM +0300, Cristina Moraru wrote:
> Fix 'bad line' kernel-doc warning
> 
> Signed-off-by: Cristina Moraru <cristina.moraru09@gmail.com>
> ---
>  drivers/staging/octeon/ethernet.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

You have now sent over 4 patches for the same file, but I don't know
what order to apply them in.  Can you please resend them in a patch
series, properly numbered, so that I have a chance to figure this out?

thanks,

greg k-h

[PATCH 0/3] staging: octeon: Fix kernel-doc warnings

[Cristina Moraru]

This patchset fixes multiple kernel-doc warnings

Cristina Moraru (3):
  staging: octeon: Remove extra line from kernel-doc
  staging: octeon: Remove /** from regular comments
  staging: octeon: Fix kernel-doc function description

 drivers/staging/octeon/ethernet.c | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

-- 
1.9.1

[PATCH 1/3] staging: octeon: Remove extra line from kernel-doc

[Cristina Moraru]

Fix 'bad line' kernel-doc warning

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

diff --git a/drivers/staging/octeon/ethernet.c b/drivers/staging/octeon/ethernet.c
index 7274fda..a8da250 100644
--- a/drivers/staging/octeon/ethernet.c
+++ b/drivers/staging/octeon/ethernet.c
@@ -368,7 +368,7 @@ static void cvm_oct_common_set_multicast_list(struct net_device *dev)
  * cvm_oct_common_set_mac_address - set the hardware MAC address for a device
  * @dev:    The device in question.
  * @addr:   Address structure to change it too.
-
+ *
  * Returns Zero on success
  */
 static int cvm_oct_set_mac_filter(struct net_device *dev)
-- 
1.9.1

Re: [PATCH 1/3] staging: octeon: Remove extra line from kernel-doc

[Cristina-Gabriela Moraru]

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

Appearantly I have mistaken something in the git send-email command and my
patchset has been sent into 4 separate emails. I am extremely sorry for the
spam. I will try to figure this out and resend correctly.

2015-10-09 22:17 GMT+03:00 Cristina Moraru <cristina.moraru09@gmail.com>:

> Fix 'bad line' kernel-doc warning
>
> Signed-off-by: Cristina Moraru <cristina.moraru09@gmail.com>
> ---
>  drivers/staging/octeon/ethernet.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/staging/octeon/ethernet.c
> b/drivers/staging/octeon/ethernet.c
> index 7274fda..a8da250 100644
> --- a/drivers/staging/octeon/ethernet.c
> +++ b/drivers/staging/octeon/ethernet.c
> @@ -368,7 +368,7 @@ static void cvm_oct_common_set_multicast_list(struct
> net_device *dev)
>   * cvm_oct_common_set_mac_address - set the hardware MAC address for a
> device
>   * @dev:    The device in question.
>   * @addr:   Address structure to change it too.
> -
> + *
>   * Returns Zero on success
>   */
>  static int cvm_oct_set_mac_filter(struct net_device *dev)
> --
> 1.9.1
>
>

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

[PATCH 2/3] staging: octeon: Remove /** from regular comments

[Cristina Moraru]

Fix kernel-doc warnings 'cannot understand function prototype'
by removing /** from regular comments

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 a8da250..c1b657c 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

[PATCH 3/3] staging: octeon: Fix kernel-doc function description

[Cristina Moraru]

Fix kernel-doc 'Excess function parameter' by moving
the description to the correct location. Also corrected
parameter description

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

diff --git a/drivers/staging/octeon/ethernet.c b/drivers/staging/octeon/ethernet.c
index c1b657c..d3411ef 100644
--- a/drivers/staging/octeon/ethernet.c
+++ b/drivers/staging/octeon/ethernet.c
@@ -364,13 +364,6 @@ static void cvm_oct_common_set_multicast_list(struct net_device *dev)
 	}
 }
 
-/**
- * cvm_oct_common_set_mac_address - set the hardware MAC address for a device
- * @dev:    The device in question.
- * @addr:   Address structure to change it too.
- *
- * Returns Zero on success
- */
 static int cvm_oct_set_mac_filter(struct net_device *dev)
 {
 	struct octeon_ethernet *priv = netdev_priv(dev);
@@ -413,6 +406,13 @@ static int cvm_oct_set_mac_filter(struct net_device *dev)
 	return 0;
 }
 
+/**
+ * cvm_oct_common_set_mac_address - set the hardware MAC address for a device
+ * @dev:    The device in question.
+ * @addr:   Socket address.
+ *
+ * Returns Zero on success
+ */
 static int cvm_oct_common_set_mac_address(struct net_device *dev, void *addr)
 {
 	int r = eth_mac_addr(dev, addr);
-- 
1.9.1