kernel/linux.git/scripts/basic/docproc.c, branch v6.19.11

kbuild: move scripts/basic/docproc.c to scripts/docproc.c

2011-05-02T20:48:03+00:00

Move docproc from scripts/basic to scripts so it is only built for *doc targets instead of every time the kernel is built.

kbuild: check return value of asprintf()

2010-10-27T22:17:16+00:00

Check return value of asprintf() in docsect() and exit if error occurs. This removes following warning: HOSTCC scripts/basic/docproc scripts/basic/docproc.c: In function ‘docsect’: scripts/basic/docproc.c:336: warning: ignoring return value of ‘asprintf’, declared with attribute warn_unused_result Signed-off-by: Namhyung Kim Acked-by: Randy Dunlap Signed-off-by: Michal Marek

docbook: warn on unused doc entries

2010-09-11T23:49:21+00:00

When you don't use !E or !I but only !F, then it's very easy to miss including some functions, structs etc. in documentation. To help finding which ones were missed, allow printing out the unused ones as warnings. For example, using this on mac80211 yields a lot of warnings like this: Warning: didn't use docs for DOC: mac80211 workqueue Warning: didn't use docs for ieee80211_max_queues Warning: didn't use docs for ieee80211_bss_change Warning: didn't use docs for ieee80211_bss_conf when generating the documentation for it. Signed-off-by: Johannes Berg Signed-off-by: Randy Dunlap Signed-off-by: Linus Torvalds

kbuild: add static to prototypes

2009-09-20T10:27:44+00:00

Warnings found via gcc -Wmissing-prototypes. Signed-off-by: Trevor Keith Acked-by: WANG Cong Signed-off-by: Andrew Morton Signed-off-by: Sam Ravnborg

kbuild: fix build error during make htmldocs

2009-06-20T11:31:28+00:00

Fix the following build error when do 'make htmldocs': DOCPROC Documentation/DocBook/debugobjects.xml exec /scripts/kernel-doc: No such file or directory exec /scripts/kernel-doc: No such file or directory Reported-by: Randy Dunlap Signed-off-by: WANG Cong Acked-by: Randy Dunlap Signed-off-by: Sam Ravnborg

kbuild: allow docproc invocation from external

2009-06-09T20:37:44+00:00

- getcwd returns path without a slash at the end, add the slash - add KBUILD_SRC env support, so that we can specify path for kernel (to know where scripts/kernel-doc resides) and SRCTREE (for searching files referenced in .tmpl) separately [v2] - use KBUILD_SRC instead of a newly introduced environment variable Signed-off-by: Jiri Slaby Acked-by: Randy Dunlap Signed-off-by: Sam Ravnborg

kernel-doc: new P directive for DOC: sections

2008-01-28T22:14:35+00:00

The !P directive includes the contents of a DOC: section given by title, e.g. !Pfilename Title of the section Signed-off-by: Johannes Berg Signed-off-by: Randy Dunlap Signed-off-by: Sam Ravnborg

kernel-doc: use no-doc option

2008-01-28T22:14:35+00:00

When asked by a template to include all functions from a file, it will also include DOC: sections wreaking havoc in the generated docbook file. This patch makes it use the new -no-doc-sections flag for kernel-doc to avoid this. Signed-off-by: Johannes Berg Signed-off-by: Randy Dunlap Signed-off-by: Sam Ravnborg

kbuild: stop docproc segfaulting when SRCTREE isn't set.

2007-10-18T11:42:53+00:00

Prevent docproc from segfaulting when SRCTREE isn't set. Signed-off-by: Rob Landley Acked-by: Randy Dunlap Signed-off-by: Sam Ravnborg

docproc: style & typo cleanups

2007-10-12T19:15:31+00:00

- fix typos/spellos in docproc.c and Makefile - add a little whitespace {while, switch} (coding style) - use NULL instead of 0 for pointer testing Signed-off-by: Randy Dunlap Signed-off-by: Sam Ravnborg