aboutsummaryrefslogtreecommitdiff
path: root/scripts/kernel-doc-xml-ref
AgeCommit message (Collapse)AuthorFilesLines
2015-08-16scripts/kernel-doc: Adding cross-reference links to html documentation.Danilo Cesar Lemes de Paula1-0/+198
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 <[email protected]> Cc: Randy Dunlap <[email protected]> Cc: Daniel Vetter <[email protected]> Cc: Laurent Pinchart <[email protected]> Cc: Herbert Xu <[email protected]> Cc: Stephan Mueller <[email protected]> Cc: Michal Marek <[email protected]> Cc: intel-gfx <[email protected]> Cc: dri-devel <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>