tools: don't assume modules are immediately below ccan/ dir.

[ccan] / tools / ccanlint / tests / info_documentation_exists.c

diff --git a/tools/ccanlint/tests/info_documentation_exists.c b/tools/ccanlint/tests/info_documentation_exists.c
index bef08608fa58854de785d1dcac6e5b276c6c2cd5..0c0ed451494db5604e489fa036a55050360015b4 100644 (file)
--- a/tools/ccanlint/tests/info_documentation_exists.c
+++ b/tools/ccanlint/tests/info_documentation_exists.c
@@ -15,14 +15,27 @@
 #include <ccan/noerr/noerr.h>
 #include <ccan/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");
 
@@ -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, NULL);
        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,16 +65,15 @@ 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,
+                                           struct score *score)
 {
        struct list_head *infodocs = get_ccan_file_docs(m->info_file);
        struct doc_section *d;
@@ -71,7 +83,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;
@@ -96,10 +108,5 @@ static void check_info_documentation_exists(struct manifest *m,
        }
 }
 
-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);