X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=b9965f75a5852364ef923ee98ca3b2e792745ceb;hp=33db1257eb126bbf9f59299175af05f13c5edaf6;hb=c2d60644d2c00fb32258b380bb25ce0a26b87026;hpb=104125b2dd0a044fb3d68f9bc3b1b18c9f32ae2b

diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h
index 33db1257..b9965f75 100644
--- a/tools/ccanlint/ccanlint.h
+++ b/tools/ccanlint/ccanlint.h
@@ -1,5 +1,6 @@
 #ifndef CCAN_LINT_H
 #define CCAN_LINT_H
+#include "config.h"
 #include <ccan/list/list.h>
 #include <stdbool.h>
 #include "../doc_extract.h"
@@ -15,6 +16,21 @@
    4 == Describe every action. */
 extern int verbose;
 
+enum license {
+	LICENSE_LGPLv2_PLUS,
+	LICENSE_LGPLv2,
+	LICENSE_LGPLv3,
+	LICENSE_LGPL,
+	LICENSE_GPLv2_PLUS,
+	LICENSE_GPLv2,
+	LICENSE_GPLv3,
+	LICENSE_GPL,
+	LICENSE_BSD,
+	LICENSE_MIT,
+	LICENSE_PUBLIC_DOMAIN,
+	LICENSE_UNKNOWN
+};
+
 struct manifest {
 	char *dir;
 	/* The module name, ie. final element of dir name */
@@ -42,20 +58,31 @@ struct manifest {
 
 	/* From tests/check_depends_exist.c */
 	struct list_head deps;
+
+	/* From tests/license_exists.c */
+	enum license license;
 };
 
+/* Get the manifest for a given directory. */
 struct manifest *get_manifest(const void *ctx, const char *dir);
 
+/* Error in a particular file: stored off score->per_file_errors. */
 struct file_error {
 	struct list_node list;
 	struct ccan_file *file;
 	unsigned int line;
 };
 
+/* The score for an individual test. */
 struct score {
+	/* Starts as false: if not set to true, ccanlint exits non-zero.
+	 * Thus it is usually set for compilation or other serious failures. */
 	bool pass;
+	/* Starts at 0 and 1 respectively. */
 	unsigned int score, total;
+	/* The error message to print. */
 	char *error;
+	/* Per file errors, set by score_file_error() */
 	struct list_head per_file_errors;
 };
 
@@ -86,7 +113,7 @@ struct ccanlint {
 	/* If not set, we'll give an error if they try to set options. */
 	bool takes_options;
 
-	/* comma-separated list of dependency keys. */
+	/* Space-separated list of dependency keys. */
 	const char *needs;
 
 	/* Internal use fields: */