Add license and a description to all the sources

diff --git a/mkmutest b/mkmutest
index c6b941b6e1ac1b5f5879d52f4edb6e62e739642a..32c0e5adbeaddc8b94c56d8f3deb4c5d30088f73 100755 (executable)
--- a/mkmutest
+++ b/mkmutest
@@ -1,14 +1,16 @@
 #!/bin/bash
-
-# This file is part of mutest, a micro testing framework for C.
 #
-# mutest is under the BOLA license, please see the LICENSE file or visit
+# This file is part of mutest, a simple micro unit testing framework for C.
+#
+# mutest was written by Leandro Lucarella <llucax@gmail.com> and is released
+# under the BOLA license, please see the LICENSE file or visit:
 # http://blitiri.com.ar/p/bola/
 #
-# This is a simple script to generate a C file that runs all the test cases
+# This is a simple script to generate a C file that runs all the test suites
 # present in .o files passed as arguments.
 #
 # Please, read the README file for more details.
+#
 
 
 # the trick here is getting all the test cases present in an object file using

diff --git a/mutest.c b/mutest.c
index 291fdd458c1224e3753c256217c9a723f764dc01..00dd7b8f38d846199f72b4bfb92d044c152e988c 100644 (file)
--- a/mutest.c
+++ b/mutest.c
@@ -1,3 +1,17 @@
+/*
+ * This file is part of mutest, a simple micro unit testing framework for C.
+ *
+ * mutest was written by Leandro Lucarella <llucax@gmail.com> and is released
+ * under the BOLA license, please see the LICENSE file or visit:
+ * http://blitiri.com.ar/p/bola/
+ *
+ * This is the main program, it runs all the test suites and shows the
+ * results.  The main work (of running the test suite) is done by the (usually)
+ * synthesized mu_run_suites() function, which can be generated using the
+ * mkmutest script (or written manually).
+ *
+ * Please, read the README file for more details.
+ */
 
 #include "mutest.h" /* MU_* constants, mu_print() */
 #include <stdio.h> /* printf(), fprintf() */

diff --git a/mutest.h b/mutest.h
index 938918f6449cae707d472b09154cf7f1212d3315..159625bd5a2e9a25bbd4d2c6a212557a90b07a5d 100644 (file)
--- a/mutest.h
+++ b/mutest.h
@@ -1,3 +1,16 @@
+/*
+ * This file is part of mutest, a simple micro unit testing framework for C.
+ *
+ * mutest was written by Leandro Lucarella <llucax@gmail.com> and is released
+ * under the BOLA license, please see the LICENSE file or visit:
+ * http://blitiri.com.ar/p/bola/
+ *
+ * This header file should be included in the source files that will make up
+ * a test suite. If you implement your mu_run_suites() function yourself, you
+ * probably will need to include this header too (see mkmutest).
+ *
+ * Please, read the README file for more details.
+ */
 
 #include <stdio.h> /* fprintf() */
 

diff --git a/py/mutest b/py/mutest
index 8535523298b3379f2f0d3969e526766ae8405a18..b9a4042aace2534b17865d08917cdbb6ed99998f 100755 (executable)
--- a/py/mutest
+++ b/py/mutest
@@ -1,4 +1,17 @@
 #!/usr/bin/env python
+#
+# This file is part of mutest, a simple micro unit testing framework for C.
+#
+# mutest was written by Leandro Lucarella <llucax@gmail.com> and is released
+# under the BOLA license, please see the LICENSE file or visit:
+# http://blitiri.com.ar/p/bola/
+#
+# This is a Python implementation of the mutest main idea. This script load
+# the dynamic shared object (.so file) passed as argument, search them for test
+# cases and run them, collecting statistics.
+#
+# Please, read the README file for more details.
+#
 
 import re
 from sys import stdout, stderr

