]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/tests/has_info_documentation.c
ccanlint: rename structures to match keys
[ccan] / tools / ccanlint / tests / has_info_documentation.c
index 6ecbf84247acf4a21bbe7e05f38fb84a325c8770..a5316fe00d0ae3dba4a2a2287a51ce1dfeb17faa 100644 (file)
@@ -15,6 +15,8 @@
 #include <ccan/noerr/noerr.h>
 #include <ccan/grab_file/grab_file.h>
 
+extern 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);
@@ -56,7 +58,7 @@ static void create_info_template_doc(struct manifest *m, struct score *score)
        }
 }
 
-static void check_has_info_documentation(struct manifest *m,
+static void check_info_documentation_exists(struct manifest *m,
                                         bool keep,
                                         unsigned int *timeleft,
                                         struct score *score)
@@ -81,19 +83,20 @@ static void check_has_info_documentation(struct manifest *m,
                score->error = "_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";
-               has_info_documentation.handle = create_info_template_doc;
-       }
-       else if (!description) 
+               info_documentation_exists.handle = create_info_template_doc;
+       } else if (!description)  {
                score->error = "_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";
+       }
 }
 
-struct ccanlint has_info_documentation = {
-       .key = "info-documentation",
+struct ccanlint info_documentation_exists = {
+       .key = "info_documentation_exists",
        .name = "Module has documentation in _info",
-       .check = check_has_info_documentation,
+       .check = check_info_documentation_exists,
+       .needs = "info_exists"
 };
 
-REGISTER_TEST(has_info_documentation, NULL);
+REGISTER_TEST(info_documentation_exists);