linux-toradex.git/scripts/docproc.c, branch v4.11-rc3

docproc: print a comment about autogeneration for rst output

2016-05-14T15:56:56+00:00

Leave a hint to folks which file to edit instead.

Signed-off-by: Jani Nikula 
Signed-off-by: Jonathan Corbet

docproc: add support for reStructuredText format via --rst option

2016-05-14T15:56:53+00:00

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 
Signed-off-by: Jonathan Corbet

docproc: abstract terminating lines at first space

2016-05-14T15:56:49+00:00

Cleaner code. Also fixes a bug when F or P directives didn't in fact
have space.

Signed-off-by: Jani Nikula 
Signed-off-by: Jonathan Corbet

docproc: abstract docproc directive detection

2016-05-14T15:56:45+00:00

Helps follow-up work. No functional changes.

Signed-off-by: Jani Nikula 
Signed-off-by: Jonathan Corbet

docproc: reduce unnecessary indentation

2016-05-14T15:56:41+00:00

Improves clarity. No functional changes.

Signed-off-by: Jani Nikula 
Signed-off-by: Jonathan Corbet

docproc: add variables for subcommand and filename

2016-05-14T15:56:37+00:00

Improves clarity. No functional changes.

Signed-off-by: Jani Nikula 
Signed-off-by: Jonathan Corbet

kbuild: trivial - use tabs for code indent where possible

2014-06-10T12:00:53+00:00

Signed-off-by: Masahiro Yamada 
Signed-off-by: Michal Marek

kernel-doc: improve "no structured comments found" error

2013-11-13T03:09:32+00:00

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 
Cc: Rob Landley 
Cc: Randy Dunlap 
Signed-off-by: Andrew Morton 
Signed-off-by: Linus Torvalds

docproc: cleanup brace placement

2011-06-16T18:40:03+00:00

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 
Signed-off-by: Jiri Kosina

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.