[PATCH 4/4] kfifo: fix typos in kernel-doc

Jiri Slaby (SUSE) posted 15 patches 1 year, 10 months ago
There is a newer version of this series
[PATCH 4/4] kfifo: fix typos in kernel-doc
Posted by Jiri Slaby (SUSE) 1 year, 10 months ago
Obviously:
"This macro finish" -> "This macro finishes"
and similar.

Signed-off-by: Jiri Slaby (SUSE) <jirislaby@kernel.org>
Cc: Stefani Seibold <stefani@seibold.net>
Cc: Andrew Morton <akpm@linux-foundation.org>
---
 include/linux/kfifo.h | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/include/linux/kfifo.h b/include/linux/kfifo.h
index 0491bc526240..d8533e700bed 100644
--- a/include/linux/kfifo.h
+++ b/include/linux/kfifo.h
@@ -584,7 +584,7 @@ __kfifo_uint_must_check_helper( \
  * @buf: pointer to the storage buffer
  * @n: max. number of elements to get
  *
- * This macro get some data from the fifo and return the numbers of elements
+ * This macro gets some data from the fifo and returns the numbers of elements
  * copied.
  *
  * Note that with only one concurrent reader and one concurrent
@@ -611,7 +611,7 @@ __kfifo_uint_must_check_helper( \
  * @n: max. number of elements to get
  * @lock: pointer to the spinlock to use for locking
  *
- * This macro get the data from the fifo and return the numbers of elements
+ * This macro gets the data from the fifo and returns the numbers of elements
  * copied.
  */
 #define	kfifo_out_spinlocked(fifo, buf, n, lock) \
@@ -739,7 +739,7 @@ __kfifo_int_must_check_helper( \
  * @fifo: address of the fifo to be used
  * @len: number of bytes to received
  *
- * This macro finish a DMA IN operation. The in counter will be updated by
+ * This macro finishes a DMA IN operation. The in counter will be updated by
  * the len parameter. No error checking will be done.
  *
  * Note that with only one concurrent reader and one concurrent
@@ -790,7 +790,7 @@ __kfifo_int_must_check_helper( \
  * @fifo: address of the fifo to be used
  * @len: number of bytes transferred
  *
- * This macro finish a DMA OUT operation. The out counter will be updated by
+ * This macro finishes a DMA OUT operation. The out counter will be updated by
  * the len parameter. No error checking will be done.
  *
  * Note that with only one concurrent reader and one concurrent
@@ -807,7 +807,7 @@ __kfifo_int_must_check_helper( \
  * @buf: pointer to the storage buffer
  * @n: max. number of elements to get
  *
- * This macro get the data from the fifo and return the numbers of elements
+ * This macro gets the data from the fifo and returns the numbers of elements
  * copied. The data is not removed from the fifo.
  *
  * Note that with only one concurrent reader and one concurrent
-- 
2.43.2
Re: [PATCH 4/4] kfifo: fix typos in kernel-doc
Posted by Jiri Slaby 1 year, 10 months ago
Ignore this one, this is some old patch present in the output directory.

On 19. 03. 24, 10:53, Jiri Slaby (SUSE) wrote:
> Obviously:
> "This macro finish" -> "This macro finishes"
> and similar.
> 
> Signed-off-by: Jiri Slaby (SUSE) <jirislaby@kernel.org>
> Cc: Stefani Seibold <stefani@seibold.net>
> Cc: Andrew Morton <akpm@linux-foundation.org>
> ---
>   include/linux/kfifo.h | 10 +++++-----
>   1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/include/linux/kfifo.h b/include/linux/kfifo.h
> index 0491bc526240..d8533e700bed 100644
> --- a/include/linux/kfifo.h
> +++ b/include/linux/kfifo.h
> @@ -584,7 +584,7 @@ __kfifo_uint_must_check_helper( \
>    * @buf: pointer to the storage buffer
>    * @n: max. number of elements to get
>    *
> - * This macro get some data from the fifo and return the numbers of elements
> + * This macro gets some data from the fifo and returns the numbers of elements
>    * copied.
>    *
>    * Note that with only one concurrent reader and one concurrent
> @@ -611,7 +611,7 @@ __kfifo_uint_must_check_helper( \
>    * @n: max. number of elements to get
>    * @lock: pointer to the spinlock to use for locking
>    *
> - * This macro get the data from the fifo and return the numbers of elements
> + * This macro gets the data from the fifo and returns the numbers of elements
>    * copied.
>    */
>   #define	kfifo_out_spinlocked(fifo, buf, n, lock) \
> @@ -739,7 +739,7 @@ __kfifo_int_must_check_helper( \
>    * @fifo: address of the fifo to be used
>    * @len: number of bytes to received
>    *
> - * This macro finish a DMA IN operation. The in counter will be updated by
> + * This macro finishes a DMA IN operation. The in counter will be updated by
>    * the len parameter. No error checking will be done.
>    *
>    * Note that with only one concurrent reader and one concurrent
> @@ -790,7 +790,7 @@ __kfifo_int_must_check_helper( \
>    * @fifo: address of the fifo to be used
>    * @len: number of bytes transferred
>    *
> - * This macro finish a DMA OUT operation. The out counter will be updated by
> + * This macro finishes a DMA OUT operation. The out counter will be updated by
>    * the len parameter. No error checking will be done.
>    *
>    * Note that with only one concurrent reader and one concurrent
> @@ -807,7 +807,7 @@ __kfifo_int_must_check_helper( \
>    * @buf: pointer to the storage buffer
>    * @n: max. number of elements to get
>    *
> - * This macro get the data from the fifo and return the numbers of elements
> + * This macro gets the data from the fifo and returns the numbers of elements
>    * copied. The data is not removed from the fifo.
>    *
>    * Note that with only one concurrent reader and one concurrent

-- 
js
suse labs