[PATCH] Documentation updates

[PATCH] Documentation updates

[Martin Waitz]

[-- Attachment #1: Type: text/plain, Size: 2717 bytes --]

hoi :)

I have created some updates to the Linux documentation.

This includes two important fixes that allow to generate DocBook
documenation from kernel-doc comments again and some low-priority
updates to the kernel-doc comments itself.

All patches are available in my BK repository, it only contains
documentation updates, no code changes.
(The fixes have been reported here before but have not been merged yet.)

Please do a

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

This will update the following files:

 Documentation/DocBook/kernel-api.tmpl |    1 
 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                 |    7 ++-
 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                    |    4 +-
 16 files changed, 118 insertions(+), 17 deletions(-)

through these ChangeSets:

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

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

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

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

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

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

<tali@admingilde.org> (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@admingilde.org>


-- 
Martin Waitz

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 189 bytes --]

Re: [PATCH] Documentation updates

[Christoph Hellwig]

On Wed, Jan 26, 2005 at 11:56:21AM +0100, Martin Waitz wrote:
> hoi :)
> 
> I have created some updates to the Linux documentation.
> 
> This includes two important fixes that allow to generate DocBook
> documenation from kernel-doc comments again and some low-priority
> updates to the kernel-doc comments itself.
> 
> All patches are available in my BK repository, it only contains
> documentation updates, no code changes.
> (The fixes have been reported here before but have not been merged yet.)

Cool!  Btw, anybody's got an idea how to speedup generating the documentation
from the DocBook templates?  There surely must be some faster parsers, it's
currently taking up the majority of the time used to build kernel-source
packages on Debian.

Re: [PATCH] Documentation updates

[Randy.Dunlap]

Martin Waitz wrote:
> hoi :)
> 
> I have created some updates to the Linux documentation.
> 
> This includes two important fixes that allow to generate DocBook
> documenation from kernel-doc comments again and some low-priority
> updates to the kernel-doc comments itself.
> 
> All patches are available in my BK repository, it only contains
> documentation updates, no code changes.
> (The fixes have been reported here before but have not been merged yet.)
> 
> Please do a
> 
> 	bk pull bk://tali.bkbits.net/linux-doc
> 
> This will update the following files:

I'll be glad to review them if you email them or put them on
some web page....

-- 
~Randy