Skip to contentSkip to conversation

Staging: comedi: Coding style warning fix for block comments

PATCH In review Punit Vara 2 participants 3 messages Sep 20, 2015 – Sep 21, 2015 Staging

lore
Share & tools
lore

Punit Vara

author
#0 lore raw

PATCH 1/1 Staging: comedi: Coding style warning fix for block comments

This patch is to comedidev.h file that fixes up following warnings reported by checkpatch.pl :

-Block comments use a trailing */ on a separate line -Block comments use * on subsequent lines

---
 drivers/staging/comedi/comedidev.h | 62 ++++++++++++++++++++------------------
 1 file changed, 32 insertions(+), 30 deletions(-)
drivers/staging/comedi/comedidev.h +32 -30
index 28a5d3a..5b0ab03 100644
@@ -1,20 +1,20 @@
 /*
-    include/linux/comedidev.h
-    header file for kernel-only structures, variables, and constants
-
-    COMEDI - Linux Control and Measurement Device Interface
-    Copyright (C) 1997-2000 David A. Schleef <[email protected]>
-
-    This program is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-*/
+ * include/linux/comedidev.h
+ * header file for kernel-only structures, variables, and constants
+ *
+ * COMEDI - Linux Control and Measurement Device Interface
+ * Copyright (C) 1997-2000 David A. Schleef <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
 
 #ifndef _COMEDIDEV_H
 #define _COMEDIDEV_H
@@ -105,7 +105,7 @@ struct comedi_buf_map {
 	struct kref refcount;
 };
 
-/**
+/*
  * struct comedi_async - control data for asynchronous comedi commands
  * @prealloc_buf:	preallocated buffer
  * @prealloc_bufsz:	buffer size (in bytes)
@@ -215,7 +215,7 @@ struct comedi_async {
 		       unsigned int x);
 };
 
-/**
+/*
  * comedi_async callback "events"
  * @COMEDI_CB_EOS:		end-of-scan
  * @COMEDI_CB_EOA:		end-of-acquisition/output
@@ -262,9 +262,11 @@ struct comedi_device {
 	struct device *class_dev;
 	int minor;
 	unsigned int detach_count;
-	/* hw_dev is passed to dma_alloc_coherent when allocating async buffers
+	/*
+	 * hw_dev is passed to dma_alloc_coherent when allocating async buffers
 	 * for subdevices that have async_dma_dir set to something other than
-	 * DMA_NONE */
+	 * DMA_NONE
+	 */
 	struct device *hw_dev;
 
 	const char *board_name;
@@ -391,7 +393,7 @@ static inline unsigned int comedi_offset_munge(struct comedi_subdevice *s,
 	return val ^ s->maxdata ^ (s->maxdata >> 1);
 }
 
-/**
+/*
  * comedi_bytes_per_sample - determine subdevice sample size
  * @s:		comedi_subdevice struct
  *
@@ -405,7 +407,7 @@ static inline unsigned int comedi_bytes_per_sample(struct comedi_subdevice *s)
 	return s->subdev_flags & SDF_LSAMPL ? sizeof(int) : sizeof(short);
 }
 
-/**
+/*
  * comedi_sample_shift - determine log2 of subdevice sample size
  * @s:		comedi_subdevice struct
  *
@@ -421,7 +423,7 @@ static inline unsigned int comedi_sample_shift(struct comedi_subdevice *s)
 	return s->subdev_flags & SDF_LSAMPL ? 2 : 1;
 }
 
-/**
+/*
  * comedi_bytes_to_samples - converts a number of bytes to a number of samples
  * @s:		comedi_subdevice struct
  * @nbytes:	number of bytes
@@ -434,7 +436,7 @@ static inline unsigned int comedi_bytes_to_samples(struct comedi_subdevice *s,
 	return nbytes >> comedi_sample_shift(s);
 }
 
-/**
+/*
  * comedi_samples_to_bytes - converts a number of samples to a number of bytes
  * @s:		comedi_subdevice struct
  * @nsamples:	number of samples
@@ -448,7 +450,7 @@ static inline unsigned int comedi_samples_to_bytes(struct comedi_subdevice *s,
 	return nsamples << comedi_sample_shift(s);
 }
 
-/**
+/*
  * comedi_check_trigger_src() - trivially validate a comedi_cmd trigger source
  * @src: pointer to the trigger source to validate
  * @flags: bitmask of valid TRIG_* for the trigger
@@ -469,7 +471,7 @@ static inline int comedi_check_trigger_src(unsigned int *src,
 	return 0;
 }
 
-/**
+/*
  * comedi_check_trigger_is_unique() - make sure a trigger source is unique
  * @src: the trigger source to check
  */
