X-Git-Url: https://git.ozlabs.org/?a=blobdiff_plain;f=tools%2Fccanlint%2Ftests%2Finfo_documentation_exists.c;h=47e72e5777edcb9824f5a5c069678285054ea872;hb=79ac0049672b1f27b1a7121d06cc38721f76b8e1;hp=7be0b797532727a6fe1acd8f9af7e1ac52780837;hpb=0621cac3bf1b5cf4c90de56e0e43b0acde0c94f1;p=ccan diff --git a/tools/ccanlint/tests/info_documentation_exists.c b/tools/ccanlint/tests/info_documentation_exists.c index 7be0b797..47e72e57 100644 --- a/tools/ccanlint/tests/info_documentation_exists.c +++ b/tools/ccanlint/tests/info_documentation_exists.c @@ -11,9 +11,8 @@ #include #include #include -#include #include -#include +#include static void check_info_documentation_exists(struct manifest *m, unsigned int *timeleft, @@ -28,10 +27,14 @@ static struct ccanlint info_documentation_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"); @@ -43,15 +46,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"); @@ -61,9 +64,9 @@ 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); } } @@ -79,7 +82,7 @@ static void check_info_documentation_exists(struct manifest *m, 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; @@ -90,13 +93,13 @@ static void check_info_documentation_exists(struct manifest *m, 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"