libgpiod: unify the header comments

Make the header comment look the same in every file. Move additional
descriptions of files' contents below the header.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

diff --git a/include/gpiod.h b/include/gpiod.h
index 8fd521cfeb87b0d559ef9640b9e11a9033ab1e67..9e061105c8fbf6bf858045a74271e8b7a5e43e80 100644 (file)
--- a/include/gpiod.h
+++ b/include/gpiod.h
@@ -1,5 +1,5 @@
 /*
- * GPIO chardev utils for linux.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *

diff --git a/src/lib/chip.c b/src/lib/chip.c
index 3c90b8e9eb4a91e98de04725dd4928c970f78427..83daa919ab5913385509ef75535fa965b6f8fcae 100644 (file)
--- a/src/lib/chip.c
+++ b/src/lib/chip.c
@@ -1,5 +1,5 @@
 /*
- * GPIO chip handling.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *

diff --git a/src/lib/iter.c b/src/lib/iter.c
index 91de813ed51ce494fd7ba017528a427bb9f55b61..76262cd6c881297fdc1a2dc9e72be5d92bcc8a0e 100644 (file)
--- a/src/lib/iter.c
+++ b/src/lib/iter.c
@@ -1,5 +1,5 @@
 /*
- * GPIO chip and line iterators.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* GPIO chip and line iterators. */
+
 #include <gpiod.h>
 
 #include <string.h>

diff --git a/src/lib/line.c b/src/lib/line.c
index b15502886085144911ee346210563ee91bdcaebe..f07801775e05cebfe842363890affb6727ae342b 100644 (file)
--- a/src/lib/line.c
+++ b/src/lib/line.c
@@ -1,5 +1,5 @@
 /*
- * GPIO line handling.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *

diff --git a/src/lib/line.h b/src/lib/line.h
index 84e2967885ea28c9caa5f75d51c6f0ab969786d4..c87d1396cdc3fc9a6880394eb85e4df4d76902a9 100644 (file)
--- a/src/lib/line.h
+++ b/src/lib/line.h
@@ -1,5 +1,5 @@
 /*
- * Internal GPIO line-related prototypes.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *

diff --git a/src/lib/misc.c b/src/lib/misc.c
index 482083b6561828103df401fbb6990205c3510ce6..4aebbb03e695e809934e891e27f956761d8e2686 100644 (file)
--- a/src/lib/misc.c
+++ b/src/lib/misc.c
@@ -1,5 +1,5 @@
 /*
- * Misc definitions.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Misc code that didn't fit anywhere else. */
+
 #include <gpiod.h>
 
 const char * gpiod_version_string(void)

diff --git a/src/lib/simple.c b/src/lib/simple.c
index d6db02e7198db1e053fe4e389059ac4a1ef6d92d..5eb121f64e1ec6ca84c501542f136791dd1ca39d 100644 (file)
--- a/src/lib/simple.c
+++ b/src/lib/simple.c
@@ -1,5 +1,5 @@
 /*
- * Simple API for libgpiod.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Implementation of the high-level API. */
+
 #include <gpiod.h>
 
 #include <string.h>

diff --git a/src/tools/gpiodetect.c b/src/tools/gpiodetect.c
index 10d16a2aa1fd62a76fdfa4476439d996795114f6..6ef25f528947d25f19dd002b5903a8a590a40a79 100644 (file)
--- a/src/tools/gpiodetect.c
+++ b/src/tools/gpiodetect.c
@@ -1,5 +1,5 @@
 /*
- * List all GPIO chips.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *

diff --git a/src/tools/gpiofind.c b/src/tools/gpiofind.c
index 9fbea7ab6e3eba4eef189ac6db91d8dd0aebf9fb..3a8b85b8e5d3bac08572c8b5f026c44f2bc4903a 100644 (file)
--- a/src/tools/gpiofind.c
+++ b/src/tools/gpiofind.c
@@ -1,5 +1,5 @@
 /*
- * Read value from GPIO line.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *

diff --git a/src/tools/gpioget.c b/src/tools/gpioget.c
index 0d615a40579c3a261fb6779e7c86890ba6417a53..0575694ada4be557b7cce59c01bd95c737730380 100644 (file)
--- a/src/tools/gpioget.c
+++ b/src/tools/gpioget.c
@@ -1,5 +1,5 @@
 /*
- * Read value from GPIO line.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *

diff --git a/src/tools/gpioinfo.c b/src/tools/gpioinfo.c
index 3862a61fe3fed0db333e2c64ec8710ba88485145..84ebb35df2ec1d5c076fd2f5f21fd3abef145aa1 100644 (file)
--- a/src/tools/gpioinfo.c
+++ b/src/tools/gpioinfo.c
@@ -1,5 +1,5 @@
 /*
- * List all lines of a GPIO chip.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *

diff --git a/src/tools/gpiomon.c b/src/tools/gpiomon.c
index 67b6747e4d728a9d70069260159967f77a95b6b4..a8e008b934f2ac72a4c5f27e3628316184a7d663 100644 (file)
--- a/src/tools/gpiomon.c
+++ b/src/tools/gpiomon.c
@@ -1,5 +1,5 @@
 /*
- * Monitor events on GPIO lines.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *

diff --git a/src/tools/gpioset.c b/src/tools/gpioset.c
index 7ac1f4d910809fb844a7b4a8c8ab98ab7232cd34..9d2ded751ff23c3229d38a576cd2aec6261ccb80 100644 (file)
--- a/src/tools/gpioset.c
+++ b/src/tools/gpioset.c
@@ -1,5 +1,5 @@
 /*
- * Set value of a GPIO line.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *

diff --git a/src/tools/tools-common.c b/src/tools/tools-common.c
index 74a85bc411949b6d5ad8e5e6789b5a427c1a376f..1e968e02a2c47ae7d40d7beb504a94c723529182 100644 (file)
--- a/src/tools/tools-common.c
+++ b/src/tools/tools-common.c
@@ -1,5 +1,5 @@
 /*
- * Common code for GPIO tools.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Common code for GPIO tools. */
+
 #include <gpiod.h>
 #include "tools-common.h"
 

