#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>
-REGISTER_TEST(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)
{
- 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");
" *\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");
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);
}
}
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;
if (summary && description) {
score->score = score->total;
} else if (!summary) {
- score->error = talloc_strdup(score,
+ 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");
info_documentation_exists.handle = create_info_template_doc;
} else if (!description) {
- score->error = talloc_strdup(score,
+ 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"
}
}
-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);