X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Ftests%2Finfo_documentation_exists.c;h=bef08608fa58854de785d1dcac6e5b276c6c2cd5;hp=a5316fe00d0ae3dba4a2a2287a51ce1dfeb17faa;hb=0e5d0e30b30bb07b6605843e5ff224210d8083d8;hpb=051db34fb275491d4d5dfa5bf7970e8e525766d8 diff --git a/tools/ccanlint/tests/info_documentation_exists.c b/tools/ccanlint/tests/info_documentation_exists.c index a5316fe0..bef08608 100644 --- a/tools/ccanlint/tests/info_documentation_exists.c +++ b/tools/ccanlint/tests/info_documentation_exists.c @@ -15,7 +15,7 @@ #include #include -extern struct ccanlint info_documentation_exists; +REGISTER_TEST(info_documentation_exists); static void create_info_template_doc(struct manifest *m, struct score *score) { @@ -67,6 +67,9 @@ static void check_info_documentation_exists(struct manifest *m, struct doc_section *d; bool summary = false, description = false; + /* We don't fail ccanlint for this. */ + score->pass = true; + list_for_each(infodocs, d, list) { if (!streq(d->function, m->basename)) continue; @@ -78,17 +81,18 @@ static void check_info_documentation_exists(struct manifest *m, if (summary && description) { score->score = score->total; - score->pass = true; } else if (!summary) { - score->error = "_info file has no module documentation.\n\n" + score->error = talloc_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"; + "overall documentation belongs in the _info metafile.\n"); info_documentation_exists.handle = create_info_template_doc; } else if (!description) { - score->error = "_info file has no module description.\n\n" + score->error = talloc_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" - "overall package\n"; + "overall package\n"); } } @@ -99,4 +103,3 @@ struct ccanlint info_documentation_exists = { .needs = "info_exists" }; -REGISTER_TEST(info_documentation_exists);