diff --git a/src/tools/tools-common.h b/src/tools/tools-common.h
index 7adabf2e92cc9d226890447dae4ef37e9c2f174e..663cac06c1ba32b5846a94c4512242f6549a19da 100644 (file)
--- a/src/tools/tools-common.h
+++ b/src/tools/tools-common.h
@@ -1,5 +1,5 @@
 /*
- * Common code for GPIO tools.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *

diff --git a/tests/gpiod-test.c b/tests/gpiod-test.c
index 56c8326c6d4cb7a906633b8221e1c3b1be2419c0..7b692721964aefc386c05bd0a2c09eaeef0e8384 100644 (file)
--- a/tests/gpiod-test.c
+++ b/tests/gpiod-test.c
@@ -1,5 +1,5 @@
 /*
- * Testing framework for libgpiod.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *

diff --git a/tests/gpiod-test.h b/tests/gpiod-test.h
index d72b7d37901d2025b7e01c5a8d8dc85a882b17ce..20c8a3d70d2927163300edc52c52653344db039c 100644 (file)
--- a/tests/gpiod-test.h
+++ b/tests/gpiod-test.h
@@ -1,5 +1,5 @@
 /*
- * Testing framework for libgpiod.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Testing framework - functions and definitions used by test cases. */
+
 #ifndef __GPIOD_TEST_H__
 #define __GPIOD_TEST_H__
 

diff --git a/tests/tests-chip.c b/tests/tests-chip.c
index 693ccdf3c23b7145c0239ae2a0cf0ed6a8b49abd..c3a1e6f55f2aaf6857c3e33af9cacd01ec8f7bb9 100644 (file)
--- a/tests/tests-chip.c
+++ b/tests/tests-chip.c
@@ -1,5 +1,5 @@
 /*
- * GPIO chip test cases for libgpiod.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Test cases for GPIO chip handling. */
+
 #include "gpiod-test.h"
 
 #include <stdio.h>

diff --git a/tests/tests-event.c b/tests/tests-event.c
index a00752fa9ab06d32249c12d67d9be8c3e599227f..fe59dafb8e5d607636214e43e74382373ffebd4b 100644 (file)
--- a/tests/tests-event.c
+++ b/tests/tests-event.c
@@ -1,5 +1,5 @@
 /*
- * Line event test cases for libgpiod.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Test cases for GPIO line events. */
+
 #include "gpiod-test.h"
 
 static void event_rising_edge_good(void)

diff --git a/tests/tests-gpiodetect.c b/tests/tests-gpiodetect.c
index dc917770988fbb7a2dab577558a157b11b1d12a9..a5b96718de92a1ee0c9452c536779ee21a5bbfef 100644 (file)
--- a/tests/tests-gpiodetect.c
+++ b/tests/tests-gpiodetect.c
@@ -1,5 +1,5 @@
 /*
- * Test cases for the gpiodetect tool.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Test cases for the gpiodetect program. */
+
 #include "gpiod-test.h"
 
 #include <stdio.h>

diff --git a/tests/tests-gpiofind.c b/tests/tests-gpiofind.c
index 2ac3e9ce7e5b5d3565c79aab996bc0072ea7f6fd..6faec575690f0e929117e95258f06ca91ad3db24 100644 (file)
--- a/tests/tests-gpiofind.c
+++ b/tests/tests-gpiofind.c
@@ -1,5 +1,5 @@
 /*
- * Test cases for the gpiofind tool.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Test cases for the gpiofind program. */
+
 #include "gpiod-test.h"
 
 #include <stdio.h>