diff --git a/py/mutest.h b/py/mutest.h
index ace3b9c9832bd69ab83fc74961dbfe405f634d54..8c42ca8e74d0de13102d62f7818ece60c2ae7c60 100644 (file)
--- a/py/mutest.h
+++ b/py/mutest.h
@@ -1,3 +1,16 @@
+/*
+ * This file is part of mutest, a simple micro unit testing framework for C.
+ *
+ * mutest was written by Leandro Lucarella <llucax@gmail.com> and is released
+ * under the BOLA license, please see the LICENSE file or visit:
+ * http://blitiri.com.ar/p/bola/
+ *
+ * This is a Python implementation of the mutest main idea. This header file
+ * should be included in the source files that will make up a test suite, as
+ * a dynamic shared object (.so file).
+ *
+ * Please, read the README file for more details.
+ */
 
 #include <stdio.h> /* printf(), fprintf() */
 

diff --git a/sample/Makefile b/sample/Makefile
index e7c764d54ed374ff79907f2de7f25e486130cf4a..aa5ec8ff1da7b4f03e50c87e63bc397dba109b27 100644 (file)
--- a/sample/Makefile
+++ b/sample/Makefile
@@ -1,3 +1,14 @@
+#
+# This file is part of mutest, a simple micro unit testing framework for C.
+#
+# mutest was written by Leandro Lucarella <llucax@gmail.com> and is released
+# under the BOLA license, please see the LICENSE file or visit:
+# http://blitiri.com.ar/p/bola/
+#
+# This is the samples Makefile.
+#
+# Please, read the README file for more details.
+#
 
 # Show the tests summary
 V=-v

