1 #include <tools/ccanlint/ccanlint.h>
2 #include <tools/tools.h>
3 #include <ccan/talloc/talloc.h>
4 #include <ccan/str/str.h>
17 static void examples_relevant_check(struct manifest *m,
19 unsigned int *timeleft,
23 struct doc_section *d;
25 list_for_each(&m->h_files, f, list) {
26 list_for_each(get_ccan_file_docs(f), d, list) {
30 if (!streq(d->type, "example"))
34 score_file_error(score, f, d->srcline+1,
35 "Function name not found in summary line");
38 for (i = 0; i < d->num_lines; i++) {
39 if (strstr(d->lines[i], d->function))
44 score_file_error(score, f, d->srcline+1,
45 "Example for %s doesn't"
46 " mention it", d->function);
52 score->score = score->total;
58 struct ccanlint examples_relevant = {
59 .key = "examples_relevant",
60 .name = "Example: sections demonstrate appropriate function",
61 .check = examples_relevant_check,
62 .needs = "examples_exist"
65 REGISTER_TEST(examples_relevant);