diff --git a/tests/tests-gpioget.c b/tests/tests-gpioget.c
index e5ebc7084a86ac473287474ff502a3cd9a2df939..fde9d184adc242fcc357b38eeec1d93a1f1f1ac4 100644 (file)
--- a/tests/tests-gpioget.c
+++ b/tests/tests-gpioget.c
@@ -1,5 +1,5 @@
 /*
- * Test cases for the gpioget tool.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Test cases for the gpioget program. */
+
 #include "gpiod-test.h"
 
 static void gpioget_read_all_lines(void)

diff --git a/tests/tests-gpioinfo.c b/tests/tests-gpioinfo.c
index 9a83e568deeebbdcd3ab15d79f2bf3cddffc3d21..8a4a4adb25e5dac92351ac88341fdb9e9b64637e 100644 (file)
--- a/tests/tests-gpioinfo.c
+++ b/tests/tests-gpioinfo.c
@@ -1,5 +1,5 @@
 /*
- * Test cases for the gpioinfo tool.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Test cases for the gpioinfo program. */
+
 #include "gpiod-test.h"
 
 #include <stdio.h>

diff --git a/tests/tests-gpiomon.c b/tests/tests-gpiomon.c
index 36acb96659215697933994e709d23b682dfe991d..9d9b406e123fedfc4604d127685c86a3c5acb110 100644 (file)
--- a/tests/tests-gpiomon.c
+++ b/tests/tests-gpiomon.c
@@ -1,5 +1,5 @@
 /*
- * Test cases for the gpiomon tool.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Test cases for the gpiomon program. */
+
 #include "gpiod-test.h"
 
 #include <signal.h>

diff --git a/tests/tests-gpioset.c b/tests/tests-gpioset.c
index 1001d8c788aea398a41885025117c0632b3a67b9..d0f9f996aed28cd7e4eec402f8d820c7d16c48e0 100644 (file)
--- a/tests/tests-gpioset.c
+++ b/tests/tests-gpioset.c
@@ -1,5 +1,5 @@
 /*
- * Test cases for the gpioset tool.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Test cases for the gpioset program. */
+
 #include "gpiod-test.h"
 
 #include <signal.h>

diff --git a/tests/tests-iter.c b/tests/tests-iter.c
index daee7719e674d36adcf09db83551c0b479baa7d4..106fc8043e5ec7879c7d82b000308463f055a4d1 100644 (file)
--- a/tests/tests-iter.c
+++ b/tests/tests-iter.c
@@ -1,5 +1,5 @@
 /*
- * Iterator test cases for libgpiod.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Iterator test cases. */
+
 #include "gpiod-test.h"
 
 static void chip_iter(void)

diff --git a/tests/tests-line.c b/tests/tests-line.c
index 537da6cc1c034b4f6a4b3d6eafac6d37ff076adc..b0a07bfecce4fc4cbe7bd9742a03ec7f64392d62 100644 (file)
--- a/tests/tests-line.c
+++ b/tests/tests-line.c
@@ -1,5 +1,5 @@
 /*
- * GPIO line test cases for libgpiod.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* GPIO line test cases. */
+
 #include "gpiod-test.h"
 
 #include <errno.h>

diff --git a/tests/tests-misc.c b/tests/tests-misc.c
index 5806376bf74686b4fabfddb539180e442602d0dd..949f58aa0d89723eb7af32af83e8c550e60bad46 100644 (file)
--- a/tests/tests-misc.c
+++ b/tests/tests-misc.c
@@ -1,5 +1,5 @@
 /*
- * Misc test cases for libgpiod.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Misc test cases. */
+
 #include "gpiod-test.h"
 
 #include <errno.h>

diff --git a/tests/tests-simple-api.c b/tests/tests-simple-api.c
index 7f5a031dfd4a4e54669209775f6653acb8bdb905..bf262c960f73425ba2e780d8f8d90a9686be6cbe 100644 (file)
--- a/tests/tests-simple-api.c
+++ b/tests/tests-simple-api.c
@@ -1,5 +1,5 @@
 /*
- * Simple API test cases for libgpiod.
+ * This file is part of libgpiod.
  *
  * Copyright (C) 2017 Bartosz Golaszewski <bartekgola@gmail.com>
  *
@@ -8,6 +8,8 @@
  * as published by the Free Software Foundation.
  */
 
+/* Test cases for the simple API. */
+
 #include "gpiod-test.h"
 
 #include <errno.h>