[PATCH] Convert Documentation/DocBook to XML

[Martin Waitz]

hoi :)

I wanted to experiment with different docbook processors to speed up
documentation generation.  Well, I haven't found a better way yet but
as a side-effect I now have a patch that moves all DocBook templates
to valid XML DocBook.

Please do a

	bk pull bk://tali.bkbits.net/linux-doc

This will update the following files:

 Documentation/DocBook/Makefile                |   77 +--
 Documentation/DocBook/deviceiobook.tmpl       |    4 
 Documentation/DocBook/gadget.tmpl             |    5 
 Documentation/DocBook/journal-api.tmpl        |    5 
 Documentation/DocBook/kernel-api.tmpl         |    6 
 Documentation/DocBook/kernel-hacking.tmpl     |    4 
 Documentation/DocBook/kernel-locking.tmpl     |  240 +++++------
 Documentation/DocBook/libata.tmpl             |    4 
 Documentation/DocBook/librs.tmpl              |    6 
 Documentation/DocBook/lsm.tmpl                |   11 
 Documentation/DocBook/mcabook.tmpl            |    4 
 Documentation/DocBook/mtdnand.tmpl            |   14 
 Documentation/DocBook/procfs-guide.tmpl       |   27 -
 Documentation/DocBook/scsidrivers.tmpl        |    5 
 Documentation/DocBook/sis900.tmpl             |  556 +++++++++++++-------------
 Documentation/DocBook/tulip-user.tmpl         |    8 
 Documentation/DocBook/usb.tmpl                |    5 
 Documentation/DocBook/via-audio.tmpl          |    6 
 Documentation/DocBook/videobook.tmpl          |  206 ++++-----
 Documentation/DocBook/wanbook.tmpl            |    4 
 Documentation/DocBook/writing_usb_driver.tmpl |    4 
 Documentation/DocBook/z8530book.tmpl          |    4 
 drivers/block/ll_rw_blk.c                     |    3 
 drivers/net/8390.c                            |    1 
 drivers/usb/core/hcd.c                        |    2 
 drivers/usb/core/hub.c                        |    2 
 drivers/video/fbmem.c                         |   13 
 fs/jbd/journal.c                              |   19 
 fs/jbd/transaction.c                          |    3 
 fs/super.c                                    |    2 
 include/linux/jbd.h                           |    5 
 include/linux/kernel.h                        |   12 
 include/linux/skbuff.h                        |    2 
 include/linux/wait.h                          |   60 ++
 kernel/sysctl.c                               |    7 
 net/core/skbuff.c                             |    5 
 scripts/kernel-doc                            |   52 +-
 37 files changed, 770 insertions(+), 623 deletions(-)

through these ChangeSets:

<tali@xxxxxxxxxxxxxx> (05/02/09 1.2037)
   DocBook: fix XML in templates
   
   Signed-off-by: Martin Waitz <tali@xxxxxxxxxxxxxx>

<tali@xxxxxxxxxxxxxx> (05/02/08 1.2036)
   DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile
   
   Signed-off-by: Martin Waitz <tali@xxxxxxxxxxxxxx>

<tali@xxxxxxxxxxxxxx> (05/02/08 1.2035)
   DocBook: move kernel-doc comment next to function
   
   Signed-off-by: Martin Waitz <tali@xxxxxxxxxxxxxx>

<tali@xxxxxxxxxxxxxx> (05/02/08 1.2034)
   DocBook: s/sgml/xml/ in scripts/kernel-doc
   
   Signed-off-by: Martin Waitz <tali@xxxxxxxxxxxxxx>

<tali@xxxxxxxxxxxxxx> (05/02/08 1.2033)
   DocBook: convert template files to XML
   
   Signed-off-by: Martin Waitz <tali@xxxxxxxxxxxxxx>

<tali@xxxxxxxxxxxxxx> (05/01/26 1.2032)
   DocBook: new kernel-doc comments for might_sleep & wait_event_*
   
   Signed-off-by: Martin Waitz <tali@xxxxxxxxxxxxxx>

<tali@xxxxxxxxxxxxxx> (05/01/26 1.2031)
   DocBook: fix function parameter descriptin in fbmem
   
   Signed-off-by: Martin Waitz <tali@xxxxxxxxxxxxxx>

<tali@xxxxxxxxxxxxxx> (05/01/26 1.2030)
   DocBook: update function parameter description in USB code
   
   Signed-off-by: Martin Waitz <tali@xxxxxxxxxxxxxx>

<tali@xxxxxxxxxxxxxx> (05/01/26 1.2029)
   DocBook: update function parameter description in block/fs code
   
   Signed-off-by: Martin Waitz <tali@xxxxxxxxxxxxxx>

<tali@xxxxxxxxxxxxxx> (05/01/26 1.2028)
   DocBook: update function parameter description in network code
   
   Signed-off-by: Martin Waitz <tali@xxxxxxxxxxxxxx>

<tali@xxxxxxxxxxxxxx> (05/01/26 1.2027)
   DocBook: allow preprocessor directives between kernel-doc and function
   
   Signed-off-by: Martin Waitz <tali@xxxxxxxxxxxxxx>

<tali@xxxxxxxxxxxxxx> (05/01/26 1.2026)
   DocBook: remove reference to drivers/net/net_init.c
   
   This file has been removed and is breaking documentation generation.
   
   Signed-off-by: Martin Waitz <tali@xxxxxxxxxxxxxx>

-- 
Martin Waitz

Attachment: signature.asc
Description: Digital signature