summaryrefslogtreecommitdiffstats
path: root/scripts/docproc.c
Commit message (Collapse)AuthorAgeFilesLines
* docproc: print a comment about autogeneration for rst outputJani Nikula2016-05-141-0/+7
| | | | | | | Leave a hint to folks which file to edit instead. Signed-off-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docproc: add support for reStructuredText format via --rst optionJani Nikula2016-05-141-10/+80
| | | | | | | | | | | | | | Expect reStructuredText input and have kernel-doc produce reStructuredText output with the new --rst option. Also add --docbook option for completeness. If no option is given, default to reStructuredText if the input file has ".rst" extension, DocBook otherwise. Directives for reStructuredText use .. ! instead of just !, to make them reStructuredText comments. Signed-off-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docproc: abstract terminating lines at first spaceJani Nikula2016-05-141-13/+21
| | | | | | | | Cleaner code. Also fixes a bug when F or P directives didn't in fact have space. Signed-off-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docproc: abstract docproc directive detectionJani Nikula2016-05-141-10/+20
| | | | | | | Helps follow-up work. No functional changes. Signed-off-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docproc: reduce unnecessary indentationJani Nikula2016-05-141-46/+47
| | | | | | | Improves clarity. No functional changes. Signed-off-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docproc: add variables for subcommand and filenameJani Nikula2016-05-141-6/+11
| | | | | | | Improves clarity. No functional changes. Signed-off-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* kbuild: trivial - use tabs for code indent where possibleMasahiro Yamada2014-06-101-28/+28
| | | | | Signed-off-by: Masahiro Yamada <yamada.m@jp.panasonic.com> Signed-off-by: Michal Marek <mmarek@suse.cz>
* kernel-doc: improve "no structured comments found" errorJohannes Berg2013-11-131-5/+9
| | | | | | | | | | | | | | | | | | | When using '!Ffile function' in a docbook template, and the function no longer exists, you get a "no structured comments found" error from the kernel-doc processing script. It's useful to know which functions it was looking for, so print them out in this case. Also do the same for '!Pfile doc-section' The same error also happens when using '!Efile' when some exported functions aren't documented (in the same file.) There's a very large number of such functions though, so don't print the message in this case -- right now it would give ~850 messages. Signed-off-by: Johannes Berg <johannes.berg@intel.com> Cc: Rob Landley <rob@landley.net> Cc: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* docproc: cleanup brace placementJesper Juhl2011-06-161-12/+5
| | | | | | | | | | | The placement of the opening brace "{" after 'if' statements in scripts/docproc.c is inconsistent. Most are placed on the same line as the 'if' statement itself as per CodingStyle, but a few are not. This patch cleans up the inconsistency. We save a few source lines and the file then uses the same style throughout, which is nice. Signed-off-by: Jesper Juhl <jj@chaosbits.net> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
* kbuild: move scripts/basic/docproc.c to scripts/docproc.cPeter Foley2011-05-021-0/+583
Move docproc from scripts/basic to scripts so it is only built for *doc targets instead of every time the kernel is built.
OpenPOWER on IntegriCloud