From dc199bb0ca26a6a01062933e04791eaf5e8494e5 Mon Sep 17 00:00:00 2001 From: Brad Hards Date: Mon, 17 Jan 2011 13:32:36 +1030 Subject: [PATCH] ccanlint: add test case for metadata summary line on a single separate line. --- .../ccanlint/tests/info_summary_single_line.c | 58 +++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 tools/ccanlint/tests/info_summary_single_line.c diff --git a/tools/ccanlint/tests/info_summary_single_line.c b/tools/ccanlint/tests/info_summary_single_line.c new file mode 100644 index 00000000..12f95e6e --- /dev/null +++ b/tools/ccanlint/tests/info_summary_single_line.c @@ -0,0 +1,58 @@ +#include +#include +#include +#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 ccanlint info_summary_single_line = { + .key = "info_summary_single_line", + .name = "Module has a single line summary in _info", + .check = check_info_summary_single_line, + .needs = "info_exists" +}; + +REGISTER_TEST(info_summary_single_line); -- 2.39.2