1 #include <tools/ccanlint/ccanlint.h>
2 #include <tools/doc_extract.h>
3 #include <tools/tools.h>
13 #include <ccan/str/str.h>
14 #include <ccan/talloc/talloc.h>
15 #include <ccan/noerr/noerr.h>
16 #include <ccan/grab_file/grab_file.h>
18 REGISTER_TEST(info_documentation_exists);
20 static void create_info_template_doc(struct manifest *m, struct score *score)
22 int fd = open("_info.new", O_WRONLY|O_CREAT|O_EXCL, 0666);
26 if (fd < 0 || !(new = fdopen(fd, "w")))
27 err(1, "Creating _info.new to insert documentation");
31 " * %s - [[ONE LINE DESCRIPTION HERE]]\n"
33 " * Paragraphs why %s exists and where to use it.\n"
35 " * Followed by an Example: section with a standalone\n"
36 " * (trivial and usually useless) program\n"
37 " */\n", m->basename, m->basename) < 0) {
38 unlink_noerr("_info.new");
39 err(1, "Writing to _info.new to insert documentation");
42 oldcontents = grab_file(m, "_info", NULL);
44 unlink_noerr("_info.new");
45 err(1, "Reading _info");
47 if (fprintf(new, "%s", oldcontents) < 0) {
48 unlink_noerr("_info.new");
49 err(1, "Appending _info to _info.new");
51 if (fclose(new) != 0) {
52 unlink_noerr("_info.new");
53 err(1, "Closing _info.new");
55 if (!move_file("_info.new", "_info")) {
56 unlink_noerr("_info.new");
57 err(1, "Renaming _info.new to _info");
61 static void check_info_documentation_exists(struct manifest *m,
62 unsigned int *timeleft,
65 struct list_head *infodocs = get_ccan_file_docs(m->info_file);
66 struct doc_section *d;
67 bool summary = false, description = false;
69 /* We don't fail ccanlint for this. */
72 list_for_each(infodocs, d, list) {
73 if (!streq(d->function, m->basename))
75 if (streq(d->type, "summary"))
77 if (streq(d->type, "description"))
81 if (summary && description) {
82 score->score = score->total;
83 } else if (!summary) {
84 score->error = talloc_strdup(score,
85 "_info file has no module documentation.\n\n"
86 "CCAN modules use /**-style comments for documentation: the\n"
87 "overall documentation belongs in the _info metafile.\n");
88 info_documentation_exists.handle = create_info_template_doc;
89 } else if (!description) {
90 score->error = talloc_strdup(score,
91 "_info file has no module description.\n\n"
92 "The lines after the first summary line in the _info file\n"
93 "documentation should describe the purpose and use of the\n"
98 struct ccanlint info_documentation_exists = {
99 .key = "info_documentation_exists",
100 .name = "Module has documentation in _info",
101 .check = check_info_documentation_exists,
102 .needs = "info_exists"