Skip to contentSkip to conversation

docbook: split kernel-api, add device-drivers book

PATCH In review Randy Dunlap 2 participants 3 messages Feb 12, 2009 – Feb 15, 2009 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docbook: split kernel-api, add device-drivers book

From: Randy Dunlap <[email protected]>

The kernel-api docbook was much larger than any of the others, so processing it took longer and needed some docbook extras in some cases, so split it into kernel-api (infrastructure etc.) and device drivers/device subsystems. This allows these docbooks to be generated in parallel. (This reduced the docbook processing time on my 4-proc system with make -j4 from about 5min:16sec to about 2min:01sec.)

The chapters that were moved from kernel-api to device-drivers are:

Driver Basics
Device drivers infrastructure
Parallel Port Devices
Message-based devices
Sound Devices
16x50 UART Driver
Frame Buffer Library
Input Subsystem
Serial Peripheral Interface (SPI)
I2C and SMBus Subsystem

---
 Documentation/DocBook/Makefile            |    2 
 Documentation/DocBook/device-drivers.tmpl |  418 ++++++++++++++++++++++++++++++
 Documentation/DocBook/kernel-api.tmpl     |  377 ---------------------------
 3 files changed, 419 insertions(+), 378 deletions(-)
Documentation/DocBook/Makefile +1 -1
@@ -6,7 +6,7 @@
 # To add a new book the only step required is to add the book to the
 # list of DOCBOOKS.
 
-DOCBOOKS := z8530book.xml mcabook.xml \
+DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \
 	    kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
 	    procfs-guide.xml writing_usb_driver.xml networking.xml \
 	    kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \
Documentation/DocBook/device-drivers.tmpl new file +418 -0

418 lines not on this page · raw message

Documentation/DocBook/kernel-api.tmpl +0 -377

395 lines not on this page · raw message

Acked-by on v1 1/1
#1 lore raw
Quoted 23 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>

The kernel-api docbook was much larger than any of the others, so processing it took longer and needed some docbook extras in some cases, so split it into kernel-api (infrastructure etc.) and device drivers/device subsystems. This allows these docbooks to be generated in parallel. (This reduced the docbook processing time on my 4-proc system with make -j4 from about 5min:16sec to about 2min:01sec.)

The chapters that were moved from kernel-api to device-drivers are:

Driver Basics
Device drivers infrastructure
Parallel Port Devices
Message-based devices
Sound Devices
16x50 UART Driver
Frame Buffer Library
Input Subsystem
Serial Peripheral Interface (SPI)
I2C and SMBus Subsystem

Quoted 1 line

I like the split, and I assume you will carry the patch in a Documentation tree?

Sam

#2 lore raw
Quoted 24 lines · Sam Ravnborg
Quoted 23 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>

The kernel-api docbook was much larger than any of the others, so processing it took longer and needed some docbook extras in some cases, so split it into kernel-api (infrastructure etc.) and device drivers/device subsystems. This allows these docbooks to be generated in parallel. (This reduced the docbook processing time on my 4-proc system with make -j4 from about 5min:16sec to about 2min:01sec.)

The chapters that were moved from kernel-api to device-drivers are:

Driver Basics
Device drivers infrastructure
Parallel Port Devices
Message-based devices
Sound Devices
16x50 UART Driver
Frame Buffer Library
Input Subsystem
Serial Peripheral Interface (SPI)
I2C and SMBus Subsystem

Quoted 5 lines
Quoted 1 line

I like the split, and I assume you will carry the patch in a Documentation tree?

If I need to :)

or Andrew can merge it.

Signature · 1 line
~Randy