diff --git a/sample/factorial.c b/sample/factorial.c
index c178fa0f44b69d878253b1d4da83a8f15451f0c7..78d43e928308cca3b28d0b912ed858604b5b068c 100644 (file)
--- a/sample/factorial.c
+++ b/sample/factorial.c
@@ -1,3 +1,14 @@
+/*
+ * This file is part of mutest, a simple micro unit testing framework for C.
+ *
+ * mutest was written by Leandro Lucarella <llucax@gmail.com> and is released
+ * under the BOLA license, please see the LICENSE file or visit:
+ * http://blitiri.com.ar/p/bola/
+ *
+ * This is an example module that calculates a factorial.
+ *
+ * Please, read the README file for more details.
+ */
 
 unsigned factorial(unsigned x) {
        if (x <= 1)

diff --git a/sample/factorial.h b/sample/factorial.h
index a2d71d2643ecafd2fa56d3f46ff1e2923ce4a292..0fb6f29ec7e5e93b63377f9dc18219fdc60f3c93 100644 (file)
--- a/sample/factorial.h
+++ b/sample/factorial.h
@@ -1,3 +1,14 @@
+/*
+ * This file is part of mutest, a simple micro unit testing framework for C.
+ *
+ * mutest was written by Leandro Lucarella <llucax@gmail.com> and is released
+ * under the BOLA license, please see the LICENSE file or visit:
+ * http://blitiri.com.ar/p/bola/
+ *
+ * This is the factorial module header.
+ *
+ * Please, read the README file for more details.
+ */
 
 int factorial(int);
 

diff --git a/sample/factorial_test.c b/sample/factorial_test.c
index 0e0191a431578356680e5a2210e9a12c6e2fbd84..8dc56a8b0364c94768cd163f253f05a320002442 100644 (file)
--- a/sample/factorial_test.c
+++ b/sample/factorial_test.c
@@ -1,3 +1,15 @@
+/*
+ * This file is part of mutest, a simple micro unit testing framework for C.
+ *
+ * mutest was written by Leandro Lucarella <llucax@gmail.com> and is released
+ * under the BOLA license, please see the LICENSE file or visit:
+ * http://blitiri.com.ar/p/bola/
+ *
+ * This is the factorial module test suite. Each (public) function starting
+ * with mu_test will be picked up by mkmutest as a test case.
+ *
+ * Please, read the README file for more details.
+ */
 
 #include "factorial.h"
 

diff --git a/sample/init_fail_test.c b/sample/init_fail_test.c
index c92bd7dce95aec43df9d9da73ac002b0e77ca030..b3c74758f22583fbe0e52dab596824f00cca1f08 100644 (file)
--- a/sample/init_fail_test.c
+++ b/sample/init_fail_test.c
@@ -1,5 +1,18 @@
-
-/* dummy test to illustrate how a test suite initialization could fail */
+/*
+ * This file is part of mutest, a simple micro unit testing framework for C.
+ *
+ * mutest was written by Leandro Lucarella <llucax@gmail.com> and is released
+ * under the BOLA license, please see the LICENSE file or visit:
+ * http://blitiri.com.ar/p/bola/
+ *
+ * This is a dummy test suite that illustrates how a test suite initialization
+ * can fail. Each (public) function starting with mu_init will be picked up
+ * by mkmutest as an initialization function and executed unless one fails
+ * (returns != 0). Functions starting with mu_test will be used as test cases,
+ * but since an initialization function fails, none will be executed.
+ *
+ * Please, read the README file for more details.
+ */
 
 #ifdef MUTEST_PY
 #include "../py/mutest.h"

diff --git a/sample/sum.c b/sample/sum.c
index 4d45974a972d095fc99bcad9644b04abf86f0f22..94fd49263d43d01b2b1a7269297b0158c5159ec4 100644 (file)
--- a/sample/sum.c
+++ b/sample/sum.c
@@ -1,3 +1,14 @@
+/*
+ * This file is part of mutest, a simple micro unit testing framework for C.
+ *
+ * mutest was written by Leandro Lucarella <llucax@gmail.com> and is released
+ * under the BOLA license, please see the LICENSE file or visit:
+ * http://blitiri.com.ar/p/bola/
+ *
+ * This is an example module that calculates the addition of two integers.
+ *
+ * Please, read the README file for more details.
+ */
 
 int sum(int x, int y) {
        return x + y;

diff --git a/sample/sum.h b/sample/sum.h
index 4f90d44252c2104bddc2318db3710df112702c4c..42ad86f897c4a67efc81b9f4b2791149cae787ad 100644 (file)
--- a/sample/sum.h
+++ b/sample/sum.h
@@ -1,3 +1,14 @@
+/*
+ * This file is part of mutest, a simple micro unit testing framework for C.
+ *
+ * mutest was written by Leandro Lucarella <llucax@gmail.com> and is released
+ * under the BOLA license, please see the LICENSE file or visit:
+ * http://blitiri.com.ar/p/bola/
+ *
+ * This is the sum module header.
+ *
+ * Please, read the README file for more details.
+ */
 
 int sum(int, int);
 

diff --git a/sample/sum_test.c b/sample/sum_test.c
index 7ef32e89a7c5bcdc050ae680de7b8c9d916221ac..505f814ffe5c3f73df7935aa5baa2ff458a509db 100644 (file)
--- a/sample/sum_test.c
+++ b/sample/sum_test.c
@@ -1,7 +1,20 @@
-
-/* see factorial_test.c for more complete examples, this file is mostly to show
- * how to have multiple test suites, test suite initialization and
- * termination, and a test suite that succeed. */
+/*
+ * This file is part of mutest, a simple micro unit testing framework for C.
+ *
+ * mutest was written by Leandro Lucarella <llucax@gmail.com> and is released
+ * under the BOLA license, please see the LICENSE file or visit:
+ * http://blitiri.com.ar/p/bola/
+ *
+ * This is the sum module test suite. It shows how to have multiple test
+ * suites, test suite initialization and termination, and a test suite that
+ * succeed. Each (public) function starting with mu_init will be picked up by
+ * mkmutest as an initialization function and executed unless one fails
+ * (returns != 0) Functions starting with mu_term will be used as termination
+ * functions, called after all test cases were executed. Functions starting
+ * with mu_test will be used as test cases.
+ *
+ * Please, read the README file for more details.
+ */
 
 #include "sum.h"
 #include <stdlib.h> /* malloc(), free() */