X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Ftests%2Fhas_info_documentation.c;h=cdfb0e2c63f3e29c9856887b49badbb356287722;hp=4202880e7b45bde91f2b322ca4653cc289e70ca8;hb=3cd1d24a9e2e578890951d723e0461ed13444650;hpb=8f61c0bccb152b2365baf70deac1e59264d7feb7

diff --git a/tools/ccanlint/tests/has_info_documentation.c b/tools/ccanlint/tests/has_info_documentation.c
index 4202880e..cdfb0e2c 100644
--- a/tools/ccanlint/tests/has_info_documentation.c
+++ b/tools/ccanlint/tests/has_info_documentation.c
@@ -1,5 +1,6 @@
 #include <tools/ccanlint/ccanlint.h>
 #include <tools/doc_extract.h>
+#include <tools/tools.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <fcntl.h>
@@ -18,14 +19,15 @@ struct info_docs
 {
 	bool summary;
 	bool description;
-	bool example;
 };
 
-static void *check_has_info_documentation(struct manifest *m)
+static void *check_has_info_documentation(struct manifest *m,
+					  bool keep,
+					  unsigned int *timeleft)
 {
 	struct list_head *infodocs = get_ccan_file_docs(m->info_file);
 	struct doc_section *d;
-	struct info_docs id = { false, false, false };
+	struct info_docs id = { false, false };
 
 	list_for_each(infodocs, d, list) {
 		if (!streq(d->function, m->basename))
@@ -34,11 +36,9 @@ static void *check_has_info_documentation(struct manifest *m)
 			id.summary = true;
 		if (streq(d->type, "description"))
 			id.description = true;
-		if (streq(d->type, "example"))
-			id.example = true;
 	}
 
-	if (id.summary && id.description && id.example)
+	if (id.summary && id.description)
 		return NULL;
 	return talloc_memdup(m, &id, sizeof(id));
 }
@@ -48,12 +48,12 @@ extern struct ccanlint has_info_documentation;
 
 static void create_info_template_doc(struct manifest *m, void *check_result)
 {
-	int fd = open("_info.c.new", O_WRONLY|O_CREAT|O_EXCL, 0666);
+	int fd = open("_info.new", O_WRONLY|O_CREAT|O_EXCL, 0666);
 	FILE *new;
 	char *oldcontents;
 
 	if (fd < 0 || !(new = fdopen(fd, "w")))
-		err(1, "Creating _info.c.new to insert documentation");
+		err(1, "Creating _info.new to insert documentation");
 
 	if (fprintf(new,
 		    "/**\n"
@@ -64,26 +64,26 @@ static void create_info_template_doc(struct manifest *m, void *check_result)
 		    " * Followed by an Example: section with a standalone\n"
 		    " * (trivial and usually useless) program\n"
 		    " */\n", m->basename, m->basename) < 0) {
-		unlink_noerr("_info.c.new");
-		err(1, "Writing to _info.c.new to insert documentation");
+		unlink_noerr("_info.new");
+		err(1, "Writing to _info.new to insert documentation");
 	}
 
-	oldcontents = grab_file(m, "_info.c", NULL);
+	oldcontents = grab_file(m, "_info", NULL);
 	if (!oldcontents) {
-		unlink_noerr("_info.c.new");
-		err(1, "Reading _info.c");
+		unlink_noerr("_info.new");
+		err(1, "Reading _info");
 	}
 	if (fprintf(new, "%s", oldcontents) < 0) {
-		unlink_noerr("_info.c.new");
-		err(1, "Appending _info.c to _info.c.new");
+		unlink_noerr("_info.new");
+		err(1, "Appending _info to _info.new");
 	}
 	if (fclose(new) != 0) {
-		unlink_noerr("_info.c.new");
-		err(1, "Closing _info.c.new");
+		unlink_noerr("_info.new");
+		err(1, "Closing _info.new");
 	}
-	if (rename("_info.c.new", "_info.c") != 0) {
-		unlink_noerr("_info.c.new");
-		err(1, "Renaming _info.c.new to _info.c");
+	if (!move_file("_info.new", "_info")) {
+		unlink_noerr("_info.new");
+		err(1, "Renaming _info.new to _info");
 	}
 }
 
@@ -96,21 +96,16 @@ static const char *describe_has_info_documentation(struct manifest *m,
 	if (!id->summary) {
 		has_info_documentation.handle = create_info_template_doc;
 		reason = talloc_asprintf_append(reason,
-		"Your _info.c has no module documentation.\n\n"
+		"Your _info file has no module documentation.\n\n"
 		"CCAN modules use /**-style comments for documentation: the\n"
-	        "overall documentation belongs in the _info.c metafile.\n");
+	        "overall documentation belongs in the _info metafile.\n");
 	}
 	if (!id->description)
 		reason = talloc_asprintf_append(reason,
-		"Your _info.c has no module description.\n\n"
-		"The lines after the first summary line in the _info.c file\n"
+		"Your _info file has no module description.\n\n"
+		"The lines after the first summary line in the _info file\n"
 		"documentation should describe the purpose and use of the\n"
 		"overall package\n");
-	if (!id->example)
-		reason = talloc_asprintf_append(reason,
-		"Your _info.c has no module example.\n\n"
-		"There should be an Example: section of the _info.c documentation\n"
-		"which provides a concise toy program which uses your module\n");
 	return reason;
 }
 
@@ -118,13 +113,16 @@ static unsigned int has_info_documentation_score(struct manifest *m,
 						 void *check_result)
 {
 	struct info_docs *id = check_result;
-	return id->summary + id->description + id->example;
+	return (unsigned int)id->summary + id->description;
 }
 
 struct ccanlint has_info_documentation = {
-	.name = "Documentation in _info.c",
-	.total_score = 3,
+	.key = "info-documentation",
+	.name = "Module has documentation in _info",
+	.total_score = 2,
 	.score = has_info_documentation_score,
 	.check = check_has_info_documentation,
 	.describe = describe_has_info_documentation,
 };
+
+REGISTER_TEST(has_info_documentation, NULL);