X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.h;h=23b6492dff68759576fd593f0a74b3e4850cbf32;hp=33db1257eb126bbf9f59299175af05f13c5edaf6;hb=6fb1663de7c1650a20bae6ca4e496e5a04130b41;hpb=caf366998b97b7cc29bc1f33c285feb2f5d33bff

diff --git a/tools/ccanlint/ccanlint.h b/tools/ccanlint/ccanlint.h
index 33db1257..23b6492d 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"
@@ -44,18 +45,26 @@ struct manifest {
 	struct list_head deps;
 };
 
+/* 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 +95,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: */