From 12941b07e6fbd4b32687460f33d0cabfda080a3a Mon Sep 17 00:00:00 2001 From: Rusty Russell Date: Mon, 17 Jan 2011 14:22:29 +1030 Subject: [PATCH 1/1] ccanlint: neaten info_summary_single_line with new doc_section info. --- .../ccanlint/tests/info_summary_single_line.c | 54 +++++++------------ 1 file changed, 19 insertions(+), 35 deletions(-) diff --git a/tools/ccanlint/tests/info_summary_single_line.c b/tools/ccanlint/tests/info_summary_single_line.c index 12f95e6e..19e9ada5 100644 --- a/tools/ccanlint/tests/info_summary_single_line.c +++ b/tools/ccanlint/tests/info_summary_single_line.c @@ -4,50 +4,34 @@ #include #include -/* Summary line is form ' - ' (spaces for 'struct foo -') */ -/* slightly modified from doc_extract-core.c */ -static unsigned int is_summary_line(const char *line) -{ - unsigned int id_len; - - id_len = strspn(line, IDENT_CHARS" *"); - if (id_len == 0) - return 0; - if (strspn(line, " ") == id_len) - return 0; - if (!strstarts(line + id_len-1, " - ")) - return 0; - return id_len - 1; -} - static void check_info_summary_single_line(struct manifest *m, bool keep, unsigned int *timeleft, struct score *score) { - int i = 0; - get_ccan_line_info(m->info_file); - score->total = 1; - for (i = 0; i < m->info_file->num_lines; ++i) { - if (is_summary_line(m->info_file->lines[i])) { - if (strspn(m->info_file->lines[i+1], " *") == strlen(m->info_file->lines[i+1])) { - /* valid summary line */ - score->error = NULL; - score->pass = true; - score->score = 1; - } else { - /* invalid summary line - line following summary line should be empty */ - score->pass = false; - score->score = 0; - score->error = "invalid summary line - not on a single line:"; - score_file_error(score, m->info_file, i+1, "summary is not on a single line"); - } - break; + struct list_head *infodocs = get_ccan_file_docs(m->info_file); + struct doc_section *d; + + score->pass = true; + list_for_each(infodocs, d, list) { + const char *after; + + if (!streq(d->type, "summary")) + continue; + + /* line following summary line should be empty */ + after = m->info_file->lines[d->srcline+1]; + if (after && strspn(after, " *") != strlen(after)) { + score->pass = false; + score->score = 0; + score_file_error(score, m->info_file, d->srcline+1, + m->info_file->lines[d->srcline]); + score_file_error(score, m->info_file, d->srcline+2, + m->info_file->lines[d->srcline+1]); } } } - struct ccanlint info_summary_single_line = { .key = "info_summary_single_line", .name = "Module has a single line summary in _info", -- 2.39.2