X-Git-Url: https://git.ozlabs.org/?a=blobdiff_plain;f=tools%2Fccanlint%2Ftests%2Finfo_documentation_exists.c;h=7be0b797532727a6fe1acd8f9af7e1ac52780837;hb=199023653cd6020218fbc4d0712591fc7ee0c5e1;hp=108f57f1e935255ff9bf00e48c611e0b68f523b7;hpb=7bb7cd58c2d9df126dd6072e5f3bec1eb4dc916b;p=ccan diff --git a/tools/ccanlint/tests/info_documentation_exists.c b/tools/ccanlint/tests/info_documentation_exists.c index 108f57f1..7be0b797 100644 --- a/tools/ccanlint/tests/info_documentation_exists.c +++ b/tools/ccanlint/tests/info_documentation_exists.c @@ -15,7 +15,16 @@ #include #include -extern struct ccanlint 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) { @@ -59,14 +68,16 @@ static void create_info_template_doc(struct manifest *m, struct score *score) } 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; 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,7 +89,6 @@ static void check_info_documentation_exists(struct manifest *m, if (summary && description) { score->score = score->total; - score->pass = true; } else if (!summary) { score->error = talloc_strdup(score, "_info file has no module documentation.\n\n" @@ -94,11 +104,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); +