On Thu, 02 Jun 2016, Daniel Vetter <daniel.vetter@xxxxxxxx> wrote:
> Further up in the state machinery we switch from STATE_NAME to
> STATE_DOCBLOCK when we match /$doc_block/. Which means this
> block of code here is entirely unreachable.
>
> Nuke it.
kernel-doc currently supports multiple DOC: lines in a single kernel-doc
comment, and this breaks it. This:
/**
* DOC: foo
*
* Foo
*
* DOC: bar
*
* Bar
*/
currently turns into sections foo and bar, with this patch this becomes
one section "foo", with literal "DOC: bar" in the content as normal
text.
I don't know if we actually have that kind of comments anywhere, but
since this change doesn't really help you all that much with the
follow-up, I'd just drop it.
BR,
Jani.
>
> Cc: Jani Nikula <jani.nikula@xxxxxxxxx>
> Cc: linux-doc@xxxxxxxxxxxxxxx
> Cc: Jonathan Corbet <corbet@xxxxxxx>
> Signed-off-by: Daniel Vetter <daniel.vetter@xxxxxxxx>
> ---
> scripts/kernel-doc | 19 +------------------
> 1 file changed, 1 insertion(+), 18 deletions(-)
>
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index 0eb2e7b5bf10..9fb26d142a56 100755
> --- a/scripts/kernel-doc
> +++ b/scripts/kernel-doc
> @@ -2942,24 +2942,7 @@ sub process_file($) {
> process_state3_type($_, $file);
> }
> } elsif ($state == STATE_DOCBLOCK) {
> - # Documentation block
> - if (/$doc_block/) {
> - dump_doc_section($file, $section, xml_escape($contents));
> - $contents = "";
> - $function = "";
> - %parameterdescs = ();
> - %parametertypes = ();
> - @parameterlist = ();
> - %sections = ();
> - @sectionlist = ();
> - $prototype = "";
> - if ( $1 eq "" ) {
> - $section = $section_intro;
> - } else {
> - $section = $1;
> - }
> - }
> - elsif (/$doc_end/)
> + if (/$doc_end/)
> {
> dump_doc_section($file, $section, xml_escape($contents));
> $section = $section_default;
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
