diff mbox series

[libgpiod,2/4] core: examples: fix file comments

Message ID 20230624052054.13206-3-warthog618@gmail.com
State New
Headers show
Series python examples and comment corrections | expand

Commit Message

Kent Gibson June 24, 2023, 5:20 a.m. UTC
Some of the file comments are cut-and-paste errors, so replace them
with the correct comment.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
---
 examples/async_watch_line_value.c      | 2 +-
 examples/get_multiple_line_values.c    | 2 +-
 examples/reconfigure_input_to_output.c | 5 ++++-
 examples/watch_multiple_line_values.c  | 2 +-
 4 files changed, 7 insertions(+), 4 deletions(-)

Comments

Bartosz Golaszewski June 26, 2023, 8:07 a.m. UTC | #1
On Sat, Jun 24, 2023 at 7:21 AM Kent Gibson <warthog618@gmail.com> wrote:
>
> Some of the file comments are cut-and-paste errors, so replace them
> with the correct comment.
>
> Signed-off-by: Kent Gibson <warthog618@gmail.com>
> ---
>  examples/async_watch_line_value.c      | 2 +-
>  examples/get_multiple_line_values.c    | 2 +-
>  examples/reconfigure_input_to_output.c | 5 ++++-
>  examples/watch_multiple_line_values.c  | 2 +-
>  4 files changed, 7 insertions(+), 4 deletions(-)
>
> diff --git a/examples/async_watch_line_value.c b/examples/async_watch_line_value.c
> index f35fb1a..8b1d643 100644
> --- a/examples/async_watch_line_value.c
> +++ b/examples/async_watch_line_value.c
> @@ -1,7 +1,7 @@
>  // SPDX-License-Identifier: GPL-2.0-or-later
>  // SPDX-FileCopyrightText: 2023 Kent Gibson <warthog618@gmail.com>
>
> -/* Minimal example of asynchronously watching for edges on a single line */
> +/* Minimal example of asynchronously watching for edges on a single line. */
>
>  #include <errno.h>
>  #include <gpiod.h>
> diff --git a/examples/get_multiple_line_values.c b/examples/get_multiple_line_values.c
> index b16c570..c6df3f6 100644
> --- a/examples/get_multiple_line_values.c
> +++ b/examples/get_multiple_line_values.c
> @@ -1,7 +1,7 @@
>  // SPDX-License-Identifier: GPL-2.0-or-later
>  // SPDX-FileCopyrightText: 2023 Kent Gibson <warthog618@gmail.com>
>
> -/* Minimal example of reading a single line. */
> +/* Minimal example of reading multiple lines. */
>
>  #include <errno.h>
>  #include <gpiod.h>
> diff --git a/examples/reconfigure_input_to_output.c b/examples/reconfigure_input_to_output.c
> index e8fbb1c..abfaf79 100644
> --- a/examples/reconfigure_input_to_output.c
> +++ b/examples/reconfigure_input_to_output.c
> @@ -1,7 +1,10 @@
>  // SPDX-License-Identifier: GPL-2.0-or-later
>  // SPDX-FileCopyrightText: 2023 Kent Gibson <warthog618@gmail.com>
>
> -/* Minimal example of reading a single line. */
> +/*
> + * Example of a bi-directional line requested as input and then switched
> + * to output.
> + */
>
>  #include <errno.h>
>  #include <gpiod.h>
> diff --git a/examples/watch_multiple_line_values.c b/examples/watch_multiple_line_values.c
> index 8015270..e955b2c 100644
> --- a/examples/watch_multiple_line_values.c
> +++ b/examples/watch_multiple_line_values.c
> @@ -1,7 +1,7 @@
>  // SPDX-License-Identifier: GPL-2.0-or-later
>  // SPDX-FileCopyrightText: 2023 Kent Gibson <warthog618@gmail.com>
>
> -/* Minimal example of watching for edges on a single line. */
> +/* Minimal example of watching for edges on multiple lines. */
>
>  #include <errno.h>
>  #include <gpiod.h>
> --
> 2.41.0
>

I applied this and patches 3 and 4 as well. I fixed the whitespace
error reported by git in this one.

Bart
diff mbox series

Patch

diff --git a/examples/async_watch_line_value.c b/examples/async_watch_line_value.c
index f35fb1a..8b1d643 100644
--- a/examples/async_watch_line_value.c
+++ b/examples/async_watch_line_value.c
@@ -1,7 +1,7 @@ 
 // SPDX-License-Identifier: GPL-2.0-or-later
 // SPDX-FileCopyrightText: 2023 Kent Gibson <warthog618@gmail.com>
 
-/* Minimal example of asynchronously watching for edges on a single line */
+/* Minimal example of asynchronously watching for edges on a single line. */
 
 #include <errno.h>
 #include <gpiod.h>
diff --git a/examples/get_multiple_line_values.c b/examples/get_multiple_line_values.c
index b16c570..c6df3f6 100644
--- a/examples/get_multiple_line_values.c
+++ b/examples/get_multiple_line_values.c
@@ -1,7 +1,7 @@ 
 // SPDX-License-Identifier: GPL-2.0-or-later
 // SPDX-FileCopyrightText: 2023 Kent Gibson <warthog618@gmail.com>
 
-/* Minimal example of reading a single line. */
+/* Minimal example of reading multiple lines. */
 
 #include <errno.h>
 #include <gpiod.h>
diff --git a/examples/reconfigure_input_to_output.c b/examples/reconfigure_input_to_output.c
index e8fbb1c..abfaf79 100644
--- a/examples/reconfigure_input_to_output.c
+++ b/examples/reconfigure_input_to_output.c
@@ -1,7 +1,10 @@ 
 // SPDX-License-Identifier: GPL-2.0-or-later
 // SPDX-FileCopyrightText: 2023 Kent Gibson <warthog618@gmail.com>
 
-/* Minimal example of reading a single line. */
+/* 
+ * Example of a bi-directional line requested as input and then switched
+ * to output.
+ */
 
 #include <errno.h>
 #include <gpiod.h>
diff --git a/examples/watch_multiple_line_values.c b/examples/watch_multiple_line_values.c
index 8015270..e955b2c 100644
--- a/examples/watch_multiple_line_values.c
+++ b/examples/watch_multiple_line_values.c
@@ -1,7 +1,7 @@ 
 // SPDX-License-Identifier: GPL-2.0-or-later
 // SPDX-FileCopyrightText: 2023 Kent Gibson <warthog618@gmail.com>
 
-/* Minimal example of watching for edges on a single line. */
+/* Minimal example of watching for edges on multiple lines. */
 
 #include <errno.h>
 #include <gpiod.h>