1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
#include <tools/ccanlint/ccanlint.h>
#include <tools/doc_extract.h>
#include <tools/tools.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <limits.h>
#include <errno.h>
#include <stdlib.h>
#include <stdio.h>
#include <err.h>
#include <ccan/str/str.h>
#include <ccan/noerr/noerr.h>
#include <ccan/tal/grab_file/grab_file.h>
static void check_info_documentation_exists(struct manifest *m,
unsigned int *timeleft,
struct score *score);
static struct ccanlint info_documentation_exists = {
.key = "info_documentation_exists",
.name = "Module has documentation in _info",
.check = check_info_documentation_exists,
.needs = "info_exists"
};
static void create_info_template_doc(struct manifest *m, struct score *score)
{
int fd;
FILE *new;
char *oldcontents;
if (!ask("Should I prepend description to _info file for you?"))
return;
fd = open("_info.new", O_WRONLY|O_CREAT|O_EXCL, 0666);
if (fd < 0 || !(new = fdopen(fd, "w")))
err(1, "Creating _info.new to insert documentation");
if (fprintf(new,
"/**\n"
" * %s - [[ONE LINE DESCRIPTION HERE]]\n"
" *\n"
" * Paragraphs why %s exists and where to use it.\n"
" *\n"
" * Followed by an Example: section with a standalone\n"
" * (trivial and usually useless) program\n"
" */\n", m->modname, m->basename) < 0) {
unlink_noerr("_info.new");
err(1, "Writing to _info.new to insert documentation");
}
oldcontents = grab_file(m, m->info_file->fullname);
if (!oldcontents) {
unlink_noerr("_info.new");
err(1, "Reading %s", m->info_file->fullname);
}
if (fprintf(new, "%s", oldcontents) < 0) {
unlink_noerr("_info.new");
err(1, "Appending _info to _info.new");
}
if (fclose(new) != 0) {
unlink_noerr("_info.new");
err(1, "Closing _info.new");
}
if (!move_file("_info.new", m->info_file->fullname)) {
unlink_noerr("_info.new");
err(1, "Renaming _info.new to %s", m->info_file->fullname);
}
}
static void check_info_documentation_exists(struct manifest *m,
unsigned int *timeleft,
struct score *score)
{
struct list_head *infodocs = get_ccan_file_docs(m->info_file);
struct doc_section *d;
bool summary = false, description = false;
/* We don't fail ccanlint for this. */
score->pass = true;
list_for_each(infodocs, d, list) {
if (!streq(d->function, m->modname))
continue;
if (streq(d->type, "summary"))
summary = true;
if (streq(d->type, "description"))
description = true;
}
if (summary && description) {
score->score = score->total;
} else if (!summary) {
score->error = tal_strdup(score,
"_info file has no module documentation.\n\n"
"CCAN modules use /**-style comments for documentation: the\n"
"overall documentation belongs in the _info metafile.\n");
info_documentation_exists.handle = create_info_template_doc;
} else if (!description) {
score->error = tal_strdup(score,
"_info file has no module description.\n\n"
"The lines after the first summary line in the _info file\n"
"documentation should describe the purpose and use of the\n"
"overall package\n");
}
}
REGISTER_TEST(info_documentation_exists);
|