@@ -481,7 +483,7 @@ static inline int comedi_check_trigger_is_unique(unsigned int src)
 	return 0;
 }
 
-/**
+/*
  * comedi_check_trigger_arg_is() - trivially validate a trigger argument
  * @arg: pointer to the trigger arg to validate
  * @val: the value the argument should be
@@ -496,7 +498,7 @@ static inline int comedi_check_trigger_arg_is(unsigned int *arg,
 	return 0;
 }
 
-/**
+/*
  * comedi_check_trigger_arg_min() - trivially validate a trigger argument
  * @arg: pointer to the trigger arg to validate
  * @val: the minimum value the argument should be
@@ -511,7 +513,7 @@ static inline int comedi_check_trigger_arg_min(unsigned int *arg,
 	return 0;
 }
 
-/**
+/*
  * comedi_check_trigger_arg_max() - trivially validate a trigger argument
  * @arg: pointer to the trigger arg to validate
  * @val: the maximum value the argument should be
@@ -604,7 +606,7 @@ void comedi_auto_unconfig(struct device *);
 int comedi_driver_register(struct comedi_driver *);
 void comedi_driver_unregister(struct comedi_driver *);
 
-/**
+/*
  * module_comedi_driver() - Helper macro for registering a comedi driver
  * @__comedi_driver: comedi_driver struct
  *
Signature · 1 line
2.5.2
#1 lore raw
Quoted 53 lines · Punit Vara

This patch is to comedidev.h file that fixes up following warnings reported by checkpatch.pl :

(quoted diff) +0 -2
-Block comments use a trailing */ on a separate line
-Block comments use * on subsequent lines
---
  drivers/staging/comedi/comedidev.h | 62 ++++++++++++++++++++------------------
  1 file changed, 32 insertions(+), 30 deletions(-)
drivers/staging/comedi/comedidev.h +16 -16
index 28a5d3a..5b0ab03 100644
@@ -1,20 +1,20 @@
  /*
-    include/linux/comedidev.h
-    header file for kernel-only structures, variables, and constants
-
-    COMEDI - Linux Control and Measurement Device Interface
-    Copyright (C) 1997-2000 David A. Schleef <[email protected]>
-
-    This program is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-*/
+ * include/linux/comedidev.h
+ * header file for kernel-only structures, variables, and constants
+ *
+ * COMEDI - Linux Control and Measurement Device Interface
+ * Copyright (C) 1997-2000 David A. Schleef <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
 
  #ifndef _COMEDIDEV_H
  #define _COMEDIDEV_H

