diff options
author | Paul Mundt <lethal@linux-sh.org> | 2011-01-13 01:06:28 -0500 |
---|---|---|
committer | Paul Mundt <lethal@linux-sh.org> | 2011-01-13 01:06:28 -0500 |
commit | f43dc23d5ea91fca257be02138a255f02d98e806 (patch) | |
tree | b29722f6e965316e90ac97abf79923ced250dc21 /scripts/basic/docproc.c | |
parent | f8e53553f452dcbf67cb89c8cba63a1cd6eb4cc0 (diff) | |
parent | 4162cf64973df51fc885825bc9ca4d055891c49f (diff) |
Merge branch 'master' of master.kernel.org:/pub/scm/linux/kernel/git/torvalds/linux-2.6 into common/serial-rework
Conflicts:
arch/sh/kernel/cpu/sh2/setup-sh7619.c
arch/sh/kernel/cpu/sh2a/setup-mxg.c
arch/sh/kernel/cpu/sh2a/setup-sh7201.c
arch/sh/kernel/cpu/sh2a/setup-sh7203.c
arch/sh/kernel/cpu/sh2a/setup-sh7206.c
arch/sh/kernel/cpu/sh3/setup-sh7705.c
arch/sh/kernel/cpu/sh3/setup-sh770x.c
arch/sh/kernel/cpu/sh3/setup-sh7710.c
arch/sh/kernel/cpu/sh3/setup-sh7720.c
arch/sh/kernel/cpu/sh4/setup-sh4-202.c
arch/sh/kernel/cpu/sh4/setup-sh7750.c
arch/sh/kernel/cpu/sh4/setup-sh7760.c
arch/sh/kernel/cpu/sh4a/setup-sh7343.c
arch/sh/kernel/cpu/sh4a/setup-sh7366.c
arch/sh/kernel/cpu/sh4a/setup-sh7722.c
arch/sh/kernel/cpu/sh4a/setup-sh7723.c
arch/sh/kernel/cpu/sh4a/setup-sh7724.c
arch/sh/kernel/cpu/sh4a/setup-sh7763.c
arch/sh/kernel/cpu/sh4a/setup-sh7770.c
arch/sh/kernel/cpu/sh4a/setup-sh7780.c
arch/sh/kernel/cpu/sh4a/setup-sh7785.c
arch/sh/kernel/cpu/sh4a/setup-sh7786.c
arch/sh/kernel/cpu/sh4a/setup-shx3.c
arch/sh/kernel/cpu/sh5/setup-sh5.c
drivers/serial/sh-sci.c
drivers/serial/sh-sci.h
include/linux/serial_sci.h
Diffstat (limited to 'scripts/basic/docproc.c')
-rw-r--r-- | scripts/basic/docproc.c | 166 |
1 files changed, 148 insertions, 18 deletions
diff --git a/scripts/basic/docproc.c b/scripts/basic/docproc.c index 99ca7a698687..98dec87974d0 100644 --- a/scripts/basic/docproc.c +++ b/scripts/basic/docproc.c | |||
@@ -34,12 +34,14 @@ | |||
34 | * | 34 | * |
35 | */ | 35 | */ |
36 | 36 | ||
37 | #define _GNU_SOURCE | ||
37 | #include <stdio.h> | 38 | #include <stdio.h> |
38 | #include <stdlib.h> | 39 | #include <stdlib.h> |
39 | #include <string.h> | 40 | #include <string.h> |
40 | #include <ctype.h> | 41 | #include <ctype.h> |
41 | #include <unistd.h> | 42 | #include <unistd.h> |
42 | #include <limits.h> | 43 | #include <limits.h> |
44 | #include <errno.h> | ||
43 | #include <sys/types.h> | 45 | #include <sys/types.h> |
44 | #include <sys/wait.h> | 46 | #include <sys/wait.h> |
45 | 47 | ||
@@ -54,6 +56,7 @@ typedef void FILEONLY(char * file); | |||
54 | FILEONLY *internalfunctions; | 56 | FILEONLY *internalfunctions; |
55 | FILEONLY *externalfunctions; | 57 | FILEONLY *externalfunctions; |
56 | FILEONLY *symbolsonly; | 58 | FILEONLY *symbolsonly; |
59 | FILEONLY *findall; | ||
57 | 60 | ||
58 | typedef void FILELINE(char * file, char * line); | 61 | typedef void FILELINE(char * file, char * line); |
59 | FILELINE * singlefunctions; | 62 | FILELINE * singlefunctions; |
@@ -65,13 +68,31 @@ FILELINE * docsection; | |||
65 | #define KERNELDOCPATH "scripts/" | 68 | #define KERNELDOCPATH "scripts/" |
66 | #define KERNELDOC "kernel-doc" | 69 | #define KERNELDOC "kernel-doc" |
67 | #define DOCBOOK "-docbook" | 70 | #define DOCBOOK "-docbook" |
71 | #define LIST "-list" | ||
68 | #define FUNCTION "-function" | 72 | #define FUNCTION "-function" |
69 | #define NOFUNCTION "-nofunction" | 73 | #define NOFUNCTION "-nofunction" |
70 | #define NODOCSECTIONS "-no-doc-sections" | 74 | #define NODOCSECTIONS "-no-doc-sections" |
71 | 75 | ||
72 | static char *srctree, *kernsrctree; | 76 | static char *srctree, *kernsrctree; |
73 | 77 | ||
74 | void usage (void) | 78 | static char **all_list = NULL; |
79 | static int all_list_len = 0; | ||
80 | |||
81 | static void consume_symbol(const char *sym) | ||
82 | { | ||
83 | int i; | ||
84 | |||
85 | for (i = 0; i < all_list_len; i++) { | ||
86 | if (!all_list[i]) | ||
87 | continue; | ||
88 | if (strcmp(sym, all_list[i])) | ||
89 | continue; | ||
90 | all_list[i] = NULL; | ||
91 | break; | ||
92 | } | ||
93 | } | ||
94 | |||
95 | static void usage (void) | ||
75 | { | 96 | { |
76 | fprintf(stderr, "Usage: docproc {doc|depend} file\n"); | 97 | fprintf(stderr, "Usage: docproc {doc|depend} file\n"); |
77 | fprintf(stderr, "Input is read from file.tmpl. Output is sent to stdout\n"); | 98 | fprintf(stderr, "Input is read from file.tmpl. Output is sent to stdout\n"); |
@@ -84,7 +105,7 @@ void usage (void) | |||
84 | /* | 105 | /* |
85 | * Execute kernel-doc with parameters given in svec | 106 | * Execute kernel-doc with parameters given in svec |
86 | */ | 107 | */ |
87 | void exec_kernel_doc(char **svec) | 108 | static void exec_kernel_doc(char **svec) |
88 | { | 109 | { |
89 | pid_t pid; | 110 | pid_t pid; |
90 | int ret; | 111 | int ret; |
@@ -129,7 +150,7 @@ struct symfile | |||
129 | struct symfile symfilelist[MAXFILES]; | 150 | struct symfile symfilelist[MAXFILES]; |
130 | int symfilecnt = 0; | 151 | int symfilecnt = 0; |
131 | 152 | ||
132 | void add_new_symbol(struct symfile *sym, char * symname) | 153 | static void add_new_symbol(struct symfile *sym, char * symname) |
133 | { | 154 | { |
134 | sym->symbollist = | 155 | sym->symbollist = |
135 | realloc(sym->symbollist, (sym->symbolcnt + 1) * sizeof(char *)); | 156 | realloc(sym->symbollist, (sym->symbolcnt + 1) * sizeof(char *)); |
@@ -137,14 +158,14 @@ void add_new_symbol(struct symfile *sym, char * symname) | |||
137 | } | 158 | } |
138 | 159 | ||
139 | /* Add a filename to the list */ | 160 | /* Add a filename to the list */ |
140 | struct symfile * add_new_file(char * filename) | 161 | static struct symfile * add_new_file(char * filename) |
141 | { | 162 | { |
142 | symfilelist[symfilecnt++].filename = strdup(filename); | 163 | symfilelist[symfilecnt++].filename = strdup(filename); |
143 | return &symfilelist[symfilecnt - 1]; | 164 | return &symfilelist[symfilecnt - 1]; |
144 | } | 165 | } |
145 | 166 | ||
146 | /* Check if file already are present in the list */ | 167 | /* Check if file already are present in the list */ |
147 | struct symfile * filename_exist(char * filename) | 168 | static struct symfile * filename_exist(char * filename) |
148 | { | 169 | { |
149 | int i; | 170 | int i; |
150 | for (i=0; i < symfilecnt; i++) | 171 | for (i=0; i < symfilecnt; i++) |
@@ -157,20 +178,20 @@ struct symfile * filename_exist(char * filename) | |||
157 | * List all files referenced within the template file. | 178 | * List all files referenced within the template file. |
158 | * Files are separated by tabs. | 179 | * Files are separated by tabs. |
159 | */ | 180 | */ |
160 | void adddep(char * file) { printf("\t%s", file); } | 181 | static void adddep(char * file) { printf("\t%s", file); } |
161 | void adddep2(char * file, char * line) { line = line; adddep(file); } | 182 | static void adddep2(char * file, char * line) { line = line; adddep(file); } |
162 | void noaction(char * line) { line = line; } | 183 | static void noaction(char * line) { line = line; } |
163 | void noaction2(char * file, char * line) { file = file; line = line; } | 184 | static void noaction2(char * file, char * line) { file = file; line = line; } |
164 | 185 | ||
165 | /* Echo the line without further action */ | 186 | /* Echo the line without further action */ |
166 | void printline(char * line) { printf("%s", line); } | 187 | static void printline(char * line) { printf("%s", line); } |
167 | 188 | ||
168 | /* | 189 | /* |
169 | * Find all symbols in filename that are exported with EXPORT_SYMBOL & | 190 | * Find all symbols in filename that are exported with EXPORT_SYMBOL & |
170 | * EXPORT_SYMBOL_GPL (& EXPORT_SYMBOL_GPL_FUTURE implicitly). | 191 | * EXPORT_SYMBOL_GPL (& EXPORT_SYMBOL_GPL_FUTURE implicitly). |
171 | * All symbols located are stored in symfilelist. | 192 | * All symbols located are stored in symfilelist. |
172 | */ | 193 | */ |
173 | void find_export_symbols(char * filename) | 194 | static void find_export_symbols(char * filename) |
174 | { | 195 | { |
175 | FILE * fp; | 196 | FILE * fp; |
176 | struct symfile *sym; | 197 | struct symfile *sym; |
@@ -227,7 +248,7 @@ void find_export_symbols(char * filename) | |||
227 | * intfunc uses -nofunction | 248 | * intfunc uses -nofunction |
228 | * extfunc uses -function | 249 | * extfunc uses -function |
229 | */ | 250 | */ |
230 | void docfunctions(char * filename, char * type) | 251 | static void docfunctions(char * filename, char * type) |
231 | { | 252 | { |
232 | int i,j; | 253 | int i,j; |
233 | int symcnt = 0; | 254 | int symcnt = 0; |
@@ -248,6 +269,7 @@ void docfunctions(char * filename, char * type) | |||
248 | struct symfile * sym = &symfilelist[i]; | 269 | struct symfile * sym = &symfilelist[i]; |
249 | for (j=0; j < sym->symbolcnt; j++) { | 270 | for (j=0; j < sym->symbolcnt; j++) { |
250 | vec[idx++] = type; | 271 | vec[idx++] = type; |
272 | consume_symbol(sym->symbollist[j].name); | ||
251 | vec[idx++] = sym->symbollist[j].name; | 273 | vec[idx++] = sym->symbollist[j].name; |
252 | } | 274 | } |
253 | } | 275 | } |
@@ -258,15 +280,15 @@ void docfunctions(char * filename, char * type) | |||
258 | fflush(stdout); | 280 | fflush(stdout); |
259 | free(vec); | 281 | free(vec); |
260 | } | 282 | } |
261 | void intfunc(char * filename) { docfunctions(filename, NOFUNCTION); } | 283 | static void intfunc(char * filename) { docfunctions(filename, NOFUNCTION); } |
262 | void extfunc(char * filename) { docfunctions(filename, FUNCTION); } | 284 | static void extfunc(char * filename) { docfunctions(filename, FUNCTION); } |
263 | 285 | ||
264 | /* | 286 | /* |
265 | * Document specific function(s) in a file. | 287 | * Document specific function(s) in a file. |
266 | * Call kernel-doc with the following parameters: | 288 | * Call kernel-doc with the following parameters: |
267 | * kernel-doc -docbook -function function1 [-function function2] | 289 | * kernel-doc -docbook -function function1 [-function function2] |
268 | */ | 290 | */ |
269 | void singfunc(char * filename, char * line) | 291 | static void singfunc(char * filename, char * line) |
270 | { | 292 | { |
271 | char *vec[200]; /* Enough for specific functions */ | 293 | char *vec[200]; /* Enough for specific functions */ |
272 | int i, idx = 0; | 294 | int i, idx = 0; |
@@ -287,6 +309,11 @@ void singfunc(char * filename, char * line) | |||
287 | vec[idx++] = &line[i]; | 309 | vec[idx++] = &line[i]; |
288 | } | 310 | } |
289 | } | 311 | } |
312 | for (i = 0; i < idx; i++) { | ||
313 | if (strcmp(vec[i], FUNCTION)) | ||
314 | continue; | ||
315 | consume_symbol(vec[i + 1]); | ||
316 | } | ||
290 | vec[idx++] = filename; | 317 | vec[idx++] = filename; |
291 | vec[idx] = NULL; | 318 | vec[idx] = NULL; |
292 | exec_kernel_doc(vec); | 319 | exec_kernel_doc(vec); |
@@ -297,7 +324,7 @@ void singfunc(char * filename, char * line) | |||
297 | * Call kernel-doc with the following parameters: | 324 | * Call kernel-doc with the following parameters: |
298 | * kernel-doc -docbook -function "doc section" filename | 325 | * kernel-doc -docbook -function "doc section" filename |
299 | */ | 326 | */ |
300 | void docsect(char *filename, char *line) | 327 | static void docsect(char *filename, char *line) |
301 | { | 328 | { |
302 | char *vec[6]; /* kerneldoc -docbook -function "section" file NULL */ | 329 | char *vec[6]; /* kerneldoc -docbook -function "section" file NULL */ |
303 | char *s; | 330 | char *s; |
@@ -306,6 +333,13 @@ void docsect(char *filename, char *line) | |||
306 | if (*s == '\n') | 333 | if (*s == '\n') |
307 | *s = '\0'; | 334 | *s = '\0'; |
308 | 335 | ||
336 | if (asprintf(&s, "DOC: %s", line) < 0) { | ||
337 | perror("asprintf"); | ||
338 | exit(1); | ||
339 | } | ||
340 | consume_symbol(s); | ||
341 | free(s); | ||
342 | |||
309 | vec[0] = KERNELDOC; | 343 | vec[0] = KERNELDOC; |
310 | vec[1] = DOCBOOK; | 344 | vec[1] = DOCBOOK; |
311 | vec[2] = FUNCTION; | 345 | vec[2] = FUNCTION; |
@@ -315,6 +349,84 @@ void docsect(char *filename, char *line) | |||
315 | exec_kernel_doc(vec); | 349 | exec_kernel_doc(vec); |
316 | } | 350 | } |
317 | 351 | ||
352 | static void find_all_symbols(char *filename) | ||
353 | { | ||
354 | char *vec[4]; /* kerneldoc -list file NULL */ | ||
355 | pid_t pid; | ||
356 | int ret, i, count, start; | ||
357 | char real_filename[PATH_MAX + 1]; | ||
358 | int pipefd[2]; | ||
359 | char *data, *str; | ||
360 | size_t data_len = 0; | ||
361 | |||
362 | vec[0] = KERNELDOC; | ||
363 | vec[1] = LIST; | ||
364 | vec[2] = filename; | ||
365 | vec[3] = NULL; | ||
366 | |||
367 | if (pipe(pipefd)) { | ||
368 | perror("pipe"); | ||
369 | exit(1); | ||
370 | } | ||
371 | |||
372 | switch (pid=fork()) { | ||
373 | case -1: | ||
374 | perror("fork"); | ||
375 | exit(1); | ||
376 | case 0: | ||
377 | close(pipefd[0]); | ||
378 | dup2(pipefd[1], 1); | ||
379 | memset(real_filename, 0, sizeof(real_filename)); | ||
380 | strncat(real_filename, kernsrctree, PATH_MAX); | ||
381 | strncat(real_filename, "/" KERNELDOCPATH KERNELDOC, | ||
382 | PATH_MAX - strlen(real_filename)); | ||
383 | execvp(real_filename, vec); | ||
384 | fprintf(stderr, "exec "); | ||
385 | perror(real_filename); | ||
386 | exit(1); | ||
387 | default: | ||
388 | close(pipefd[1]); | ||
389 | data = malloc(4096); | ||
390 | do { | ||
391 | while ((ret = read(pipefd[0], | ||
392 | data + data_len, | ||
393 | 4096)) > 0) { | ||
394 | data_len += ret; | ||
395 | data = realloc(data, data_len + 4096); | ||
396 | } | ||
397 | } while (ret == -EAGAIN); | ||
398 | if (ret != 0) { | ||
399 | perror("read"); | ||
400 | exit(1); | ||
401 | } | ||
402 | waitpid(pid, &ret ,0); | ||
403 | } | ||
404 | if (WIFEXITED(ret)) | ||
405 | exitstatus |= WEXITSTATUS(ret); | ||
406 | else | ||
407 | exitstatus = 0xff; | ||
408 | |||
409 | count = 0; | ||
410 | /* poor man's strtok, but with counting */ | ||
411 | for (i = 0; i < data_len; i++) { | ||
412 | if (data[i] == '\n') { | ||
413 | count++; | ||
414 | data[i] = '\0'; | ||
415 | } | ||
416 | } | ||
417 | start = all_list_len; | ||
418 | all_list_len += count; | ||
419 | all_list = realloc(all_list, sizeof(char *) * all_list_len); | ||
420 | str = data; | ||
421 | for (i = 0; i < data_len && start != all_list_len; i++) { | ||
422 | if (data[i] == '\0') { | ||
423 | all_list[start] = str; | ||
424 | str = data + i + 1; | ||
425 | start++; | ||
426 | } | ||
427 | } | ||
428 | } | ||
429 | |||
318 | /* | 430 | /* |
319 | * Parse file, calling action specific functions for: | 431 | * Parse file, calling action specific functions for: |
320 | * 1) Lines containing !E | 432 | * 1) Lines containing !E |
@@ -322,9 +434,10 @@ void docsect(char *filename, char *line) | |||
322 | * 3) Lines containing !D | 434 | * 3) Lines containing !D |
323 | * 4) Lines containing !F | 435 | * 4) Lines containing !F |
324 | * 5) Lines containing !P | 436 | * 5) Lines containing !P |
325 | * 6) Default lines - lines not matching the above | 437 | * 6) Lines containing !C |
438 | * 7) Default lines - lines not matching the above | ||
326 | */ | 439 | */ |
327 | void parse_file(FILE *infile) | 440 | static void parse_file(FILE *infile) |
328 | { | 441 | { |
329 | char line[MAXLINESZ]; | 442 | char line[MAXLINESZ]; |
330 | char * s; | 443 | char * s; |
@@ -365,6 +478,12 @@ void parse_file(FILE *infile) | |||
365 | s++; | 478 | s++; |
366 | docsection(line + 2, s); | 479 | docsection(line + 2, s); |
367 | break; | 480 | break; |
481 | case 'C': | ||
482 | while (*s && !isspace(*s)) s++; | ||
483 | *s = '\0'; | ||
484 | if (findall) | ||
485 | findall(line+2); | ||
486 | break; | ||
368 | default: | 487 | default: |
369 | defaultline(line); | 488 | defaultline(line); |
370 | } | 489 | } |
@@ -380,6 +499,7 @@ void parse_file(FILE *infile) | |||
380 | int main(int argc, char *argv[]) | 499 | int main(int argc, char *argv[]) |
381 | { | 500 | { |
382 | FILE * infile; | 501 | FILE * infile; |
502 | int i; | ||
383 | 503 | ||
384 | srctree = getenv("SRCTREE"); | 504 | srctree = getenv("SRCTREE"); |
385 | if (!srctree) | 505 | if (!srctree) |
@@ -415,6 +535,7 @@ int main(int argc, char *argv[]) | |||
415 | symbolsonly = find_export_symbols; | 535 | symbolsonly = find_export_symbols; |
416 | singlefunctions = noaction2; | 536 | singlefunctions = noaction2; |
417 | docsection = noaction2; | 537 | docsection = noaction2; |
538 | findall = find_all_symbols; | ||
418 | parse_file(infile); | 539 | parse_file(infile); |
419 | 540 | ||
420 | /* Rewind to start from beginning of file again */ | 541 | /* Rewind to start from beginning of file again */ |
@@ -425,8 +546,16 @@ int main(int argc, char *argv[]) | |||
425 | symbolsonly = printline; | 546 | symbolsonly = printline; |
426 | singlefunctions = singfunc; | 547 | singlefunctions = singfunc; |
427 | docsection = docsect; | 548 | docsection = docsect; |
549 | findall = NULL; | ||
428 | 550 | ||
429 | parse_file(infile); | 551 | parse_file(infile); |
552 | |||
553 | for (i = 0; i < all_list_len; i++) { | ||
554 | if (!all_list[i]) | ||
555 | continue; | ||
556 | fprintf(stderr, "Warning: didn't use docs for %s\n", | ||
557 | all_list[i]); | ||
558 | } | ||
430 | } | 559 | } |
431 | else if (strcmp("depend", argv[1]) == 0) | 560 | else if (strcmp("depend", argv[1]) == 0) |
432 | { | 561 | { |
@@ -439,6 +568,7 @@ int main(int argc, char *argv[]) | |||
439 | symbolsonly = adddep; | 568 | symbolsonly = adddep; |
440 | singlefunctions = adddep2; | 569 | singlefunctions = adddep2; |
441 | docsection = adddep2; | 570 | docsection = adddep2; |
571 | findall = adddep; | ||
442 | parse_file(infile); | 572 | parse_file(infile); |
443 | printf("\n"); | 573 | printf("\n"); |
444 | } | 574 | } |