ccanlint: print coverage amount when -vv
[ccan] / tools / ccanlint / tests / examples_relevant.c
1 #include <tools/ccanlint/ccanlint.h>
2 #include <tools/tools.h>
3 #include <ccan/talloc/talloc.h>
4 #include <ccan/str/str.h>
5 #include <sys/types.h>
6 #include <sys/stat.h>
7 #include <fcntl.h>
8 #include <unistd.h>
9 #include <limits.h>
10 #include <errno.h>
11 #include <stdlib.h>
12 #include <stdio.h>
13 #include <err.h>
14 #include <string.h>
15 #include <ctype.h>
16
17 static void examples_relevant_check(struct manifest *m,
18                                     bool keep,
19                                     unsigned int *timeleft,
20                                     struct score *score)
21 {
22         struct ccan_file *f;
23         struct doc_section *d;
24
25         list_for_each(&m->h_files, f, list) {
26                 list_for_each(get_ccan_file_docs(f), d, list) {
27                         unsigned int i;
28                         bool found = false;
29
30                         if (!streq(d->type, "example"))
31                                 continue;
32
33                         if (!d->function) {
34                                 score_file_error(score, f, d->srcline+1,
35                                                  "Function name not found in summary line");
36                                 continue;
37                         }
38                         for (i = 0; i < d->num_lines; i++) {
39                                 if (strstr(d->lines[i], d->function))
40                                         found = true;
41                         }
42
43                         if (!found) {
44                                 score_file_error(score, f, d->srcline+1,
45                                                  "Example for %s doesn't"
46                                                  " mention it", d->function);
47                         }
48                 }
49         }
50
51         if (!score->error) {
52                 score->score = score->total;
53                 score->pass = true;
54                 return;
55         }
56 }
57
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"
63 };
64
65 REGISTER_TEST(examples_relevant);