#include <ccan/noerr/noerr.h>
#include <ccan/grab_file/grab_file.h>
+extern struct ccanlint has_info_documentation;
+
static void create_info_template_doc(struct manifest *m, struct score *score)
{
int fd = open("_info.new", O_WRONLY|O_CREAT|O_EXCL, 0666);
"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)
+ } 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",
+ .key = "info_documentation_exists",
.name = "Module has documentation in _info",
.check = check_has_info_documentation,
+ .needs = "info_exists"
};
-REGISTER_TEST(has_info_documentation, NULL);
+REGISTER_TEST(has_info_documentation);