]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/commit - scripts/kernel-doc
kernel-doc parser mishandles declarations split into lines
authorMarkus Heiser <markus.heiser@darmarit.de>
Fri, 16 Jun 2017 19:27:48 +0000 (21:27 +0200)
committerJonathan Corbet <corbet@lwn.net>
Wed, 30 Aug 2017 22:18:16 +0000 (16:18 -0600)
commit463a0fdc3e800c04ec62b31627909baf4611716a
tree8468d43c66b814ad07df16400b779edc1da36c77
parent33c2f4ec984d8a78f15b9d989968733606512bb2
kernel-doc parser mishandles declarations split into lines

Reported by Johannes Berg [1].  Problem here: function
process_proto_type() concatenates the striped lines of declaration
without any whitespace. A one-liner of::

 struct something {
       struct foo
       bar;
       };

has to be::

 struct something {struct foo bar;};

Without the patching process_proto_type(), the result missed the space
between 'foo' and 'bar'::

 struct something {struct foobar;};

Bugfix of process_proto_type() brings next error when blank lines
between enum declaration::

 warning: Enum value ' ' not described in enum 'foo'

Problem here: dump_enum() does not strip leading whitespaces from
the concatenated string (with the new additional space from
process_proto_type).

[1] https://www.mail-archive.com/linux-doc@vger.kernel.org/msg12410.html

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
scripts/kernel-doc