Documentation update
Subsystems (10)
Hoi :)
I'm still working on fixing and updating the Linux DocBook Documentation. My tree currently consists of several fixes to the Documentation generation, some additional kernel-doc entries and a move from SGML to valid XML.
Please have a look at it and consider merging.
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 | 14 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/kfifo.h | 12 include/linux/skbuff.h | 2 include/linux/wait.h | 60 ++ kernel/kfifo.c | 10 kernel/sysctl.c | 7 net/core/skbuff.c | 5 scripts/kernel-doc | 78 +-- 39 files changed, 802 insertions(+), 647 deletions(-)
through these ChangeSets:
<[email protected]> (05/03/03 1.2041)
[DocBook] escape declaration_purpose
<[email protected]> (05/03/03 1.2040)
[DocBook] factor out escaping of XML special characters
<[email protected]> (05/03/02 1.2039)
[DocBook] add kfifo to kernel-api docs
<[email protected]> (05/03/02 1.2038)
[DocBook] kernel-docify comments
<[email protected]> (05/02/09 1.2037)
DocBook: fix XML in templates
<[email protected]> (05/02/08 1.2036)
DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile
<[email protected]> (05/02/08 1.2035)
DocBook: move kernel-doc comment next to function
<[email protected]> (05/02/08 1.2034)
DocBook: s/sgml/xml/ in scripts/kernel-doc
<[email protected]> (05/02/08 1.2033)
DocBook: convert template files to XML
<[email protected]> (05/01/26 1.2032)
DocBook: new kernel-doc comments for might_sleep & wait_event_*
<[email protected]> (05/01/26 1.2031)
DocBook: fix function parameter descriptin in fbmem
<[email protected]> (05/01/26 1.2030)
DocBook: update function parameter description in USB code
<[email protected]> (05/01/26 1.2029)
DocBook: update function parameter description in block/fs code
<[email protected]> (05/01/26 1.2028)
DocBook: update function parameter description in network code
<[email protected]> (05/01/26 1.2027)
DocBook: allow preprocessor directives between kernel-doc and function
<[email protected]> (05/01/26 1.2026)
DocBook: remove reference to drivers/net/net_init.c
This file has been removed and is breaking documentation generation.
Signature · 1 line
Martin Waitz
PATCH 1/16 DocBook: remove reference to drivers/net/net_init.c
DocBook: remove reference to drivers/net/net_init.c
This file has been removed and is breaking documentation generation.
PATCH 1/16 DocBook: remove reference to drivers/net/net_init.c
In reply to Martin WaitzDocBook: remove reference to drivers/net/net_init.c
This file has been removed and is breaking documentation generation.
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2025 -> 1.2026
# Documentation/DocBook/kernel-api.tmpl 1.32 -> 1.33
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/01/26 [email protected] 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 <[email protected]>
# --------------------------------------------
#
Documentation/DocBook/kernel-api.tmpl +0 -1
@@ -152,7 +152,6 @@ <chapter id="netdev"> <title>Network device support</title> <sect1><title>Driver Support</title> -!Edrivers/net/net_init.c !Enet/core/dev.c </sect1> <sect1><title>8390 Based Network Cards</title>
PATCH 2/16 DocBook: allow preprocessor directives between kernel-doc and function
In reply to Martin WaitzDocBook: allow preprocessor directives between kernel-doc and function
PATCH 2/16 DocBook: allow preprocessor directives between kernel-doc and function
In reply to Martin WaitzDocBook: allow preprocessor directives between kernel-doc and function
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2026 -> 1.2027
# scripts/kernel-doc 1.24 -> 1.25
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/01/26 [email protected] 1.2027
# DocBook: allow preprocessor directives between kernel-doc and function #
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
scripts/kernel-doc +2 -2
@@ -1578,13 +1578,13 @@ my $x = shift; my $file = shift; - if ($x =~ m#\s*/\*\s+MACDOC\s*#io) { + if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#define/)) { # do nothing } elsif ($x =~ /([^\{]*)/) { $prototype .= $1; } - if (($x =~ /\{/) || ($x =~ /\#/) || ($x =~ /;/)) { + if (($x =~ /\{/) || ($x =~ /\#define/) || ($x =~ /;/)) { $prototype =~ s@/\*.*?\*/@@gos; # strip comments. $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's. $prototype =~ s@^\s+@@gos; # strip leading spaces
PATCH 3/16 DocBook: update function parameter description in network code
In reply to Martin WaitzDocBook: update function parameter description in network code
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2027 -> 1.2028 # drivers/net/8390.c 1.27 -> 1.28 # net/core/skbuff.c 1.41 -> 1.42
# include/linux/skbuff.h 1.59 -> 1.60
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/01/26 [email protected] 1.2028
# DocBook: update function parameter description in network code #
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
drivers/net/8390.c +1 -0
@@ -999,6 +999,7 @@/** * alloc_ei_netdev - alloc_etherdev counterpart for 8390 +* @size: extra bytes to allocate * * Allocate 8390-specific net_device. */
include/linux/skbuff.h +2 -0
@@ -187,6 +187,8 @@* @nf_bridge: Saved data about a bridged frame - see br_netfilter.c * @private: Data which is private to the HIPPI implementation * @tc_index: Traffic control index +* @tc_verd: traffic control verdict +* @tc_classid: traffic control classid */ struct sk_buff {
net/core/skbuff.c +4 -1
@@ -1444,7 +1444,7 @@if (pos < len) {/* Split frag. -* We have to variants in this case: +* We have two variants in this case: * 1. Move all the frag to the second * part, if it is possible. F.e. * this approach is mandatory for TUX,
@@ -1467,6 +1467,9 @@/** * skb_split - Split fragmented skb to two parts at length len. +* @skb: the buffer to split +* @skb1: the buffer to receive the second part +* @len: new length for skb */ void skb_split (struct sk_buff *skb,struct sk_buff *skb1,const u32 len) {
PATCH 4/16 DocBook: update function parameter description in block/fs code
In reply to Martin WaitzDocBook: update function parameter description in block/fs code
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2028 -> 1.2029
# drivers/block/ll_rw_blk.c 1.282 -> 1.283
# kernel/sysctl.c 1.96 -> 1.97 # fs/jbd/journal.c 1.79 -> 1.81 # fs/jbd/transaction.c 1.91 -> 1.92 # fs/super.c 1.129 -> 1.130 # include/linux/jbd.h 1.48 -> 1.49
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/01/26 [email protected] 1.2029
# DocBook: update function parameter description in block/fs code #
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
drivers/block/ll_rw_blk.c +2 -1
@@ -618,6 +618,7 @@* blk_queue_init_tags - initialize the queue tag info * @q: the request queue for the device * @depth: the maximum queue depth supported +* @tags: the tag to use **/ int blk_queue_init_tags (request_queue_t *q,int depth,struct blk_queue_tag *tags)
@@ -1963,7 +1964,7 @@/** * blk_rq_unmap_user - unmap a request with user data * @rq: request to be unmapped -* @ubuf: user buffer +* @bio: bio for the request * @ulen: length of user buffer * * Description:
fs/jbd/journal.c +15 -4
@@ -1147,6 +1147,10 @@/** *int journal_check_used_features () - Check if features specified are used. +* @journal: Journal to check. +* @compat: bitmask of compatible features +* @ro: bitmask of features that force read-only mount +* @incompat: bitmask of incompatible features * * Check whether the journal uses all of a given set of * features. Return true (non-zero) if it does.
@@ -1174,6 +1178,10 @@/** * int journal_check_available_features() - Check feature set in journalling layer +* @journal: Journal to check. +* @compat: bitmask of compatible features +* @ro: bitmask of features that force read-only mount +* @incompat: bitmask of incompatible features * * Check whether the journaling code supports the use of * all of a given set of features on this journal. Return true
@@ -1206,6 +1214,10 @@/** * int journal_set_features () - Mark a given journal feature in the superblock +* @journal: Journal to act on. +* @compat: bitmask of compatible features +* @ro: bitmask of features that force read-only mount +* @incompat: bitmask of incompatible features * * Mark a given journal feature as present on the * superblock. Returns true if the requested features could be set.
@@ -1238,6 +1250,7 @@/** * int journal_update_format () - Update on-disk journal structure. +* @journal: Journal to act on. * * Given an initialised but unloaded journal struct, poke about in the * on-disk structure to update it to the most recent supported version.
@@ -1538,6 +1551,7 @@/** * int journal_clear_err () - clears the journal's error state +* @journal: journal to act on. * * An error must be cleared or Acked to take a FS out of readonly * mode.
@@ -1557,6 +1571,7 @@/** * void journal_ack_err() - Ack journal err. +* @journal: journal to act on. * * An error must be cleared or Acked to take a FS out of readonly * mode.
@@ -1574,10 +1589,6 @@return 1 << (PAGE_CACHE_SHIFT - inode->i_sb->s_blocksize_bits); } -/* -* Simple support for retying memory allocations. Introduced to help to -* debug different VM deadlock avoidance strategies. -*/ /* * Simple support for retying memory allocations. Introduced to help to * debug different VM deadlock avoidance strategies.
fs/jbd/transaction.c +2 -1
@@ -742,6 +742,7 @@* int journal_get_write_access() - notify intent to modify a buffer for metadata (not data) update. * @handle: transaction to add buffer modifications to * @bh: bh to be used for metadata writes +* @credits: variable that will receive credits for the buffer * * Returns an error code or 0 on success. *
@@ -1578,7 +1579,7 @@* int journal_try_to_free_buffers() - try to free page buffers. * @journal: journal for operation * @page: to try and free -* @gfp_mask: 'IO' mode for try_to_free_buffers() +* @unused_gfp_mask: unused * * * For all the buffers on this page,
fs/super.c +1 -1
@@ -143,7 +143,7 @@/** * put_super - drop a temporary reference to superblock -* @s: superblock in question +* @sb: superblock in question * * Drops a temporary reference, frees superblock if there's no * references left.
include/linux/jbd.h +5 -0
@@ -562,6 +562,7 @@* @j_sb_buffer: First part of superblock buffer * @j_superblock: Second part of superblock buffer * @j_format_version: Version of the superblock format +* @j_state_lock: Protect the various scalars in the journal * @j_barrier_count: Number of processes waiting to create a barrier lock * @j_barrier: The barrier lock itself * @j_running_transaction: The current running transaction..
@@ -589,6 +590,7 @@* @j_fs_dev: Device which holds the client fs. For internal journal this will * be equal to j_dev * @j_maxlen: Total maximum capacity of the journal region on disk. +* @j_list_lock: Protects the buffer lists and internal buffer state. * @j_inode: Optional inode where we store the journal. If present, all journal * block numbers are mapped into this inode via bmap(). * @j_tail_sequence: Sequence number of the oldest transaction in the log
@@ -604,8 +606,11 @@* @j_commit_interval: What is the maximum transaction lifetime before we begin * a commit? * @j_commit_timer: The timer used to wakeup the commit thread +* @j_revoke_lock: Protect the revoke table * @j_revoke: The revoke table - maintains the list of revoked blocks in the * current transaction. +* @j_revoke_table: alternate revoke tables for j_revoke +* @j_private: An opaque pointer to fs-private information. */ struct journal_s
kernel/sysctl.c +7 -0
@@ -1368,6 +1368,7 @@* @filp: the file structure * @buffer: the user buffer * @lenp: the size of the user buffer +* @ppos: file position * * Reads/writes a string from/to the user buffer. If the kernel * buffer provided is not large enough to hold the string, the
@@ -1584,6 +1585,7 @@* @filp: the file structure * @buffer: the user buffer * @lenp: the size of the user buffer +* @ppos: file position * * Reads/writes up to table->maxlen/sizeof(unsigned int) integer * values from/to the user buffer, treated as an ASCII string.
@@ -1688,6 +1690,7 @@* @filp: the file structure * @buffer: the user buffer * @lenp: the size of the user buffer +* @ppos: file position * * Reads/writes up to table->maxlen/sizeof(unsigned int) integer * values from/to the user buffer, treated as an ASCII string.
@@ -1820,6 +1823,7 @@* @filp: the file structure * @buffer: the user buffer * @lenp: the size of the user buffer +* @ppos: file position * * Reads/writes up to table->maxlen/sizeof(unsigned long) unsigned long * values from/to the user buffer, treated as an ASCII string.
@@ -1842,6 +1846,7 @@* @filp: the file structure * @buffer: the user buffer * @lenp: the size of the user buffer +* @ppos: file position * * Reads/writes up to table->maxlen/sizeof(unsigned long) unsigned long * values from/to the user buffer, treated as an ASCII string. The values
@@ -1911,6 +1916,7 @@* @filp: the file structure * @buffer: the user buffer * @lenp: the size of the user buffer +* @ppos: file position * * Reads/writes up to table->maxlen/sizeof(unsigned int) integer * values from/to the user buffer, treated as an ASCII string.
@@ -1933,6 +1939,7 @@* @filp: the file structure * @buffer: the user buffer * @lenp: the size of the user buffer +* @ppos: file position * * Reads/writes up to table->maxlen/sizeof(unsigned int) integer * values from/to the user buffer, treated as an ASCII string.
PATCH 5/16 DocBook: update function parameter description in USB code
In reply to Martin WaitzDocBook: update function parameter description in USB code
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2029 -> 1.2030
# drivers/usb/core/hub.c 1.160 -> 1.161
# drivers/usb/core/hcd.c 1.115 -> 1.116
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/01/26 [email protected] 1.2030
# DocBook: update function parameter description in USB code
#
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
drivers/usb/core/hcd.c +1 -1
@@ -1394,7 +1394,7 @@/** * usb_bus_start_enum - start immediate enumeration (for OTG) * @bus: the bus (must use hcd framework) -* @port: 1-based number of port; usually bus->otg_port +* @port_num: 1-based number of port; usually bus->otg_port * Context: in_interrupt() * * Starts enumeration, with an immediate reset followed later by
drivers/usb/core/hub.c +1 -1
@@ -383,7 +383,7 @@/** * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub -* @dev: the device whose split transaction failed +* @udev: the device whose split transaction failed * @pipe: identifies the endpoint of the failed transaction * * High speed HCDs use this to tell the hub driver that some split control or
PATCH 6/16 DocBook: fix function parameter descriptin in fbmem
In reply to Martin WaitzDocBook: fix function parameter descriptin in fbmem
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2030 -> 1.2031
# drivers/video/fbmem.c 1.150 -> 1.151
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/01/26 [email protected] 1.2031
# DocBook: fix function parameter descriptin in fbmem
#
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
drivers/video/fbmem.c +4 -3
@@ -1211,9 +1211,10 @@/** * fb_get_options - get kernel boot parameters -* @name - framebuffer name as it would appear in -* the boot parameter line -* (video=<name>:<options>) +* @name: framebuffer name as it would appear in +* the boot parameter line +* (video=<name>:<options>) +* @option: the option will be stored here * * NOTE: Needed to maintain backwards compatibility */
PATCH 7/16 DocBook: new kernel-doc comments for might_sleep & wait_event_*
In reply to Martin WaitzDocBook: new kernel-doc comments for might_sleep & wait_event_*
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2031 -> 1.2032
# include/linux/kernel.h 1.60 -> 1.61
# include/linux/wait.h 1.28 -> 1.29
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/01/26 [email protected] 1.2032
# DocBook: new kernel-doc comments for might_sleep & wait_event_* #
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
include/linux/kernel.h +11 -1
@@ -48,10 +48,20 @@struct completion ; +/** +* might_sleep - annotation for functions that can sleep +* +* this macro will print a stack trace if it is executed in an atomic +* context (spinlock, irq-handler, ...). +* +* This is a useful debugging help to be able to catch problems early and not +* be biten later when the calling function happens to sleep when it is not +* supposed to. +*/ #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP -void __might_sleep (char *file,int line);#define might_sleep () __might_sleep(__FILE__, __LINE__)#define might_sleep_if (cond) do { if (unlikely(cond)) might_sleep(); } while (0) +void __might_sleep (char *file,int line);#else #define might_sleep () do {} while(0)#define might_sleep_if (cond) do {} while (0)
include/linux/wait.h +60 -0
84 lines not on this page · raw message
PATCH 8/16 DocBook: convert template files to XML
In reply to Martin WaitzDocBook: convert template files to XML
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2032 -> 1.2033
# Documentation/DocBook/scsidrivers.tmpl 1.4 -> 1.5
# Documentation/DocBook/kernel-api.tmpl 1.33 -> 1.34
# Documentation/DocBook/journal-api.tmpl 1.6 -> 1.7
# Documentation/DocBook/wanbook.tmpl 1.1 -> 1.2
# Documentation/DocBook/z8530book.tmpl 1.1 -> 1.2
# Documentation/DocBook/tulip-user.tmpl 1.3 -> 1.4
# Documentation/DocBook/kernel-locking.tmpl 1.13 -> 1.14
# Documentation/DocBook/deviceiobook.tmpl 1.6 -> 1.7
# Documentation/DocBook/libata.tmpl 1.3 -> 1.4
# Documentation/DocBook/writing_usb_driver.tmpl 1.7 -> 1.8
# Documentation/DocBook/gadget.tmpl 1.5 -> 1.6
# Documentation/DocBook/kernel-hacking.tmpl 1.19 -> 1.20
# Documentation/DocBook/sis900.tmpl 1.5 -> 1.6
# Documentation/DocBook/mtdnand.tmpl 1.1 -> 1.2
# Documentation/DocBook/mcabook.tmpl 1.1 -> 1.2
# Documentation/DocBook/procfs-guide.tmpl 1.5 -> 1.6
# Documentation/DocBook/lsm.tmpl 1.3 -> 1.4
# Documentation/DocBook/librs.tmpl 1.2 -> 1.3
# Documentation/DocBook/videobook.tmpl 1.7 -> 1.8
# Documentation/DocBook/usb.tmpl 1.4 -> 1.5
# Documentation/DocBook/via-audio.tmpl 1.7 -> 1.8
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/02/08 [email protected] 1.2033
# DocBook: convert template files to XML
#
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
Documentation/DocBook/deviceiobook.tmpl +3 -1
@@ -1,4 +1,6 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> <book id="DoingIO"> <bookinfo>
Documentation/DocBook/gadget.tmpl +4 -1
@@ -1,4 +1,7 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> + <book id="USB-Gadget-API"> <bookinfo> <title>USB Gadget API for Linux</title>
Documentation/DocBook/journal-api.tmpl +4 -1
@@ -1,4 +1,7 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> + <book id="LinuxJBDAPI"> <bookinfo> <title>The Linux Journalling API</title>
Documentation/DocBook/kernel-api.tmpl +4 -1
@@ -1,4 +1,7 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> + <book id="LinuxKernelAPI"> <bookinfo> <title>The Linux Kernel API</title>
Documentation/DocBook/kernel-hacking.tmpl +3 -1
@@ -1,4 +1,6 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> <book id="lk-hacking-guide"> <bookinfo>
Documentation/DocBook/kernel-locking.tmpl +121 -119
271 lines not on this page · raw message
Documentation/DocBook/libata.tmpl +3 -1
@@ -1,4 +1,6 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> <book id="libataDevGuide"> <bookinfo>
Documentation/DocBook/librs.tmpl +3 -1
@@ -1,4 +1,6 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> <book id="Reed-Solomon-Library-Guide"> <bookinfo>
Documentation/DocBook/lsm.tmpl +7 -4
@@ -1,6 +1,9 @@ -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> + <article class="whitepaper" id="LinuxSecurityModule" lang="en"> - <artheader> + <articleinfo> <title>Linux Security Modules: General Security Hooks for Linux</title> <authorgroup> <author>
@@ -28,7 +31,7 @@ </affiliation> </author> </authorgroup> - </artheader> + </articleinfo> <sect1><title>Introduction</title>
@@ -84,7 +87,7 @@ modules. The LSM kernel patch also moves most of the capabilities logic into an optional security module, with the system defaulting to the traditional superuser logic. This capabilities module -is discussed further in <XRef LinkEnd="cap">. +is discussed further in <xref linkend="cap"/>. </para> <para>
Documentation/DocBook/mcabook.tmpl +3 -1
@@ -1,4 +1,6 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> <book id="MCAGuide"> <bookinfo>
Documentation/DocBook/mtdnand.tmpl +3 -1
@@ -1,4 +1,6 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> <book id="MTD-NAND-Guide"> <bookinfo>
Documentation/DocBook/procfs-guide.tmpl +13 -12
@@ -1,5 +1,6 @@ -<!-- -*- sgml -*- --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ <!ENTITY procfsexample SYSTEM "procfs_example.sgml"> ]>
@@ -205,7 +206,7 @@ function will return a pointer to the freshly created <structname>struct proc_dir_entry</structname>; otherwise it will return <constant>NULL</constant>. <xref - linkend="userland"> describes how to do something useful with + linkend="userland"/> describes how to do something useful with regular files. </para>
@@ -221,7 +222,7 @@ <para> If you only want to be able to read the file, the function <function>create_proc_read_entry</function> described in <xref - linkend="convenience"> may be used to create and initialise + linkend="convenience"/> may be used to create and initialise the procfs entry in one single call. </para> </sect1>
@@ -298,7 +299,7 @@ the <structname>struct proc_dir_entry</structname> before <function>remove_proc_entry</function> is called (that is: if there was some <structfield>data</structfield> allocated, of - course). See <xref linkend="usingdata"> for more information + course). See <xref linkend="usingdata"/> for more information on using the <structfield>data</structfield> entry. </para> </sect1>
@@ -333,7 +334,7 @@ If you only want to use a the <structfield>read_proc</structfield>, the function <function>create_proc_read_entry</function> described in <xref - linkend="convenience"> may be used to create and initialise the + linkend="convenience"/> may be used to create and initialise the procfs entry in one single call. </para>
@@ -386,7 +387,7 @@ The parameter <parameter>start</parameter> doesn't seem to be used anywhere in the kernel. The <parameter>data</parameter> parameter can be used to create a single call back function for - several files, see <xref linkend="usingdata">. + several files, see <xref linkend="usingdata"/>. </para> <para>
@@ -395,7 +396,7 @@ </para> <para> - <xref linkend="example"> shows how to use a read call back + <xref linkend="example"/> shows how to use a read call back function. </para> </sect1>
@@ -429,12 +430,12 @@ kernel's memory space, so it should first be copied to kernel space with <function>copy_from_user</function>. The <parameter>file</parameter> parameter is usually - ignored. <xref linkend="usingdata"> shows how to use the + ignored. <xref linkend="usingdata"/> shows how to use the <parameter>data</parameter> parameter. </para> <para> - Again, <xref linkend="example"> shows how to use this call back + Again, <xref linkend="example"/> shows how to use this call back function. </para> </sect1>
@@ -525,10 +526,10 @@ <para> This function creates a regular file in exactly the same way as <function>create_proc_entry</function> from <xref - linkend="regularfile"> does, but also allows to set the read + linkend="regularfile"/> does, but also allows to set the read function <parameter>read_proc</parameter> in one call. This function can set the <parameter>data</parameter> as well, like - explained in <xref linkend="usingdata">. + explained in <xref linkend="usingdata"/>. </para> </sect1>
Documentation/DocBook/scsidrivers.tmpl +3 -2
@@ -1,5 +1,6 @@ -<!-- -*- sgml -*- --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> <book id="scsidrivers"> <bookinfo>
Documentation/DocBook/sis900.tmpl +278 -276
825 lines not on this page · raw message
Documentation/DocBook/tulip-user.tmpl +5 -3
@@ -1,4 +1,6 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> <book id="TulipUserGuide"> <bookinfo>
@@ -67,7 +69,7 @@ <para> For 2.4.x and later kernels, the Linux Tulip driver is available at -<ULink URL="http://sourceforge.net/projects/tulip/">http://sourceforge.net/projects/tulip/</ULink> +<ulink url="http://sourceforge.net/projects/tulip/">http://sourceforge.net/projects/tulip/</ulink> </para> <para>
@@ -85,7 +87,7 @@ <para> Additional information on Donald Becker's tulip.c - is available at <ULink URL="http://www.scyld.com/network/tulip.html">http://www.scyld.com/network/tulip.html</ULink> + is available at <ulink url="http://www.scyld.com/network/tulip.html">http://www.scyld.com/network/tulip.html</ulink> </para> </chapter>
Documentation/DocBook/usb.tmpl +4 -1
@@ -1,4 +1,7 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> + <book id="Linux-USB-API"> <bookinfo> <title>The Linux-USB Host Side API</title>
Documentation/DocBook/via-audio.tmpl +3 -1
@@ -1,4 +1,6 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> <book id="ViaAudioGuide"> <bookinfo>
Documentation/DocBook/videobook.tmpl +101 -99
417 lines not on this page · raw message
Documentation/DocBook/wanbook.tmpl +3 -1
@@ -1,4 +1,6 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> <book id="WANGuide"> <bookinfo>
Documentation/DocBook/writing_usb_driver.tmpl +3 -1
@@ -1,4 +1,6 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> <book id="USBDeviceDriver"> <bookinfo>
Documentation/DocBook/z8530book.tmpl +3 -1
@@ -1,4 +1,6 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> <book id="Z85230Guide"> <bookinfo>
PATCH 9/16 DocBook: s/sgml/xml/ in scripts/kernel-doc
In reply to Martin WaitzDocBook: s/sgml/xml/ in scripts/kernel-doc
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2033 -> 1.2034
# scripts/kernel-doc 1.25 -> 1.26
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/02/08 [email protected] 1.2034
# DocBook: s/sgml/xml/ in scripts/kernel-doc
#
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
scripts/kernel-doc +24 -24
@@ -170,14 +170,14 @@ $type_param, "<tt><b>\$1</b></tt>" ); my $blankline_html = "<p>"; -# sgml, docbook format -my %highlights_sgml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>", +# XML, docbook format +my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>", $type_constant, "<constant>\$1</constant>", $type_func, "<function>\$1</function>", $type_struct, "<structname>\$1</structname>", $type_env, "<envar>\$1</envar>", $type_param, "<parameter>\$1</parameter>" ); -my $blankline_sgml = "</para><para>\n"; +my $blankline_xml = "</para><para>\n"; # gnome, docbook format my %highlights_gnome = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>",
@@ -297,14 +297,14 @@ %highlights = %highlights_text; $blankline = $blankline_text; } elsif ($cmd eq "-docbook") { - $output_mode = "sgml"; - %highlights = %highlights_sgml; - $blankline = $blankline_sgml; + $output_mode = "xml"; + %highlights = %highlights_xml; + $blankline = $blankline_xml; } elsif ($cmd eq "-gnome") { $output_mode = "gnome"; %highlights = %highlights_gnome; $blankline = $blankline_gnome; - } elsif ($cmd eq "-module") { # not needed for sgml, inherits from calling document + } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document $modulename = shift @ARGV; } elsif ($cmd eq "-function") { # to only output specific functions $function_only = 1;
@@ -547,7 +547,7 @@ print "<hr>\n"; } -sub output_section_sgml(%) { +sub output_section_xml(%) { my %args = %{$_[0]}; my $section; # print out each section
@@ -565,8 +565,8 @@ } } -# output function in sgml DocBook -sub output_function_sgml(%) { +# output function in XML DocBook +sub output_function_xml(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count;
@@ -632,12 +632,12 @@ } print "</refsect1>\n"; - output_section_sgml(@_); + output_section_xml(@_); print "</refentry>\n\n"; } -# output struct in sgml DocBook -sub output_struct_sgml(%) { +# output struct in XML DocBook +sub output_struct_xml(%) { my %args = %{$_[0]}; my ($parameter, $section); my $id;
@@ -708,13 +708,13 @@ print " </variablelist>\n"; print " </refsect1>\n"; - output_section_sgml(@_); + output_section_xml(@_); print "</refentry>\n\n"; } -# output enum in sgml DocBook -sub output_enum_sgml(%) { +# output enum in XML DocBook +sub output_enum_xml(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count;
@@ -769,13 +769,13 @@ print " </variablelist>\n"; print "</refsect1>\n"; - output_section_sgml(@_); + output_section_xml(@_); print "</refentry>\n\n"; } -# output typedef in sgml DocBook -sub output_typedef_sgml(%) { +# output typedef in XML DocBook +sub output_typedef_xml(%) { my %args = %{$_[0]}; my ($parameter, $section); my $id;
@@ -800,13 +800,13 @@ print " <synopsis>typedef ".$args{'typedef'}.";</synopsis>\n"; print "</refsynopsisdiv>\n"; - output_section_sgml(@_); + output_section_xml(@_); print "</refentry>\n\n"; } -# output in sgml DocBook -sub output_intro_sgml(%) { +# output in XML DocBook +sub output_intro_xml(%) { my %args = %{$_[0]}; my ($parameter, $section); my $count;
@@ -831,7 +831,7 @@ print "\n\n"; } -# output in sgml DocBook +# output in XML DocBook sub output_function_gnome { my %args = %{$_[0]}; my ($parameter, $section);
@@ -1799,7 +1799,7 @@ } if ($initial_section_counter == $section_counter) { print STDERR "Warning(${file}): no structured comments found\n"; - if ($output_mode eq "sgml") { + if ($output_mode eq "xml") { # The template wants at least one RefEntry here; make one. print "<refentry>\n"; print " <refnamediv>\n";
PATCH 10/16 DocBook: move kernel-doc comment next to function
In reply to Martin WaitzDocBook: move kernel-doc comment next to function
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2034 -> 1.2035
# drivers/video/fbmem.c 1.151 -> 1.152
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/02/08 [email protected] 1.2035
# DocBook: move kernel-doc comment next to function
#
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
drivers/video/fbmem.c +3 -3
@@ -1249,6 +1249,9 @@return retval; } + +extern const char *global_mode_option; +/** * video_setup - process command line options * @options: string of options
@@ -1262,9 +1265,6 @@* Returns zero. * */ - -extern const char *global_mode_option; -int __init video_setup (char *options) {int i, global =0 ;
PATCH 11/16 DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile
In reply to Martin WaitzDocBook: s/sgml/xml/ in Documentation/DocBook/Makefile
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2035 -> 1.2036
# Documentation/DocBook/Makefile 1.50 -> 1.51
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/02/08 [email protected] 1.2036
# DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile
#
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
Documentation/DocBook/Makefile +39 -38
@@ -6,38 +6,39 @@ # To add a new book the only step required is to add the book to the # list of DOCBOOKS. -DOCBOOKS := wanbook.sgml z8530book.sgml mcabook.sgml videobook.sgml \ - kernel-hacking.sgml kernel-locking.sgml via-audio.sgml \ - deviceiobook.sgml procfs-guide.sgml tulip-user.sgml \ - writing_usb_driver.sgml scsidrivers.sgml sis900.sgml \ - kernel-api.sgml journal-api.sgml lsm.sgml usb.sgml \ - gadget.sgml libata.sgml mtdnand.sgml librs.sgml +DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \ + kernel-hacking.xml kernel-locking.xml via-audio.xml \ + deviceiobook.xml procfs-guide.xml tulip-user.xml \ + writing_usb_driver.xml scsidrivers.xml sis900.xml \ + kernel-api.xml journal-api.xml lsm.xml usb.xml \ + gadget.xml libata.xml mtdnand.xml librs.xml ### # The build process is as follows (targets): -# (sgmldocs) -# file.tmpl --> file.sgml +--> file.ps (psdocs) -# +--> file.pdf (pdfdocs) -# +--> DIR=file (htmldocs) -# +--> man/ (mandocs) +# (xmldocs) +# file.tmpl --> file.xml +--> file.ps (psdocs) +# +--> file.pdf (pdfdocs) +# +--> DIR=file (htmldocs) +# +--> man/ (mandocs) ### # The targets that may be used. -.PHONY: sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs +.PHONY: xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs BOOKS := $(addprefix $(obj)/,$(DOCBOOKS)) -sgmldocs: $(BOOKS) +xmldocs: $(BOOKS) +sgmldocs: xmldocs -PS := $(patsubst %.sgml, %.ps, $(BOOKS)) +PS := $(patsubst %.xml, %.ps, $(BOOKS)) psdocs: $(PS) -PDF := $(patsubst %.sgml, %.pdf, $(BOOKS)) +PDF := $(patsubst %.xml, %.pdf, $(BOOKS)) pdfdocs: $(PDF) -HTML := $(patsubst %.sgml, %.html, $(BOOKS)) +HTML := $(patsubst %.xml, %.html, $(BOOKS)) htmldocs: $(HTML) -MAN := $(patsubst %.sgml, %.9, $(BOOKS)) +MAN := $(patsubst %.xml, %.9, $(BOOKS)) mandocs: $(MAN) installmandocs: mandocs
@@ -55,7 +56,7 @@ # 1) To generate a dependency list for a .tmpl file # 2) To preprocess a .tmpl file and call kernel-doc with # appropriate parameters. -# The following rules are used to generate the .sgml documentation +# The following rules are used to generate the .xml documentation # required to generate the final targets. (ps, pdf, html). quiet_cmd_docproc = DOCPROC $@ cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
@@ -69,7 +70,7 @@ ) > $(dir $@).$(notdir $@).cmd endef -%.sgml: %.tmpl FORCE +%.xml: %.tmpl FORCE $(call if_changed_rule,docproc) ###
@@ -87,9 +88,9 @@ ### # procfs guide uses a .c file as example code. # This requires an explicit dependency -C-procfs-example = procfs_example.sgml +C-procfs-example = procfs_example.xml C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example)) -$(obj)/procfs-guide.sgml: $(C-procfs-example2) +$(obj)/procfs-guide.xml: $(C-procfs-example2) ### # Rules to generate postscript, PDF and HTML
@@ -97,7 +98,7 @@ quiet_cmd_db2ps = DB2PS $@ cmd_db2ps = db2ps -o $(dir $@) $< -%.ps : %.sgml +%.ps : %.xml @(which db2ps > /dev/null 2>&1) || \ (echo "*** You need to install DocBook stylesheets ***"; \ exit 1)
@@ -105,7 +106,7 @@ quiet_cmd_db2pdf = DB2PDF $@ cmd_db2pdf = db2pdf -o $(dir $@) $< -%.pdf : %.sgml +%.pdf : %.xml @(which db2pdf > /dev/null 2>&1) || \ (echo "*** You need to install DocBook stylesheets ***"; \ exit 1)
@@ -116,7 +117,7 @@ echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/book1.html"> \ Goto $(patsubst %.html,%,$(notdir $@))</a><p>' > $@ -%.html: %.sgml +%.html: %.xml @(which db2html > /dev/null 2>&1) || \ (echo "*** You need to install DocBook stylesheets ***"; \ exit 1)
@@ -128,7 +129,7 @@ ### # Rule to generate man files - output is placed in the man subdirectory -%.9: %.sgml +%.9: %.xml ifneq ($(KBUILD_SRC),) $(Q)mkdir -p $(objtree)/Documentation/DocBook/man endif
@@ -156,8 +157,8 @@ $(call cmd,fig2png) ### -# Rule to convert a .c file to inline SGML documentation -%.sgml: %.c +# Rule to convert a .c file to inline XML documentation +%.xml: %.c @echo ' GEN $@' @( \ echo "<programlisting>"; \
@@ -171,24 +172,24 @@ # Help targets as used by the top-level makefile dochelp: @echo ' Linux kernel internal documentation in different formats:' - @echo ' sgmldocs (SGML), psdocs (Postscript), pdfdocs (PDF)' + @echo ' xmldocs (XML DocBook), psdocs (Postscript), pdfdocs (PDF)' @echo ' htmldocs (HTML), mandocs (man pages, use installmandocs to install)' ### # Temporary files left by various tools clean-files := $(DOCBOOKS) \ - $(patsubst %.sgml, %.dvi, $(DOCBOOKS)) \ - $(patsubst %.sgml, %.aux, $(DOCBOOKS)) \ - $(patsubst %.sgml, %.tex, $(DOCBOOKS)) \ - $(patsubst %.sgml, %.log, $(DOCBOOKS)) \ - $(patsubst %.sgml, %.out, $(DOCBOOKS)) \ - $(patsubst %.sgml, %.ps, $(DOCBOOKS)) \ - $(patsubst %.sgml, %.pdf, $(DOCBOOKS)) \ - $(patsubst %.sgml, %.html, $(DOCBOOKS)) \ - $(patsubst %.sgml, %.9, $(DOCBOOKS)) \ + $(patsubst %.xml, %.dvi, $(DOCBOOKS)) \ + $(patsubst %.xml, %.aux, $(DOCBOOKS)) \ + $(patsubst %.xml, %.tex, $(DOCBOOKS)) \ + $(patsubst %.xml, %.log, $(DOCBOOKS)) \ + $(patsubst %.xml, %.out, $(DOCBOOKS)) \ + $(patsubst %.xml, %.ps, $(DOCBOOKS)) \ + $(patsubst %.xml, %.pdf, $(DOCBOOKS)) \ + $(patsubst %.xml, %.html, $(DOCBOOKS)) \ + $(patsubst %.xml, %.9, $(DOCBOOKS)) \ $(C-procfs-example) -clean-dirs := $(patsubst %.sgml,%,$(DOCBOOKS)) +clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) #man put files in man subdir - traverse down subdir- := man/
Quoted 8 lines · Martin Waitz
Hoi :)
I'm still working on fixing and updating the Linux DocBook Documentation. My tree currently consists of several fixes to the Documentation generation, some additional kernel-doc entries and a move from SGML to valid XML.
Please have a look at it and consider merging.
Overall, looks pretty good.
Comments:
1) As the author of tulip-user and via-audio docbooks, I can say that they are out of date and should be deleted.
2) Very happy to see conversion to XML.
3) In general, I'm happy that someone is giving the docbook docs some love.
4) Occasionally code movement (not just comment updates) are required, such as:
Quoted 11 lines
(quoted diff) +3
-0@@ -1248,6 +1249,9 @@ return retval; } + +extern const char *global_mode_option; + /** * video_setup - process command line options * @options: string of options
Review line 1270
Quoted 9 lines
(quoted diff) +0
-3@@ -1261,9 +1265,6 @@ * Returns zero. * */ - -extern const char *global_mode_option; - int __init video_setup(char *options) { int i, global = 0;
Although I do not NAK this change, I am curious if kernel-doc can be fixed so that this sort of change is not necessary.
5) Although it is a pain to do this in BitKeeper, now that you've checked everything in, it might be better to send the code changes via the individual maintainers.
6) I would feel more comfortable if this spent some time in Andrew Morton's -mm, before going upstream.
Regards,
Jeff
PATCH 12/16 DocBook: fix XML in templates
In reply to Martin WaitzDocBook: fix XML in templates
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2036 -> 1.2037
# Documentation/DocBook/sis900.tmpl 1.6 -> 1.7
# Documentation/DocBook/mtdnand.tmpl 1.2 -> 1.3
# Documentation/DocBook/procfs-guide.tmpl 1.6 -> 1.7
# Documentation/DocBook/librs.tmpl 1.3 -> 1.4
# Documentation/DocBook/videobook.tmpl 1.8 -> 1.9
# Documentation/DocBook/via-audio.tmpl 1.8 -> 1.9
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/02/09 [email protected] 1.2037
# DocBook: fix XML in templates
#
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
Documentation/DocBook/librs.tmpl +1 -1
@@ -225,7 +225,7 @@ ..... /* Decode 512 byte in data8.*/ numerr = decode_rs8 (rs_decoder, NULL, NULL, 512, syn, 0, errpos, 0, corr); -for (i = 0; i < numerr; i++) { +for (i = 0; i < numerr; i++) { do_error_correction_in_your_buffer(errpos[i], corr[i]); } </programlisting>
Documentation/DocBook/mtdnand.tmpl +5 -5
@@ -240,9 +240,9 @@ struct nand_chip *this = (struct nand_chip *) mtd->priv; switch(cmd){ case NAND_CTL_SETCLE: this->IO_ADDR_W |= CLE_ADRR_BIT; break; - case NAND_CTL_CLRCLE: this->IO_ADDR_W &= ~CLE_ADRR_BIT; break; + case NAND_CTL_CLRCLE: this->IO_ADDR_W &= ~CLE_ADRR_BIT; break; case NAND_CTL_SETALE: this->IO_ADDR_W |= ALE_ADRR_BIT; break; - case NAND_CTL_CLRALE: this->IO_ADDR_W &= ~ALE_ADRR_BIT; break; + case NAND_CTL_CLRALE: this->IO_ADDR_W &= ~ALE_ADRR_BIT; break; } } </programlisting>
@@ -393,7 +393,7 @@ /* Deselect all chips, set all nCE pins high */ GPIO(BOARD_NAND_NCE) |= 0xff; if (chip >= 0) - GPIO(BOARD_NAND_NCE) &= ~ (1 << chip); + GPIO(BOARD_NAND_NCE) &= ~ (1 << chip); } </programlisting> <para>
@@ -407,8 +407,8 @@ struct nand_chip *this = (struct nand_chip *) mtd->priv; /* Deselect all chips */ - this->IO_ADDR_R &= ~BOARD_NAND_ADDR_MASK; - this->IO_ADDR_W &= ~BOARD_NAND_ADDR_MASK; + this->IO_ADDR_R &= ~BOARD_NAND_ADDR_MASK; + this->IO_ADDR_W &= ~BOARD_NAND_ADDR_MASK; switch (chip) { case 0: this->IO_ADDR_R |= BOARD_NAND_ADDR_CHIP0;
Documentation/DocBook/procfs-guide.tmpl +1 -1
@@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ -<!ENTITY procfsexample SYSTEM "procfs_example.sgml"> +<!ENTITY procfsexample SYSTEM "procfs_example.xml"> ]> <book id="LKProcfsGuide">
Documentation/DocBook/sis900.tmpl +1 -1
@@ -20,7 +20,7 @@ </author> </authorgroup> -<edition>Document Revision: 0.3 for SiS900 driver v1.06 & v1.07</edition> +<edition>Document Revision: 0.3 for SiS900 driver v1.06 & v1.07</edition> <pubdate>November 16, 2000</pubdate> <copyright>
Documentation/DocBook/via-audio.tmpl +1 -1
@@ -264,7 +264,7 @@ <listitem> <para> - Fixes for the SPEED, STEREO, CHANNELS, FMT ioctls when in read & + Fixes for the SPEED, STEREO, CHANNELS, FMT ioctls when in read & write mode (Rui Sousa) </para> </listitem>
Documentation/DocBook/videobook.tmpl +3 -3
@@ -523,7 +523,7 @@ if(copy_from_user(arg, &freq, sizeof(unsigned long))!=0) return -EFAULT; - if(hardware_set_freq(freq)<0) + if(hardware_set_freq(freq)<0) return -EINVAL; current_freq = freq; return 0;
@@ -1552,9 +1552,9 @@ struct video_window v; if(copy_from_user(&v, arg, sizeof(v))) return -EFAULT; - if(v.width > 640 || v.height > 480) + if(v.width > 640 || v.height > 480) return -EINVAL; - if(v.width < 16 || v.height < 16) + if(v.width < 16 || v.height < 16) return -EINVAL; hardware_set_key(v.chromakey); hardware_set_window(v);
PATCH 13/16 kernel-docify comments
In reply to Martin Waitz[DocBook] kernel-docify comments
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2037 -> 1.2038
# kernel/kfifo.c 1.2 -> 1.3
# include/linux/kfifo.h 1.1 -> 1.2
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/03/02 [email protected] 1.2038
# [DocBook] kernel-docify comments
#
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
include/linux/kfifo.h +6 -6
@@ -44,7 +44,7 @@extern unsigned int __kfifo_get (struct kfifo *fifo,unsigned char *buffer,unsigned int len); -/* +/** * __kfifo_reset - removes the entire FIFO contents, no locking version * @fifo: the fifo to be emptied. */
@@ -53,7 +53,7 @@ fifo->in = fifo->out =0 ; } -/* +/** * kfifo_reset - removes the entire FIFO contents * @fifo: the fifo to be emptied. */
@@ -68,7 +68,7 @@spin_unlock_irqrestore (fifo->lock, flags); } -/* +/** * kfifo_put - puts some data into the FIFO * @fifo: the fifo to be used. * @buffer: the data to be added.
@@ -93,7 +93,7 @@return ret; } -/* +/** * kfifo_get - gets some data from the FIFO * @fifo: the fifo to be used. * @buffer: where the data must be copied.
@@ -124,7 +124,7 @@return ret; } -/* +/** * __kfifo_len - returns the number of bytes available in the FIFO, no locking version * @fifo: the fifo to be used. */
@@ -133,7 +133,7 @@return fifo->in - fifo->out; } -/* +/** * kfifo_len - returns the number of bytes available in the FIFO * @fifo: the fifo to be used. */
kernel/kfifo.c +5 -5
@@ -25,7 +25,7 @@#include <linux/err.h> #include <linux/kfifo.h> -/* +/** * kfifo_init - allocates a new FIFO using a preallocated buffer * @buffer: the preallocated buffer to be used. * @size: the size of the internal buffer, this have to be a power of 2.
@@ -56,7 +56,7 @@ }EXPORT_SYMBOL (kfifo_init); -/* +/** * kfifo_alloc - allocates a new FIFO and its internal buffer * @size: the size of the internal buffer to be allocated. * @gfp_mask: get_free_pages mask, passed to kmalloc()
@@ -91,7 +91,7 @@ }EXPORT_SYMBOL (kfifo_alloc); -/* +/** * kfifo_free - frees the FIFO * @fifo: the fifo to be freed. */
@@ -102,7 +102,7 @@ }EXPORT_SYMBOL (kfifo_free); -/* +/** * __kfifo_put - puts some data into the FIFO, no locking version * @fifo: the fifo to be used. * @buffer: the data to be added.
@@ -135,7 +135,7 @@ }EXPORT_SYMBOL (__kfifo_put); -/* +/** * __kfifo_get - gets some data from the FIFO, no locking version * @fifo: the fifo to be used. * @buffer: where the data must be copied.
PATCH 14/16 add kfifo to kernel-api docs
In reply to Martin Waitz[DocBook] add kfifo to kernel-api docs
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2038 -> 1.2039
# Documentation/DocBook/kernel-api.tmpl 1.34 -> 1.35
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/03/02 [email protected] 1.2039
# [DocBook] add kfifo to kernel-api docs
#
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
Documentation/DocBook/kernel-api.tmpl +8 -0
@@ -100,6 +100,14 @@ </sect1> </chapter> + <chapter id="kfifo"> + <title>FIFO Buffer</title> + <sect1><title>kfifo interface</title> +!Iinclude/linux/kfifo.h +!Ekernel/kfifo.c + </sect1> + </chapter> + <chapter id="proc"> <title>The proc filesystem</title>
PATCH 15/16 factor out escaping of XML special characters
In reply to Martin Waitz[DocBook] factor out escaping of XML special characters
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2039 -> 1.2040
# scripts/kernel-doc 1.26 -> 1.27
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/03/03 [email protected] 1.2040
# [DocBook] factor out escaping of XML special characters
#
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
scripts/kernel-doc +12 -12
@@ -1624,6 +1624,15 @@ } } +# replace <, >, and & +sub xml_escape($) { + shift; + s/\&/\\\\\\amp;/g; + s/\</\\\\\\lt;/g; + s/\>/\\\\\\gt;/g; + return $_; +} + sub process_file($) { my ($file) = "$ENV{'SRCTREE'}@_"; my $identifier;
@@ -1695,10 +1704,7 @@ $newcontents = $2; if ($contents ne "") { - $contents =~ s/\&/\\\\\\amp;/g; - $contents =~ s/\</\\\\\\lt;/g; - $contents =~ s/\>/\\\\\\gt;/g; - dump_section($section, $contents); + dump_section($section, xml_escape($contents)); $section = $section_default; }
@@ -1710,10 +1716,7 @@ } elsif (/$doc_end/) { if ($contents ne "") { - $contents =~ s/\&/\\\\\\amp;/g; - $contents =~ s/\</\\\\\\lt;/g; - $contents =~ s/\>/\\\\\\gt;/g; - dump_section($section, $contents); + dump_section($section, xml_escape($contents)); $section = $section_default; $contents = ""; }
@@ -1727,10 +1730,7 @@ # @parameter line to signify start of description if ($1 eq "" && ($section =~ m/^@/ || $section eq $section_context)) { - $contents =~ s/\&/\\\\\\amp;/g; - $contents =~ s/\</\\\\\\lt;/g; - $contents =~ s/\>/\\\\\\gt;/g; - dump_section($section, $contents); + dump_section($section, xml_escape($contents)); $section = $section_default; $contents = ""; } else {
Re: [PATCH 15/16] [DocBook] factor out escaping of XML special characters
hoi :)
well, this patch is broken :(
scripts/kernel-doc line 1629
Quoted 9 lines · Martin Waitz
scripts/kernel-doc +3
-0@@ -1624,6 +1624,15 @@ } } +# replace <, >, and & +sub xml_escape($) { + shift;
this must be: $_ = shift;
scripts/kernel-doc line 1638
Quoted 9 lines
scripts/kernel-doc +6
-0+ s/\&/\\\\\\amp;/g; + s/\</\\\\\\lt;/g; + s/\>/\\\\\\gt;/g; + return $_; +} + sub process_file($) { my ($file) = "$ENV{'SRCTREE'}@_"; my $identifier;
this is also fixed in my BK repository.
(I'll send mail with other updates to lkml later)
Signature · 1 line
Martin Waitz
PATCH 16/16 escape declaration_purpose
In reply to Martin Waitz[DocBook] escape declaration_purpose
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas:
# ChangeSet 1.2040 -> 1.2041
# scripts/kernel-doc 1.27 -> 1.28
#
# The following is the BitKeeper ChangeSet Log
# --------------------------------------------
# 05/03/03 [email protected] 1.2041
# [DocBook] escape declaration_purpose
#
# Signed-off-by: Martin Waitz <[email protected]>
# --------------------------------------------
#
scripts/kernel-doc +1 -1
@@ -1673,7 +1673,7 @@ $state = 2; if (/-(.*)/) { - $declaration_purpose = $1; + $declaration_purpose = xml_escape($1); } else { $declaration_purpose = ""; }