From: Bartosz Golaszewski Date: Wed, 12 Jul 2017 15:22:09 +0000 (+0200) Subject: libgpiod: unify the header comments X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=091d36e360ee3811ebfa3a4bb69f83f72ac8af92;p=qemu-gpiodev%2Flibgpiod.git 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 --- diff --git a/include/gpiod.h b/include/gpiod.h index 8fd521c..9e06110 100644 --- 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 * diff --git a/src/lib/chip.c b/src/lib/chip.c index 3c90b8e..83daa91 100644 --- 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 * diff --git a/src/lib/iter.c b/src/lib/iter.c index 91de813..76262cd 100644 --- 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 * @@ -8,6 +8,8 @@ * as published by the Free Software Foundation. */ +/* GPIO chip and line iterators. */ + #include #include diff --git a/src/lib/line.c b/src/lib/line.c index b155028..f078017 100644 --- 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 * diff --git a/src/lib/line.h b/src/lib/line.h index 84e2967..c87d139 100644 --- 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 * diff --git a/src/lib/misc.c b/src/lib/misc.c index 482083b..4aebbb0 100644 --- 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 * @@ -8,6 +8,8 @@ * as published by the Free Software Foundation. */ +/* Misc code that didn't fit anywhere else. */ + #include const char * gpiod_version_string(void) diff --git a/src/lib/simple.c b/src/lib/simple.c index d6db02e..5eb121f 100644 --- 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 * @@ -8,6 +8,8 @@ * as published by the Free Software Foundation. */ +/* Implementation of the high-level API. */ + #include #include diff --git a/src/tools/gpiodetect.c b/src/tools/gpiodetect.c index 10d16a2..6ef25f5 100644 --- 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 * diff --git a/src/tools/gpiofind.c b/src/tools/gpiofind.c index 9fbea7a..3a8b85b 100644 --- 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 * diff --git a/src/tools/gpioget.c b/src/tools/gpioget.c index 0d615a4..0575694 100644 --- 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 * diff --git a/src/tools/gpioinfo.c b/src/tools/gpioinfo.c index 3862a61..84ebb35 100644 --- 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 * diff --git a/src/tools/gpiomon.c b/src/tools/gpiomon.c index 67b6747..a8e008b 100644 --- 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 * diff --git a/src/tools/gpioset.c b/src/tools/gpioset.c index 7ac1f4d..9d2ded7 100644 --- 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 * diff --git a/src/tools/tools-common.c b/src/tools/tools-common.c index 74a85bc..1e968e0 100644 --- 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 * @@ -8,6 +8,8 @@ * as published by the Free Software Foundation. */ +/* Common code for GPIO tools. */ + #include #include "tools-common.h" diff --git a/src/tools/tools-common.h b/src/tools/tools-common.h index 7adabf2..663cac0 100644 --- 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 * diff --git a/tests/gpiod-test.c b/tests/gpiod-test.c index 56c8326..7b69272 100644 --- 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 * diff --git a/tests/gpiod-test.h b/tests/gpiod-test.h index d72b7d3..20c8a3d 100644 --- 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 * @@ -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 693ccdf..c3a1e6f 100644 --- 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 * @@ -8,6 +8,8 @@ * as published by the Free Software Foundation. */ +/* Test cases for GPIO chip handling. */ + #include "gpiod-test.h" #include diff --git a/tests/tests-event.c b/tests/tests-event.c index a00752f..fe59daf 100644 --- 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 * @@ -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 dc91777..a5b9671 100644 --- 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 * @@ -8,6 +8,8 @@ * as published by the Free Software Foundation. */ +/* Test cases for the gpiodetect program. */ + #include "gpiod-test.h" #include diff --git a/tests/tests-gpiofind.c b/tests/tests-gpiofind.c index 2ac3e9c..6faec57 100644 --- 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 * @@ -8,6 +8,8 @@ * as published by the Free Software Foundation. */ +/* Test cases for the gpiofind program. */ + #include "gpiod-test.h" #include diff --git a/tests/tests-gpioget.c b/tests/tests-gpioget.c index e5ebc70..fde9d18 100644 --- 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 * @@ -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 9a83e56..8a4a4ad 100644 --- 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 * @@ -8,6 +8,8 @@ * as published by the Free Software Foundation. */ +/* Test cases for the gpioinfo program. */ + #include "gpiod-test.h" #include diff --git a/tests/tests-gpiomon.c b/tests/tests-gpiomon.c index 36acb96..9d9b406 100644 --- 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 * @@ -8,6 +8,8 @@ * as published by the Free Software Foundation. */ +/* Test cases for the gpiomon program. */ + #include "gpiod-test.h" #include diff --git a/tests/tests-gpioset.c b/tests/tests-gpioset.c index 1001d8c..d0f9f99 100644 --- 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 * @@ -8,6 +8,8 @@ * as published by the Free Software Foundation. */ +/* Test cases for the gpioset program. */ + #include "gpiod-test.h" #include diff --git a/tests/tests-iter.c b/tests/tests-iter.c index daee771..106fc80 100644 --- 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 * @@ -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 537da6c..b0a07bf 100644 --- 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 * @@ -8,6 +8,8 @@ * as published by the Free Software Foundation. */ +/* GPIO line test cases. */ + #include "gpiod-test.h" #include diff --git a/tests/tests-misc.c b/tests/tests-misc.c index 5806376..949f58a 100644 --- 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 * @@ -8,6 +8,8 @@ * as published by the Free Software Foundation. */ +/* Misc test cases. */ + #include "gpiod-test.h" #include diff --git a/tests/tests-simple-api.c b/tests/tests-simple-api.c index 7f5a031..bf262c9 100644 --- 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 * @@ -8,6 +8,8 @@ * as published by the Free Software Foundation. */ +/* Test cases for the simple API. */ + #include "gpiod-test.h" #include