drivers/staging/comedi/comedidev.h struct comedi_buf_map { · line 108

Quoted 5 lines
drivers/staging/comedi/comedidev.h +1 -1
@@ -105,7 +105,7 @@ struct comedi_buf_map {
  	struct kref refcount;
  };
 
-/**
+/*

The '/**' here and on most of the other comments is deliberate. It is used to mark things up with "kernel-doc" - see "Documentation/kernel-doc-nano-HOWTO.txt".

drivers/staging/comedi/comedidev.h struct comedi_async { · line 221

Quoted 12 lines
drivers/staging/comedi/comedidev.h +1 -1
   * struct comedi_async - control data for asynchronous comedi commands
   * @prealloc_buf:	preallocated buffer
   * @prealloc_bufsz:	buffer size (in bytes)
@@ -215,7 +215,7 @@ struct comedi_async {
  		       unsigned int x);
  };
 
-/**
+/*
   * comedi_async callback "events"
   * @COMEDI_CB_EOS:		end-of-scan
   * @COMEDI_CB_EOA:		end-of-acquisition/output

Admittedly, this wasn't a valid kernel-doc comment, but I'm planning to fix that shortly.

Please don't bother fixing this patch as I'm about to send a larger series of patches to comedidev.h to add more documentation and I will fix the incorrect block comments in that series.

Signature · 2 lines
-=( Ian Abbott @ MEV Ltd.    E-mail: <[email protected]> )=-
-=(                          Web: http://www.mev.co.uk/  )=-
author
#2 lore raw
Quoted 85 lines · Ian Abbott
Quoted 56 lines · Punit Vara

This patch is to comedidev.h file that fixes up following warnings reported by checkpatch.pl :

(quoted diff) +0 -2
-Block comments use a trailing */ on a separate line
-Block comments use * on subsequent lines
---
  drivers/staging/comedi/comedidev.h | 62
++++++++++++++++++++------------------
  1 file changed, 32 insertions(+), 30 deletions(-)
drivers/staging/comedi/comedidev.h +16 -16
index 28a5d3a..5b0ab03 100644
@@ -1,20 +1,20 @@
  /*
-    include/linux/comedidev.h
-    header file for kernel-only structures, variables, and constants
-
-    COMEDI - Linux Control and Measurement Device Interface
-    Copyright (C) 1997-2000 David A. Schleef <[email protected]>
-
-    This program is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-*/
+ * include/linux/comedidev.h
+ * header file for kernel-only structures, variables, and constants
+ *
+ * COMEDI - Linux Control and Measurement Device Interface
+ * Copyright (C) 1997-2000 David A. Schleef <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
 
  #ifndef _COMEDIDEV_H
  #define _COMEDIDEV_H

drivers/staging/comedi/comedidev.h struct comedi_buf_map { · line 108

Quoted 5 lines
drivers/staging/comedi/comedidev.h +1 -1
@@ -105,7 +105,7 @@ struct comedi_buf_map {
        struct kref refcount;
  };
 
-/**
+/*

The '/**' here and on most of the other comments is deliberate. It is used to mark things up with "kernel-doc" - see "Documentation/kernel-doc-nano-HOWTO.txt".

drivers/staging/comedi/comedidev.h struct comedi_async { · line 221

Quoted 12 lines
drivers/staging/comedi/comedidev.h +1 -1
   * struct comedi_async - control data for asynchronous comedi commands
   * @prealloc_buf:     preallocated buffer
   * @prealloc_bufsz:   buffer size (in bytes)
@@ -215,7 +215,7 @@ struct comedi_async {
                       unsigned int x);
  };
 
-/**
+/*
   * comedi_async callback "events"
   * @COMEDI_CB_EOS:            end-of-scan
   * @COMEDI_CB_EOA:            end-of-acquisition/output

Admittedly, this wasn't a valid kernel-doc comment, but I'm planning to fix that shortly.

Quoted 7 lines

Please don't bother fixing this patch as I'm about to send a larger series of patches to comedidev.h to add more documentation and I will fix the incorrect block comments in that series.

--
-=( Ian Abbott @ MEV Ltd. E-mail: <[email protected]> )=-
-=( Web: http://www.mev.co.uk/ )=-

Yes sir. It was my previous patch .After Greg sir told me about that I got that mistake afterwards I didnt repeat that mistake in following patches. and yes you can fix that comments in your patches .

Have a nice day sir ;-)