]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/commit - scripts/kernel-doc
scripts/kernel-doc: Replacing highlights hash by an array
authorDanilo Cesar Lemes de Paula <danilo.cesar@collabora.co.uk>
Mon, 7 Sep 2015 20:01:59 +0000 (17:01 -0300)
committerJonathan Corbet <corbet@lwn.net>
Sun, 13 Sep 2015 20:38:51 +0000 (14:38 -0600)
commit4d73270192ec8238135d9fb65b49f6f42f50818d
tree14c83716bac9b796a1629ac5d51b80ab9b786ab8
parent17666497fe631fef483afd38824c5dabdd764b90
scripts/kernel-doc: Replacing highlights hash by an array

The "highlight" code is very sensible to the order of the hash keys,
but the order of the keys cannot be predicted. It generates
faulty DocBook entries like:
- @<function>device_for_each_child</function>

Sorting the result is not enough some times (as it's deterministic but
we can't control it).
We should use an array for that job, so we can guarantee that the order
of the regex execution on dohighlight is correct.

[jc: I think this is kind of papering around the real problem, that people
 are saying @function() when "function" is not a parameter.  But this makes
 things better than they were before, so...]

Signed-off-by: Danilo Cesar Lemes de Paula <danilo.cesar@collabora.co.uk>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
scripts/kernel-doc