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 static void check_info_documentation_exists(struct manifest *m,
19 unsigned int *timeleft,
22 static struct ccanlint info_documentation_exists = {
23 .key = "info_documentation_exists",
24 .name = "Module has documentation in _info",
25 .check = check_info_documentation_exists,
26 .needs = "info_exists"
29 static void create_info_template_doc(struct manifest *m, struct score *score)
31 int fd = open("_info.new", O_WRONLY|O_CREAT|O_EXCL, 0666);
35 if (fd < 0 || !(new = fdopen(fd, "w")))
36 err(1, "Creating _info.new to insert documentation");
40 " * %s - [[ONE LINE DESCRIPTION HERE]]\n"
42 " * Paragraphs why %s exists and where to use it.\n"
44 " * Followed by an Example: section with a standalone\n"
45 " * (trivial and usually useless) program\n"
46 " */\n", m->basename, m->basename) < 0) {
47 unlink_noerr("_info.new");
48 err(1, "Writing to _info.new to insert documentation");
51 oldcontents = grab_file(m, "_info", NULL);
53 unlink_noerr("_info.new");
54 err(1, "Reading _info");
56 if (fprintf(new, "%s", oldcontents) < 0) {
57 unlink_noerr("_info.new");
58 err(1, "Appending _info to _info.new");
60 if (fclose(new) != 0) {
61 unlink_noerr("_info.new");
62 err(1, "Closing _info.new");
64 if (!move_file("_info.new", "_info")) {
65 unlink_noerr("_info.new");
66 err(1, "Renaming _info.new to _info");
70 static void check_info_documentation_exists(struct manifest *m,
71 unsigned int *timeleft,
74 struct list_head *infodocs = get_ccan_file_docs(m->info_file);
75 struct doc_section *d;
76 bool summary = false, description = false;
78 /* We don't fail ccanlint for this. */
81 list_for_each(infodocs, d, list) {
82 if (!streq(d->function, m->basename))
84 if (streq(d->type, "summary"))
86 if (streq(d->type, "description"))
90 if (summary && description) {
91 score->score = score->total;
92 } else if (!summary) {
93 score->error = talloc_strdup(score,
94 "_info file has no module documentation.\n\n"
95 "CCAN modules use /**-style comments for documentation: the\n"
96 "overall documentation belongs in the _info metafile.\n");
97 info_documentation_exists.handle = create_info_template_doc;
98 } else if (!description) {
99 score->error = talloc_strdup(score,
100 "_info file has no module description.\n\n"
101 "The lines after the first summary line in the _info file\n"
102 "documentation should describe the purpose and use of the\n"
103 "overall package\n");
107 REGISTER_TEST(info_documentation_exists);