X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Ftests%2Finfo_documentation_exists.c;h=c3f02226b869b5182c8fe49a76a9133c98bc9ddf;hp=a5316fe00d0ae3dba4a2a2287a51ce1dfeb17faa;hb=1ddb7420f1ac53c060aec62e26702d1d7029fc54;hpb=051db34fb275491d4d5dfa5bf7970e8e525766d8

diff --git a/tools/ccanlint/tests/info_documentation_exists.c b/tools/ccanlint/tests/info_documentation_exists.c
index a5316fe0..c3f02226 100644
--- a/tools/ccanlint/tests/info_documentation_exists.c
+++ b/tools/ccanlint/tests/info_documentation_exists.c
@@ -11,18 +11,31 @@
 #include <stdio.h>
 #include <err.h>
 #include <ccan/str/str.h>
-#include <ccan/talloc/talloc.h>
 #include <ccan/noerr/noerr.h>
-#include <ccan/grab_file/grab_file.h>
+#include <ccan/tal/grab_file/grab_file.h>
 
-extern struct ccanlint info_documentation_exists;
+static void check_info_documentation_exists(struct manifest *m,
+					    unsigned int *timeleft,
+					    struct score *score);
+
+static struct ccanlint info_documentation_exists = {
+	.key = "info_documentation_exists",
+	.name = "Module has documentation in _info",
+	.check = check_info_documentation_exists,
+	.needs = "info_exists"
+};
 
-static void create_info_template_doc(struct manifest *m, struct score *score)
+static void create_info_template_doc(struct manifest *m,
+				     struct score *score UNNEEDED)
 {
-	int fd = open("_info.new", O_WRONLY|O_CREAT|O_EXCL, 0666);
+	int fd;
 	FILE *new;
 	char *oldcontents;
 
+	if (!ask("Should I prepend description to _info file for you?"))
+		return;
+
+	fd = open("_info.new", O_WRONLY|O_CREAT|O_EXCL, 0666);
 	if (fd < 0 || !(new = fdopen(fd, "w")))
 		err(1, "Creating _info.new to insert documentation");
 
@@ -34,15 +47,15 @@ static void create_info_template_doc(struct manifest *m, struct score *score)
 		    " *\n"
 		    " * Followed by an Example: section with a standalone\n"
 		    " * (trivial and usually useless) program\n"
-		    " */\n", m->basename, m->basename) < 0) {
+		    " */\n", m->modname, m->basename) < 0) {
 		unlink_noerr("_info.new");
 		err(1, "Writing to _info.new to insert documentation");
 	}
 
-	oldcontents = grab_file(m, "_info", NULL);
+	oldcontents = grab_file(m, m->info_file->fullname);
 	if (!oldcontents) {
 		unlink_noerr("_info.new");
-		err(1, "Reading _info");
+		err(1, "Reading %s", m->info_file->fullname);
 	}
 	if (fprintf(new, "%s", oldcontents) < 0) {
 		unlink_noerr("_info.new");
@@ -52,23 +65,25 @@ static void create_info_template_doc(struct manifest *m, struct score *score)
 		unlink_noerr("_info.new");
 		err(1, "Closing _info.new");
 	}
-	if (!move_file("_info.new", "_info")) {
+	if (!move_file("_info.new", m->info_file->fullname)) {
 		unlink_noerr("_info.new");
-		err(1, "Renaming _info.new to _info");
+		err(1, "Renaming _info.new to %s", m->info_file->fullname);
 	}
 }
 
 static void check_info_documentation_exists(struct manifest *m,
-					 bool keep,
-					 unsigned int *timeleft,
-					 struct score *score)
+					    unsigned int *timeleft UNNEEDED,
+					    struct score *score)
 {
 	struct list_head *infodocs = get_ccan_file_docs(m->info_file);
 	struct doc_section *d;
 	bool summary = false, description = false;
 
+	/* We don't fail ccanlint for this. */
+	score->pass = true;
+
 	list_for_each(infodocs, d, list) {
-		if (!streq(d->function, m->basename))
+		if (!streq(d->function, m->modname))
 			continue;
 		if (streq(d->type, "summary"))
 			summary = true;
@@ -78,25 +93,20 @@ static void check_info_documentation_exists(struct manifest *m,
 
 	if (summary && description) {
 		score->score = score->total;
-		score->pass = true;
 	} else if (!summary) {
-		score->error = "_info file has no module documentation.\n\n"
+		score->error = tal_strdup(score,
+		"_info file has no module documentation.\n\n"
 		"CCAN modules use /**-style comments for documentation: the\n"
-		"overall documentation belongs in the _info metafile.\n";
+		"overall documentation belongs in the _info metafile.\n");
 		info_documentation_exists.handle = create_info_template_doc;
 	} else if (!description)  {
-		score->error = "_info file has no module description.\n\n"
+		score->error = tal_strdup(score,
+		"_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";
+		"overall package\n");
 	}
 }
 
-struct ccanlint info_documentation_exists = {
-	.key = "info_documentation_exists",
-	.name = "Module has documentation in _info",
-	.check = check_info_documentation_exists,
-	.needs = "info_exists"
-};
-
 REGISTER_TEST(info_documentation_exists);
+