diff options
author | Danilo Cesar Lemes de Paula <danilo.cesar@collabora.co.uk> | 2015-07-28 19:45:15 (GMT) |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2015-08-17 04:11:16 (GMT) |
commit | 5699f871d2d51ce40012501378670613d4d49214 (patch) | |
tree | b35b519696abf5a24c3ee4de623e0851607103c5 /scripts/kernel-doc | |
parent | 9ed71e7ad95eb9885420e8d33f33bd4d49e1b775 (diff) | |
download | linux-5699f871d2d51ce40012501378670613d4d49214.tar.xz |
scripts/kernel-doc: Adding cross-reference links to html documentation.
Functions, Structs and Parameters definitions on kernel documentation
are pure cosmetic, it only highlights the element.
To ease the navigation in the documentation we should use <links> inside
those tags so readers can easily jump between methods directly.
This was discussed in 2014[1] and is implemented by getting a list
of <refentries> from the DocBook XML to generate a database. Then it looks
for <function>,<structnames> and <paramdef> tags that matches the ones in
the database. As it only links existent references, no broken links are
added.
[1] - lists.freedesktop.org/archives/dri-devel/2014-August/065404.html
Signed-off-by: Danilo Cesar Lemes de Paula <danilo.cesar@collabora.co.uk>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: Stephan Mueller <smueller@chronox.de>
Cc: Michal Marek <mmarek@suse.cz>
Cc: intel-gfx <intel-gfx@lists.freedesktop.org>
Cc: dri-devel <dri-devel@lists.freedesktop.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'scripts/kernel-doc')
0 files changed, 0 insertions, 0 deletions