linux/Documentation/DocBook
Ben Hutchings b44158b170 DocBook: Avoid building man pages repeatedly and inconsistently
Some kernel-doc sections are included in multiple DocBook files.  This
means the mandocs target will generate the same manual page multiple
times with different metadata (author name/address and manual title,
taken from the including DocBook file).  If it's invoked in a parallel
build, the output is nondeterminstic.

For each section that is duplicated, mark the less specific manual's
inclusion as 'extra' and exclude it during conversion to manual pages.
Use xmlif for this, as that is bundled with xmlto which we already
use.

I would have preferred to use more conventional markup for this, but
each of the following approaches failed:

1. Wrap the extra inclusions with a new element and add a template to
   the stylesheet to include/exclude them.  Unfortunately DocBook XSL
   doesn't seem to support foreign elements at an intermediate level
   in the document tree.
2. Use DocBook profiling.  This works but requires passing an absolute
   path to the profile stylesheet to xmlto, so it's not portable.
3. Use SGML marked sections.  docbook2x can handle these but xmlto
   chokes on them.

Reported-by: Jérémy Bobbio <lunar@debian.org>
Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-07-10 11:03:21 -06:00
..
media [media] DocBook: Change format for enum dmx_output documentation 2015-06-09 17:47:38 -03:00
.gitignore
80211.tmpl wireless: docs: fix 'make pdfdocs' failure 2015-01-28 08:53:58 +01:00
alsa-driver-api.tmpl ALSA: doc: Fix missing "I" for kerneldoc inclusion 2014-10-30 15:42:33 +01:00
crypto-API.tmpl crypto: doc - Fix typo in crypto-API.tmpl 2015-06-04 15:05:05 +08:00
debugobjects.tmpl
device-drivers.tmpl DocBook: Avoid building man pages repeatedly and inconsistently 2015-07-10 11:03:21 -06:00
deviceiobook.tmpl
drm.tmpl Documentation/drm: Update rotation property 2015-06-15 07:37:15 +02:00
filesystems.tmpl
gadget.tmpl DocBook: Avoid building man pages repeatedly and inconsistently 2015-07-10 11:03:21 -06:00
genericirq.tmpl
kernel-api.tmpl DocBook: Avoid building man pages repeatedly and inconsistently 2015-07-10 11:03:21 -06:00
kernel-hacking.tmpl Documentation: extend use case for EXPORT_SYMBOL_GPL() 2015-06-05 07:39:46 +09:00
kernel-locking.tmpl locking/Documentation: Move locking related docs into Documentation/locking/ 2014-08-13 10:32:03 +02:00
kgdb.tmpl KGDB/KDB New: 2015-02-20 15:13:29 -08:00
libata.tmpl
librs.tmpl
lsm.tmpl
Makefile DocBook: Avoid building man pages repeatedly and inconsistently 2015-07-10 11:03:21 -06:00
media_api.tmpl [media] Docbook: typo fix: use note(d) instead of notice(d) 2015-06-08 14:56:20 -03:00
mtdnand.tmpl
networking.tmpl
rapidio.tmpl
regulator.tmpl
s390-drivers.tmpl
scsi.tmpl Doc: Docbook: Change wikipedia's URL from http to https in scsi.tmpl 2015-06-22 10:29:32 -06:00
sh.tmpl
stylesheet.xsl DocBook: Generate consistent IDs 2015-07-10 11:03:16 -06:00
tracepoint.tmpl
uio-howto.tmpl pdfdocs: Fix 'make pdfdocs' failure for 'uio-howto.tmpl' 2015-02-03 15:48:51 -08:00
usb.tmpl usb: hub: rename khubd to hub_wq in documentation and comments 2014-09-23 22:33:19 -07:00
w1.tmpl
writing-an-alsa-driver.tmpl ALSA: doc: Recommend the use of snd_ctl_elem_info() 2014-10-20 18:06:04 +02:00
writing_musb_glue_layer.tmpl
writing_usb_driver.tmpl
z8530book.tmpl