* Documentation update
@ 2005-03-03 10:28 Martin Waitz
2005-03-03 10:37 ` [PATCH 1/16] DocBook: remove reference to drivers/net/net_init.c Martin Waitz
` (18 more replies)
0 siblings, 19 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:28 UTC (permalink / raw)
To: Linus Torvalds; +Cc: linux-kernel
[-- Attachment #1: Type: text/plain, Size: 5313 bytes --]
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:
<tali@admingilde.org> (05/03/03 1.2041)
[DocBook] escape declaration_purpose
Signed-off-by: Martin Waitz <tali@admingilde.org>
<tali@admingilde.org> (05/03/03 1.2040)
[DocBook] factor out escaping of XML special characters
Signed-off-by: Martin Waitz <tali@admingilde.org>
<tali@admingilde.org> (05/03/02 1.2039)
[DocBook] add kfifo to kernel-api docs
Signed-off-by: Martin Waitz <tali@admingilde.org>
<tali@admingilde.org> (05/03/02 1.2038)
[DocBook] kernel-docify comments
Signed-off-by: Martin Waitz <tali@admingilde.org>
<tali@admingilde.org> (05/02/09 1.2037)
DocBook: fix XML in templates
Signed-off-by: Martin Waitz <tali@admingilde.org>
<tali@admingilde.org> (05/02/08 1.2036)
DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile
Signed-off-by: Martin Waitz <tali@admingilde.org>
<tali@admingilde.org> (05/02/08 1.2035)
DocBook: move kernel-doc comment next to function
Signed-off-by: Martin Waitz <tali@admingilde.org>
<tali@admingilde.org> (05/02/08 1.2034)
DocBook: s/sgml/xml/ in scripts/kernel-doc
Signed-off-by: Martin Waitz <tali@admingilde.org>
<tali@admingilde.org> (05/02/08 1.2033)
DocBook: convert template files to XML
Signed-off-by: Martin Waitz <tali@admingilde.org>
<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 --]
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 1/16] DocBook: remove reference to drivers/net/net_init.c
2005-03-03 10:28 Documentation update Martin Waitz
@ 2005-03-03 10:37 ` Martin Waitz
2005-03-03 10:37 ` [PATCH 2/16] DocBook: allow preprocessor directives between kernel-doc and function Martin Waitz
` (17 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:37 UTC (permalink / raw)
To: Linus Torvalds; +Cc: linux-kernel
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>
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 2/16] DocBook: allow preprocessor directives between kernel-doc and function
2005-03-03 10:28 Documentation update Martin Waitz
2005-03-03 10:37 ` [PATCH 1/16] DocBook: remove reference to drivers/net/net_init.c Martin Waitz
@ 2005-03-03 10:37 ` Martin Waitz
2005-03-03 10:41 ` [PATCH 1/16] DocBook: remove reference to drivers/net/net_init.c Martin Waitz
` (16 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:37 UTC (permalink / raw)
To: Linus Torvalds; +Cc: linux-kernel
DocBook: allow preprocessor directives between kernel-doc and function
Signed-off-by: Martin Waitz <tali@admingilde.org>
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 1/16] DocBook: remove reference to drivers/net/net_init.c
2005-03-03 10:28 Documentation update Martin Waitz
2005-03-03 10:37 ` [PATCH 1/16] DocBook: remove reference to drivers/net/net_init.c Martin Waitz
2005-03-03 10:37 ` [PATCH 2/16] DocBook: allow preprocessor directives between kernel-doc and function Martin Waitz
@ 2005-03-03 10:41 ` Martin Waitz
2005-03-03 10:41 ` [PATCH 2/16] DocBook: allow preprocessor directives between kernel-doc and function Martin Waitz
` (15 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:41 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
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>
# 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 tali@admingilde.org 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>
# --------------------------------------------
#
diff -Nru a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl
--- a/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 11:41:17 2005
+++ b/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 11:41:17 2005
@@ -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>
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 2/16] DocBook: allow preprocessor directives between kernel-doc and function
2005-03-03 10:28 Documentation update Martin Waitz
` (2 preceding siblings ...)
2005-03-03 10:41 ` [PATCH 1/16] DocBook: remove reference to drivers/net/net_init.c Martin Waitz
@ 2005-03-03 10:41 ` Martin Waitz
2005-03-03 10:41 ` [PATCH 3/16] DocBook: update function parameter description in network code Martin Waitz
` (14 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:41 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
DocBook: allow preprocessor directives between kernel-doc and function
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2027
# DocBook: allow preprocessor directives between kernel-doc and function
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/scripts/kernel-doc b/scripts/kernel-doc
--- a/scripts/kernel-doc Thu Mar 3 11:41:25 2005
+++ b/scripts/kernel-doc Thu Mar 3 11:41:25 2005
@@ -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
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 3/16] DocBook: update function parameter description in network code
2005-03-03 10:28 Documentation update Martin Waitz
` (3 preceding siblings ...)
2005-03-03 10:41 ` [PATCH 2/16] DocBook: allow preprocessor directives between kernel-doc and function Martin Waitz
@ 2005-03-03 10:41 ` Martin Waitz
2005-03-03 10:41 ` [PATCH 4/16] DocBook: update function parameter description in block/fs code Martin Waitz
` (13 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:41 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
DocBook: update function parameter description in network code
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2028
# DocBook: update function parameter description in network code
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/drivers/net/8390.c b/drivers/net/8390.c
--- a/drivers/net/8390.c Thu Mar 3 11:41:34 2005
+++ b/drivers/net/8390.c Thu Mar 3 11:41:34 2005
@@ -999,6 +999,7 @@
/**
* alloc_ei_netdev - alloc_etherdev counterpart for 8390
+ * @size: extra bytes to allocate
*
* Allocate 8390-specific net_device.
*/
diff -Nru a/include/linux/skbuff.h b/include/linux/skbuff.h
--- a/include/linux/skbuff.h Thu Mar 3 11:41:34 2005
+++ b/include/linux/skbuff.h Thu Mar 3 11:41:34 2005
@@ -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 {
diff -Nru a/net/core/skbuff.c b/net/core/skbuff.c
--- a/net/core/skbuff.c Thu Mar 3 11:41:34 2005
+++ b/net/core/skbuff.c Thu Mar 3 11:41:34 2005
@@ -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)
{
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 4/16] DocBook: update function parameter description in block/fs code
2005-03-03 10:28 Documentation update Martin Waitz
` (4 preceding siblings ...)
2005-03-03 10:41 ` [PATCH 3/16] DocBook: update function parameter description in network code Martin Waitz
@ 2005-03-03 10:41 ` Martin Waitz
2005-03-03 10:41 ` [PATCH 5/16] DocBook: update function parameter description in USB code Martin Waitz
` (12 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:41 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
DocBook: update function parameter description in block/fs code
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2029
# DocBook: update function parameter description in block/fs code
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/drivers/block/ll_rw_blk.c b/drivers/block/ll_rw_blk.c
--- a/drivers/block/ll_rw_blk.c Thu Mar 3 11:41:42 2005
+++ b/drivers/block/ll_rw_blk.c Thu Mar 3 11:41:42 2005
@@ -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:
diff -Nru a/fs/jbd/journal.c b/fs/jbd/journal.c
--- a/fs/jbd/journal.c Thu Mar 3 11:41:42 2005
+++ b/fs/jbd/journal.c Thu Mar 3 11:41:42 2005
@@ -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.
diff -Nru a/fs/jbd/transaction.c b/fs/jbd/transaction.c
--- a/fs/jbd/transaction.c Thu Mar 3 11:41:43 2005
+++ b/fs/jbd/transaction.c Thu Mar 3 11:41:43 2005
@@ -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,
diff -Nru a/fs/super.c b/fs/super.c
--- a/fs/super.c Thu Mar 3 11:41:43 2005
+++ b/fs/super.c Thu Mar 3 11:41:43 2005
@@ -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.
diff -Nru a/include/linux/jbd.h b/include/linux/jbd.h
--- a/include/linux/jbd.h Thu Mar 3 11:41:43 2005
+++ b/include/linux/jbd.h Thu Mar 3 11:41:43 2005
@@ -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
diff -Nru a/kernel/sysctl.c b/kernel/sysctl.c
--- a/kernel/sysctl.c Thu Mar 3 11:41:42 2005
+++ b/kernel/sysctl.c Thu Mar 3 11:41:42 2005
@@ -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.
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 5/16] DocBook: update function parameter description in USB code
2005-03-03 10:28 Documentation update Martin Waitz
` (5 preceding siblings ...)
2005-03-03 10:41 ` [PATCH 4/16] DocBook: update function parameter description in block/fs code Martin Waitz
@ 2005-03-03 10:41 ` Martin Waitz
2005-03-03 10:41 ` [PATCH 6/16] DocBook: fix function parameter descriptin in fbmem Martin Waitz
` (11 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:41 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
DocBook: update function parameter description in USB code
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2030
# DocBook: update function parameter description in USB code
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/drivers/usb/core/hcd.c b/drivers/usb/core/hcd.c
--- a/drivers/usb/core/hcd.c Thu Mar 3 11:41:51 2005
+++ b/drivers/usb/core/hcd.c Thu Mar 3 11:41:51 2005
@@ -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
diff -Nru a/drivers/usb/core/hub.c b/drivers/usb/core/hub.c
--- a/drivers/usb/core/hub.c Thu Mar 3 11:41:51 2005
+++ b/drivers/usb/core/hub.c Thu Mar 3 11:41:51 2005
@@ -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
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 6/16] DocBook: fix function parameter descriptin in fbmem
2005-03-03 10:28 Documentation update Martin Waitz
` (6 preceding siblings ...)
2005-03-03 10:41 ` [PATCH 5/16] DocBook: update function parameter description in USB code Martin Waitz
@ 2005-03-03 10:41 ` Martin Waitz
2005-03-03 10:42 ` [PATCH 7/16] DocBook: new kernel-doc comments for might_sleep & wait_event_* Martin Waitz
` (10 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:41 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
DocBook: fix function parameter descriptin in fbmem
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2031
# DocBook: fix function parameter descriptin in fbmem
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/drivers/video/fbmem.c b/drivers/video/fbmem.c
--- a/drivers/video/fbmem.c Thu Mar 3 11:42:00 2005
+++ b/drivers/video/fbmem.c Thu Mar 3 11:42:00 2005
@@ -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
*/
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 7/16] DocBook: new kernel-doc comments for might_sleep & wait_event_*
2005-03-03 10:28 Documentation update Martin Waitz
` (7 preceding siblings ...)
2005-03-03 10:41 ` [PATCH 6/16] DocBook: fix function parameter descriptin in fbmem Martin Waitz
@ 2005-03-03 10:42 ` Martin Waitz
2005-03-03 10:42 ` [PATCH 8/16] DocBook: convert template files to XML Martin Waitz
` (9 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:42 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
DocBook: new kernel-doc comments for might_sleep & wait_event_*
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2032
# DocBook: new kernel-doc comments for might_sleep & wait_event_*
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/include/linux/kernel.h b/include/linux/kernel.h
--- a/include/linux/kernel.h Thu Mar 3 11:42:09 2005
+++ b/include/linux/kernel.h Thu Mar 3 11:42:09 2005
@@ -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)
diff -Nru a/include/linux/wait.h b/include/linux/wait.h
--- a/include/linux/wait.h Thu Mar 3 11:42:09 2005
+++ b/include/linux/wait.h Thu Mar 3 11:42:09 2005
@@ -169,6 +169,18 @@
finish_wait(&wq, &__wait); \
} while (0)
+/**
+ * wait_event - sleep until a condition gets true
+ * @wq: the waitqueue to wait on
+ * @condition: a C expression for the event to wait for
+ *
+ * The process is put to sleep (TASK_UNINTERRUPTIBLE) until the
+ * @condition evaluates to true. The @condition is checked each time
+ * the waitqueue @wq is woken up.
+ *
+ * wake_up() has to be called after changing any variable that could
+ * change the result of the wait condition.
+ */
#define wait_event(wq, condition) \
do { \
if (condition) \
@@ -191,6 +203,22 @@
finish_wait(&wq, &__wait); \
} while (0)
+/**
+ * wait_event_timeout - sleep until a condition gets true or a timeout elapses
+ * @wq: the waitqueue to wait on
+ * @condition: a C expression for the event to wait for
+ * @timeout: timeout, in jiffies
+ *
+ * The process is put to sleep (TASK_UNINTERRUPTIBLE) until the
+ * @condition evaluates to true. The @condition is checked each time
+ * the waitqueue @wq is woken up.
+ *
+ * wake_up() has to be called after changing any variable that could
+ * change the result of the wait condition.
+ *
+ * The function returns 0 if the @timeout elapsed, and the remaining
+ * jiffies if the condition evaluated to true before the timeout elapsed.
+ */
#define wait_event_timeout(wq, condition, timeout) \
({ \
long __ret = timeout; \
@@ -217,6 +245,21 @@
finish_wait(&wq, &__wait); \
} while (0)
+/**
+ * wait_event_interruptible - sleep until a condition gets true
+ * @wq: the waitqueue to wait on
+ * @condition: a C expression for the event to wait for
+ *
+ * The process is put to sleep (TASK_INTERRUPTIBLE) until the
+ * @condition evaluates to true or a signal is received.
+ * The @condition is checked each time the waitqueue @wq is woken up.
+ *
+ * wake_up() has to be called after changing any variable that could
+ * change the result of the wait condition.
+ *
+ * The function will return -ERESTARTSYS if it was interrupted by a
+ * signal and 0 if @condition evaluated to true.
+ */
#define wait_event_interruptible(wq, condition) \
({ \
int __ret = 0; \
@@ -245,6 +288,23 @@
finish_wait(&wq, &__wait); \
} while (0)
+/**
+ * wait_event_interruptible_timeout - sleep until a condition gets true or a timeout elapses
+ * @wq: the waitqueue to wait on
+ * @condition: a C expression for the event to wait for
+ * @timeout: timeout, in jiffies
+ *
+ * The process is put to sleep (TASK_INTERRUPTIBLE) until the
+ * @condition evaluates to true or a signal is received.
+ * The @condition is checked each time the waitqueue @wq is woken up.
+ *
+ * wake_up() has to be called after changing any variable that could
+ * change the result of the wait condition.
+ *
+ * The function returns 0 if the @timeout elapsed, -ERESTARTSYS if it
+ * was interrupted by a signal, and the remaining jiffies otherwise
+ * if the condition evaluated to true before the timeout elapsed.
+ */
#define wait_event_interruptible_timeout(wq, condition, timeout) \
({ \
long __ret = timeout; \
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 8/16] DocBook: convert template files to XML
2005-03-03 10:28 Documentation update Martin Waitz
` (8 preceding siblings ...)
2005-03-03 10:42 ` [PATCH 7/16] DocBook: new kernel-doc comments for might_sleep & wait_event_* Martin Waitz
@ 2005-03-03 10:42 ` Martin Waitz
2005-03-03 10:42 ` [PATCH 9/16] DocBook: s/sgml/xml/ in scripts/kernel-doc Martin Waitz
` (8 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:42 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
DocBook: convert template files to XML
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2033
# DocBook: convert template files to XML
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/Documentation/DocBook/deviceiobook.tmpl b/Documentation/DocBook/deviceiobook.tmpl
--- a/Documentation/DocBook/deviceiobook.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/deviceiobook.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/gadget.tmpl b/Documentation/DocBook/gadget.tmpl
--- a/Documentation/DocBook/gadget.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/gadget.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/journal-api.tmpl b/Documentation/DocBook/journal-api.tmpl
--- a/Documentation/DocBook/journal-api.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/journal-api.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl
--- a/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/kernel-hacking.tmpl b/Documentation/DocBook/kernel-hacking.tmpl
--- a/Documentation/DocBook/kernel-hacking.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/kernel-hacking.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/kernel-locking.tmpl b/Documentation/DocBook/kernel-locking.tmpl
--- a/Documentation/DocBook/kernel-locking.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/kernel-locking.tmpl Thu Mar 3 11:42:18 2005
@@ -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="LKLockingGuide">
<bookinfo>
@@ -236,12 +238,12 @@
your task will put itself on the queue, and be woken up when the
semaphore is released. This means the CPU will do something
else while you are waiting, but there are many cases when you
- simply can't sleep (see <xref linkend="sleeping-things">), and so
+ simply can't sleep (see <xref linkend="sleeping-things"/>), and so
have to use a spinlock instead.
</para>
<para>
Neither type of lock is recursive: see
- <xref linkend="deadlock">.
+ <xref linkend="deadlock"/>.
</para>
</sect1>
@@ -326,7 +328,7 @@
<para>
Note that you can also use <function>spin_lock_irq()</function>
or <function>spin_lock_irqsave()</function> here, which stop
- hardware interrupts as well: see <xref linkend="hardirq-context">.
+ hardware interrupts as well: see <xref linkend="hardirq-context"/>.
</para>
<para>
@@ -403,7 +405,7 @@
<para>
The same softirq can run on the other CPUs: you can use a
- per-CPU array (see <xref linkend="per-cpu">) for better
+ per-CPU array (see <xref linkend="per-cpu"/>) for better
performance. If you're going so far as to use a softirq,
you probably care about scalable performance enough
to justify the extra complexity.
@@ -545,120 +547,120 @@
</para>
<table>
<title>Table of Locking Requirements</title>
-<TGROUP COLS="11">
-<TBODY>
-<ROW>
-<ENTRY></ENTRY>
-<ENTRY>IRQ Handler A</ENTRY>
-<ENTRY>IRQ Handler B</ENTRY>
-<ENTRY>Softirq A</ENTRY>
-<ENTRY>Softirq B</ENTRY>
-<ENTRY>Tasklet A</ENTRY>
-<ENTRY>Tasklet B</ENTRY>
-<ENTRY>Timer A</ENTRY>
-<ENTRY>Timer B</ENTRY>
-<ENTRY>User Context A</ENTRY>
-<ENTRY>User Context B</ENTRY>
-</ROW>
-
-<ROW>
-<ENTRY>IRQ Handler A</ENTRY>
-<ENTRY>None</ENTRY>
-</ROW>
-
-<ROW>
-<ENTRY>IRQ Handler B</ENTRY>
-<ENTRY>spin_lock_irqsave</ENTRY>
-<ENTRY>None</ENTRY>
-</ROW>
-
-<ROW>
-<ENTRY>Softirq A</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-</ROW>
-
-<ROW>
-<ENTRY>Softirq B</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-</ROW>
-
-<ROW>
-<ENTRY>Tasklet A</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>None</ENTRY>
-</ROW>
-
-<ROW>
-<ENTRY>Tasklet B</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>None</ENTRY>
-</ROW>
-
-<ROW>
-<ENTRY>Timer A</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>None</ENTRY>
-</ROW>
-
-<ROW>
-<ENTRY>Timer B</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>spin_lock</ENTRY>
-<ENTRY>None</ENTRY>
-</ROW>
-
-<ROW>
-<ENTRY>User Context A</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock_bh</ENTRY>
-<ENTRY>spin_lock_bh</ENTRY>
-<ENTRY>spin_lock_bh</ENTRY>
-<ENTRY>spin_lock_bh</ENTRY>
-<ENTRY>spin_lock_bh</ENTRY>
-<ENTRY>spin_lock_bh</ENTRY>
-<ENTRY>None</ENTRY>
-</ROW>
-
-<ROW>
-<ENTRY>User Context B</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock_irq</ENTRY>
-<ENTRY>spin_lock_bh</ENTRY>
-<ENTRY>spin_lock_bh</ENTRY>
-<ENTRY>spin_lock_bh</ENTRY>
-<ENTRY>spin_lock_bh</ENTRY>
-<ENTRY>spin_lock_bh</ENTRY>
-<ENTRY>spin_lock_bh</ENTRY>
-<ENTRY>down_interruptible</ENTRY>
-<ENTRY>None</ENTRY>
-</ROW>
-
-</TBODY>
-</TGROUP>
-</TABLE>
+<tgroup cols="11">
+<tbody>
+<row>
+<entry></entry>
+<entry>IRQ Handler A</entry>
+<entry>IRQ Handler B</entry>
+<entry>Softirq A</entry>
+<entry>Softirq B</entry>
+<entry>Tasklet A</entry>
+<entry>Tasklet B</entry>
+<entry>Timer A</entry>
+<entry>Timer B</entry>
+<entry>User Context A</entry>
+<entry>User Context B</entry>
+</row>
+
+<row>
+<entry>IRQ Handler A</entry>
+<entry>None</entry>
+</row>
+
+<row>
+<entry>IRQ Handler B</entry>
+<entry>spin_lock_irqsave</entry>
+<entry>None</entry>
+</row>
+
+<row>
+<entry>Softirq A</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock</entry>
+</row>
+
+<row>
+<entry>Softirq B</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock</entry>
+<entry>spin_lock</entry>
+</row>
+
+<row>
+<entry>Tasklet A</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock</entry>
+<entry>spin_lock</entry>
+<entry>None</entry>
+</row>
+
+<row>
+<entry>Tasklet B</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock</entry>
+<entry>spin_lock</entry>
+<entry>spin_lock</entry>
+<entry>None</entry>
+</row>
+
+<row>
+<entry>Timer A</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock</entry>
+<entry>spin_lock</entry>
+<entry>spin_lock</entry>
+<entry>spin_lock</entry>
+<entry>None</entry>
+</row>
+
+<row>
+<entry>Timer B</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock</entry>
+<entry>spin_lock</entry>
+<entry>spin_lock</entry>
+<entry>spin_lock</entry>
+<entry>spin_lock</entry>
+<entry>None</entry>
+</row>
+
+<row>
+<entry>User Context A</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock_bh</entry>
+<entry>spin_lock_bh</entry>
+<entry>spin_lock_bh</entry>
+<entry>spin_lock_bh</entry>
+<entry>spin_lock_bh</entry>
+<entry>spin_lock_bh</entry>
+<entry>None</entry>
+</row>
+
+<row>
+<entry>User Context B</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock_irq</entry>
+<entry>spin_lock_bh</entry>
+<entry>spin_lock_bh</entry>
+<entry>spin_lock_bh</entry>
+<entry>spin_lock_bh</entry>
+<entry>spin_lock_bh</entry>
+<entry>spin_lock_bh</entry>
+<entry>down_interruptible</entry>
+<entry>None</entry>
+</row>
+
+</tbody>
+</tgroup>
+</table>
</sect1>
</chapter>
diff -Nru a/Documentation/DocBook/libata.tmpl b/Documentation/DocBook/libata.tmpl
--- a/Documentation/DocBook/libata.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/libata.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/librs.tmpl b/Documentation/DocBook/librs.tmpl
--- a/Documentation/DocBook/librs.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/librs.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/lsm.tmpl b/Documentation/DocBook/lsm.tmpl
--- a/Documentation/DocBook/lsm.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/lsm.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/mcabook.tmpl b/Documentation/DocBook/mcabook.tmpl
--- a/Documentation/DocBook/mcabook.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/mcabook.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/mtdnand.tmpl b/Documentation/DocBook/mtdnand.tmpl
--- a/Documentation/DocBook/mtdnand.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/mtdnand.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/procfs-guide.tmpl b/Documentation/DocBook/procfs-guide.tmpl
--- a/Documentation/DocBook/procfs-guide.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/procfs-guide.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/scsidrivers.tmpl b/Documentation/DocBook/scsidrivers.tmpl
--- a/Documentation/DocBook/scsidrivers.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/scsidrivers.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/sis900.tmpl b/Documentation/DocBook/sis900.tmpl
--- a/Documentation/DocBook/sis900.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/sis900.tmpl Thu Mar 3 11:42:18 2005
@@ -1,25 +1,27 @@
-<!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="SiS900Guide">
<bookinfo>
-<title>SiS 900/7016 Fast Ethernet Device Driver</Title>
+<title>SiS 900/7016 Fast Ethernet Device Driver</title>
<authorgroup>
<author>
-<FirstName>Ollie</FirstName>
+<firstname>Ollie</firstname>
<surname>Lho</surname>
</author>
<author>
-<FirstName>Lei Chun</FirstName>
+<firstname>Lei Chun</firstname>
<surname>Chang</surname>
</author>
</authorgroup>
<edition>Document Revision: 0.3 for SiS900 driver v1.06 & v1.07</edition>
-<PubDate>November 16, 2000</PubDate>
+<pubdate>November 16, 2000</pubdate>
<copyright>
<year>1999</year>
@@ -48,21 +50,21 @@
</para>
</legalnotice>
-<Abstract>
-<Para>
+<abstract>
+<para>
This document gives some information on installation and usage of SiS 900/7016
device driver under Linux.
-</Para>
-</Abstract>
+</para>
+</abstract>
</bookinfo>
<toc></toc>
<chapter id="intro">
- <Title>Introduction</Title>
+ <title>Introduction</title>
-<Para>
+<para>
This document describes the revision 1.06 and 1.07 of SiS 900/7016 Fast Ethernet
device driver under Linux. The driver is developed by Silicon Integrated
System Corp. and distributed freely under the GNU General Public License (GPL).
@@ -70,265 +72,265 @@
version 2.2.x. (rev. 1.06)
With minimal changes, the driver can also be used under 2.3.x and 2.4.x kernel
(rev. 1.07), please see
-<XRef LinkEnd="install">. If you are intended to
+<xref linkend="install"/>. If you are intended to
use the driver for earlier kernels, you are on your own.
-</Para>
+</para>
-<Para>
+<para>
The driver is tested with usual TCP/IP applications including
FTP, Telnet, Netscape etc. and is used constantly by the developers.
-</Para>
+</para>
-<Para>
+<para>
Please send all comments/fixes/questions to
-<ULink URL="mailto:lcchang@sis.com.tw">Lei-Chun Chang</ULink>.
-</Para>
+<ulink url="mailto:lcchang@sis.com.tw">Lei-Chun Chang</ulink>.
+</para>
</chapter>
<chapter id="changes">
- <Title>Changes</Title>
+ <title>Changes</title>
-<Para>
+<para>
Changes made in Revision 1.07
-<OrderedList>
-<ListItem>
-<Para>
+<orderedlist>
+<listitem>
+<para>
Separation of sis900.c and sis900.h in order to move most
constant definition to sis900.h (many of those constants were
corrected)
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
Clean up PCI detection, the pci-scan from Donald Becker were not used,
just simple pci_find_*.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
MII detection is modified to support multiple mii transceiver.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
Bugs in read_eeprom, mdio_* were removed.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
Lot of sis900 irrelevant comments were removed/changed and
more comments were added to reflect the real situation.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
Clean up of physical/virtual address space mess in buffer
descriptors.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
Better transmit/receive error handling.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
The driver now uses zero-copy single buffer management
scheme to improve performance.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
Names of variables were changed to be more consistent.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
Clean up of auo-negotiation and timer code.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
Automatic detection and change of PHY on the fly.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
Bug in mac probing fixed.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
Fix 630E equalier problem by modifying the equalizer workaround rule.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
Support for ICS1893 10/100 Interated PHYceiver.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
Support for media select by ifconfig.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
Added kernel-doc extratable documentation.
-</Para>
-</ListItem>
+</para>
+</listitem>
-</OrderedList>
-</Para>
+</orderedlist>
+</para>
</chapter>
<chapter id="tested">
- <Title>Tested Environment</Title>
+ <title>Tested Environment</title>
-<Para>
+<para>
This driver is developed on the following hardware
-<ItemizedList>
-<ListItem>
+<itemizedlist>
+<listitem>
-<Para>
+<para>
Intel Celeron 500 with SiS 630 (rev 02) chipset
-</Para>
-</ListItem>
-<ListItem>
+</para>
+</listitem>
+<listitem>
-<Para>
+<para>
SiS 900 (rev 01) and SiS 7016/7014 Fast Ethernet Card
-</Para>
-</ListItem>
+</para>
+</listitem>
-</ItemizedList>
+</itemizedlist>
and tested with these software environments
-<ItemizedList>
-<ListItem>
+<itemizedlist>
+<listitem>
-<Para>
+<para>
Red Hat Linux version 6.2
-</Para>
-</ListItem>
-<ListItem>
+</para>
+</listitem>
+<listitem>
-<Para>
+<para>
Linux kernel version 2.4.0
-</Para>
-</ListItem>
-<ListItem>
+</para>
+</listitem>
+<listitem>
-<Para>
+<para>
Netscape version 4.6
-</Para>
-</ListItem>
-<ListItem>
+</para>
+</listitem>
+<listitem>
-<Para>
+<para>
NcFTP 3.0.0 beta 18
-</Para>
-</ListItem>
-<ListItem>
+</para>
+</listitem>
+<listitem>
-<Para>
+<para>
Samba version 2.0.3
-</Para>
-</ListItem>
+</para>
+</listitem>
-</ItemizedList>
+</itemizedlist>
-</Para>
+</para>
</chapter>
<chapter id="files">
-<Title>Files in This Package</Title>
+<title>Files in This Package</title>
-<Para>
+<para>
In the package you can find these files:
-</Para>
+</para>
-<Para>
-<VariableList>
+<para>
+<variablelist>
-<VarListEntry>
-<Term>sis900.c</Term>
-<ListItem>
-<Para>
+<varlistentry>
+<term>sis900.c</term>
+<listitem>
+<para>
Driver source file in C
-</Para>
-</ListItem>
-</VarListEntry>
-
-<VarListEntry>
-<Term>sis900.h</Term>
-<ListItem>
-<Para>
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>sis900.h</term>
+<listitem>
+<para>
Header file for sis900.c
-</Para>
-</ListItem>
-</VarListEntry>
-
-<VarListEntry>
-<Term>sis900.sgml</Term>
-<ListItem>
-<Para>
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>sis900.sgml</term>
+<listitem>
+<para>
DocBook SGML source of the document
-</Para>
-</ListItem>
-</VarListEntry>
-
-<VarListEntry>
-<Term>sis900.txt</Term>
-<ListItem>
-<Para>
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>sis900.txt</term>
+<listitem>
+<para>
Driver document in plain text
-</Para>
-</ListItem>
-</VarListEntry>
+</para>
+</listitem>
+</varlistentry>
-</VariableList>
-</Para>
+</variablelist>
+</para>
</chapter>
<chapter id="install">
- <Title>Installation</Title>
+ <title>Installation</title>
-<Para>
+<para>
Silicon Integrated System Corp. is cooperating closely with core Linux Kernel
developers. The revisions of SiS 900 driver are distributed by the usuall channels
for kernel tar files and patches. Those kernel tar files for official kernel and
patches for kernel pre-release can be download at
-<ULink URL="http://ftp.kernel.org/pub/linux/kernel/">official kernel ftp site</ULink>
+<ulink url="http://ftp.kernel.org/pub/linux/kernel/">official kernel ftp site</ulink>
and its mirrors.
The 1.06 revision can be found in kernel version later than 2.3.15 and pre-2.2.14,
and 1.07 revision can be found in kernel version 2.4.0.
If you have no prior experience in networking under Linux, please read
-<ULink URL="http://www.tldp.org/">Ethernet HOWTO</ULink> and
-<ULink URL="http://www.tldp.org/">Networking HOWTO</ULink> available from
+<ulink url="http://www.tldp.org/">Ethernet HOWTO</ulink> and
+<ulink url="http://www.tldp.org/">Networking HOWTO</ulink> available from
Linux Documentation Project (LDP).
-</Para>
+</para>
-<Para>
+<para>
The driver is bundled in release later than 2.2.11 and 2.3.15 so this
is the most easy case.
Be sure you have the appropriate packages for compiling kernel source.
@@ -338,63 +340,63 @@
<filename>sis900.c</filename> and <filename>sis900.h</filename>
copied into <filename class="directory">/usr/src/linux/drivers/net/</filename> first.
There are two alternative ways to install the driver
-</Para>
+</para>
-<Sect1>
-<Title>Building the driver as loadable module</Title>
+<sect1>
+<title>Building the driver as loadable module</title>
-<Para>
+<para>
To build the driver as a loadable kernel module you have to reconfigure
the kernel to activate network support by
-</Para>
+</para>
-<Para><screen>
+<para><screen>
make menuconfig
-</screen></Para>
+</screen></para>
-<Para>
+<para>
Choose <quote>Loadable module support ---></quote>,
then select <quote>Enable loadable module support</quote>.
-</Para>
+</para>
-<Para>
+<para>
Choose <quote>Network Device Support ---></quote>, select
<quote>Ethernet (10 or 100Mbit)</quote>.
Then select <quote>EISA, VLB, PCI and on board controllers</quote>,
and choose <quote>SiS 900/7016 PCI Fast Ethernet Adapter support</quote>
to <quote>M</quote>.
-</Para>
+</para>
-<Para>
+<para>
After reconfiguring the kernel, you can make the driver module by
-</Para>
+</para>
-<Para><screen>
+<para><screen>
make modules
-</screen></Para>
+</screen></para>
-<Para>
+<para>
The driver should be compiled with no errors. After compiling the driver,
the driver can be installed to proper place by
-</Para>
+</para>
-<Para><screen>
+<para><screen>
make modules_install
-</screen></Para>
+</screen></para>
-<Para>
+<para>
Load the driver into kernel by
-</Para>
+</para>
-<Para><screen>
+<para><screen>
insmod sis900
-</screen></Para>
+</screen></para>
-<Para>
+<para>
When loading the driver into memory, some information message can be view by
-</Para>
+</para>
-<Para>
+<para>
<screen>
dmesg
</screen>
@@ -404,103 +406,103 @@
<screen>
cat /var/log/message
</screen>
-</Para>
+</para>
-<Para>
+<para>
If the driver is loaded properly you will have messages similar to this:
-</Para>
+</para>
-<Para><screen>
+<para><screen>
sis900.c: v1.07.06 11/07/2000
eth0: SiS 900 PCI Fast Ethernet at 0xd000, IRQ 10, 00:00:e8:83:7f:a4.
eth0: SiS 900 Internal MII PHY transceiver found at address 1.
eth0: Using SiS 900 Internal MII PHY as default
-</screen></Para>
+</screen></para>
-<Para>
+<para>
showing the version of the driver and the results of probing routine.
-</Para>
+</para>
-<Para>
+<para>
Once the driver is loaded, network can be brought up by
-</Para>
+</para>
-<Para><screen>
+<para><screen>
/sbin/ifconfig eth0 IPADDR broadcast BROADCAST netmask NETMASK media TYPE
-</screen></Para>
+</screen></para>
-<Para>
+<para>
where IPADDR, BROADCAST, NETMASK are your IP address, broadcast address and
netmask respectively. TYPE is used to set medium type used by the device.
Typical values are "10baseT"(twisted-pair 10Mbps Ethernet) or "100baseT"
(twisted-pair 100Mbps Ethernet). For more information on how to configure
network interface, please refer to
-<ULink URL="http://www.tldp.org/">Networking HOWTO</ULink>.
-</Para>
+<ulink url="http://www.tldp.org/">Networking HOWTO</ulink>.
+</para>
-<Para>
+<para>
The link status is also shown by kernel messages. For example, after the
network interface is activated, you may have the message:
-</Para>
+</para>
-<Para><screen>
+<para><screen>
eth0: Media Link On 100mbps full-duplex
-</screen></Para>
+</screen></para>
-<Para>
+<para>
If you try to unplug the twist pair (TP) cable you will get
-</Para>
+</para>
-<Para><screen>
+<para><screen>
eth0: Media Link Off
-</screen></Para>
+</screen></para>
-<Para>
+<para>
indicating that the link is failed.
-</Para>
-</Sect1>
+</para>
+</sect1>
-<Sect1>
-<Title>Building the driver into kernel</Title>
+<sect1>
+<title>Building the driver into kernel</title>
-<Para>
+<para>
If you want to make the driver into kernel, choose <quote>Y</quote>
rather than <quote>M</quote> on
<quote>SiS 900/7016 PCI Fast Ethernet Adapter support</quote>
when configuring the kernel. Build the kernel image in the usual way
-</Para>
+</para>
-<Para><screen>
+<para><screen>
make clean
make bzlilo
-</screen></Para>
+</screen></para>
-<Para>
+<para>
Next time the system reboot, you have the driver in memory.
-</Para>
+</para>
-</Sect1>
+</sect1>
</chapter>
<chapter id="problems">
- <Title>Known Problems and Bugs</Title>
+ <title>Known Problems and Bugs</title>
-<Para>
+<para>
There are some known problems and bugs. If you find any other bugs please
-mail to <ULink URL="mailto:lcchang@sis.com.tw">lcchang@sis.com.tw</ULink>
+mail to <ulink url="mailto:lcchang@sis.com.tw">lcchang@sis.com.tw</ulink>
-<OrderedList>
+<orderedlist>
-<ListItem>
-<Para>
+<listitem>
+<para>
AM79C901 HomePNA PHY is not thoroughly tested, there may be some
bugs in the <quote>on the fly</quote> change of transceiver.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
A bug is hidden somewhere in the receive buffer management code,
the bug causes NULL pointer reference in the kernel. This fault is
caught before bad things happen and reported with the message:
@@ -509,70 +511,70 @@
eth0: NULL pointer encountered in Rx ring, skipping
</computeroutput>
-which can be viewed with <Literal remap="tt">dmesg</Literal> or
-<Literal remap="tt">cat /var/log/message</Literal>.
-</Para>
-</ListItem>
+which can be viewed with <literal remap="tt">dmesg</literal> or
+<literal remap="tt">cat /var/log/message</literal>.
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
The media type change from 10Mbps to 100Mbps twisted-pair ethernet
by ifconfig causes the media link down.
-</Para>
-</ListItem>
+</para>
+</listitem>
-</OrderedList>
-</Para>
+</orderedlist>
+</para>
</chapter>
<chapter id="RHistory">
- <Title>Revision History</Title>
+ <title>Revision History</title>
-<Para>
-<ItemizedList>
+<para>
+<itemizedlist>
-<ListItem>
-<Para>
+<listitem>
+<para>
November 13, 2000, Revision 1.07, seventh release, 630E problem fixed
and further clean up.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
November 4, 1999, Revision 1.06, Second release, lots of clean up
and optimization.
-</Para>
-</ListItem>
+</para>
+</listitem>
-<ListItem>
-<Para>
+<listitem>
+<para>
August 8, 1999, Revision 1.05, Initial Public Release
-</Para>
-</ListItem>
+</para>
+</listitem>
-</ItemizedList>
-</Para>
+</itemizedlist>
+</para>
</chapter>
<chapter id="acknowledgements">
- <Title>Acknowledgements</Title>
+ <title>Acknowledgements</title>
-<Para>
+<para>
This driver was originally derived form
-<ULink URL="mailto:becker@cesdis1.gsfc.nasa.gov">Donald Becker</ULink>'s
-<ULink URL="ftp://cesdis.gsfc.nasa.gov/pub/linux/drivers/kern-2.3/pci-skeleton.c"
->pci-skeleton</ULink> and
-<ULink URL="ftp://cesdis.gsfc.nasa.gov/pub/linux/drivers/kern-2.3/rtl8139.c"
->rtl8139</ULink> drivers. Donald also provided various suggestion
+<ulink url="mailto:becker@cesdis1.gsfc.nasa.gov">Donald Becker</ulink>'s
+<ulink url="ftp://cesdis.gsfc.nasa.gov/pub/linux/drivers/kern-2.3/pci-skeleton.c"
+>pci-skeleton</ulink> and
+<ulink url="ftp://cesdis.gsfc.nasa.gov/pub/linux/drivers/kern-2.3/rtl8139.c"
+>rtl8139</ulink> drivers. Donald also provided various suggestion
regarded with improvements made in revision 1.06.
-</Para>
+</para>
-<Para>
+<para>
The 1.05 revision was created by
-<ULink URL="mailto:cmhuang@sis.com.tw">Jim Huang</ULink>, AMD 79c901
-support was added by <ULink URL="mailto:lcs@sis.com.tw">Chin-Shan Li</ULink>.
-</Para>
+<ulink url="mailto:cmhuang@sis.com.tw">Jim Huang</ulink>, AMD 79c901
+support was added by <ulink url="mailto:lcs@sis.com.tw">Chin-Shan Li</ulink>.
+</para>
</chapter>
<chapter id="functions">
diff -Nru a/Documentation/DocBook/tulip-user.tmpl b/Documentation/DocBook/tulip-user.tmpl
--- a/Documentation/DocBook/tulip-user.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/tulip-user.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/usb.tmpl b/Documentation/DocBook/usb.tmpl
--- a/Documentation/DocBook/usb.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/usb.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/via-audio.tmpl b/Documentation/DocBook/via-audio.tmpl
--- a/Documentation/DocBook/via-audio.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/via-audio.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/videobook.tmpl b/Documentation/DocBook/videobook.tmpl
--- a/Documentation/DocBook/videobook.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/videobook.tmpl Thu Mar 3 11:42:18 2005
@@ -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="V4LGuide">
<bookinfo>
@@ -180,23 +182,23 @@
<tgroup cols="3" align="left">
<tbody>
<row>
- <entry>VFL_TYPE_RADIO</><entry>/dev/radio{n}</><entry>
+ <entry>VFL_TYPE_RADIO</entry><entry>/dev/radio{n}</entry><entry>
Radio devices are assigned in this block. As with all of these
selections the actual number assignment is done by the video layer
accordijng to what is free.</entry>
</row><row>
- <entry>VFL_TYPE_GRABBER</><entry>/dev/video{n}</><entry>
+ <entry>VFL_TYPE_GRABBER</entry><entry>/dev/video{n}</entry><entry>
Video capture devices and also -- counter-intuitively for the name --
hardware video playback devices such as MPEG2 cards.</entry>
</row><row>
- <entry>VFL_TYPE_VBI</><entry>/dev/vbi{n}</><entry>
+ <entry>VFL_TYPE_VBI</entry><entry>/dev/vbi{n}</entry><entry>
The VBI devices capture the hidden lines on a television picture
that carry further information like closed caption data, teletext
(primarily in Europe) and now Intercast and the ATVEC internet
television encodings.</entry>
</row><row>
- <entry>VFL_TYPE_VTX</><entry>/dev/vtx[n}</><entry>
+ <entry>VFL_TYPE_VTX</entry><entry>/dev/vtx[n}</entry><entry>
VTX is 'Videotext' also known as 'Teletext'. This is a system for
sending numbered, 40x25, mostly textual page images over the hidden
lines. Unlike the /dev/vbi interfaces, this is for 'smart' decoder
@@ -301,25 +303,25 @@
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>name</><entry>The device text name. This is intended for the user.</>
+ <entry>name</entry><entry>The device text name. This is intended for the user.</entry>
</row><row>
- <entry>channels</><entry>The number of different channels you can tune on
+ <entry>channels</entry><entry>The number of different channels you can tune on
this card. It could even by zero for a card that has
no tuning capability. For our simple FM radio it is 1.
An AM/FM radio would report 2.</entry>
</row><row>
- <entry>audios</><entry>The number of audio inputs on this device. For our
+ <entry>audios</entry><entry>The number of audio inputs on this device. For our
radio there is only one audio input.</entry>
</row><row>
- <entry>minwidth,minheight</><entry>The smallest size the card is capable of capturing
+ <entry>minwidth,minheight</entry><entry>The smallest size the card is capable of capturing
images in. We set these to zero. Radios do not
capture pictures</entry>
</row><row>
- <entry>maxwidth,maxheight</><entry>The largest image size the card is capable of
+ <entry>maxwidth,maxheight</entry><entry>The largest image size the card is capable of
capturing. For our radio we report 0.
</entry>
</row><row>
- <entry>type</><entry>This reports the capabilities of the device, and
+ <entry>type</entry><entry>This reports the capabilities of the device, and
matches the field we filled in in the struct
video_device when registering.</entry>
</row>
@@ -375,26 +377,26 @@
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>int tuner</><entry>The number of the tuner in question</entry>
+ <entry>int tuner</entry><entry>The number of the tuner in question</entry>
</row><row>
- <entry>char name[32]</><entry>A text description of this tuner. "FM" will do fine.
+ <entry>char name[32]</entry><entry>A text description of this tuner. "FM" will do fine.
This is intended for the application.</entry>
</row><row>
- <entry>u32 flags</>
+ <entry>u32 flags</entry>
<entry>Tuner capability flags</entry>
</row>
<row>
- <entry>u16 mode</><entry>The current reception mode</entry>
+ <entry>u16 mode</entry><entry>The current reception mode</entry>
</row><row>
- <entry>u16 signal</><entry>The signal strength scaled between 0 and 65535. If
+ <entry>u16 signal</entry><entry>The signal strength scaled between 0 and 65535. If
a device cannot tell the signal strength it should
report 65535. Many simple cards contain only a
signal/no signal bit. Such cards will report either
0 or 65535.</entry>
</row><row>
- <entry>u32 rangelow, rangehigh</><entry>
+ <entry>u32 rangelow, rangehigh</entry><entry>
The range of frequencies supported by the radio
or TV. It is scaled according to the VIDEO_TUNER_LOW
flag.</entry>
@@ -408,20 +410,20 @@
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>VIDEO_TUNER_PAL</><entry>A PAL TV tuner</entry>
+ <entry>VIDEO_TUNER_PAL</entry><entry>A PAL TV tuner</entry>
</row><row>
- <entry>VIDEO_TUNER_NTSC</><entry>An NTSC (US) TV tuner</entry>
+ <entry>VIDEO_TUNER_NTSC</entry><entry>An NTSC (US) TV tuner</entry>
</row><row>
- <entry>VIDEO_TUNER_SECAM</><entry>A SECAM (French) TV tuner</entry>
+ <entry>VIDEO_TUNER_SECAM</entry><entry>A SECAM (French) TV tuner</entry>
</row><row>
- <entry>VIDEO_TUNER_LOW</><entry>
+ <entry>VIDEO_TUNER_LOW</entry><entry>
The tuner frequency is scaled in 1/16th of a KHz
steps. If not it is in 1/16th of a MHz steps
</entry>
</row><row>
- <entry>VIDEO_TUNER_NORM</><entry>The tuner can set its format</entry>
+ <entry>VIDEO_TUNER_NORM</entry><entry>The tuner can set its format</entry>
</row><row>
- <entry>VIDEO_TUNER_STEREO_ON</><entry>The tuner is currently receiving a stereo signal</entry>
+ <entry>VIDEO_TUNER_STEREO_ON</entry><entry>The tuner is currently receiving a stereo signal</entry>
</row>
</tbody>
</tgroup>
@@ -431,13 +433,13 @@
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>VIDEO_MODE_PAL</><entry>PAL Format</entry>
+ <entry>VIDEO_MODE_PAL</entry><entry>PAL Format</entry>
</row><row>
- <entry>VIDEO_MODE_NTSC</><entry>NTSC Format (USA)</entry>
+ <entry>VIDEO_MODE_NTSC</entry><entry>NTSC Format (USA)</entry>
</row><row>
- <entry>VIDEO_MODE_SECAM</><entry>French Format</entry>
+ <entry>VIDEO_MODE_SECAM</entry><entry>French Format</entry>
</row><row>
- <entry>VIDEO_MODE_AUTO</><entry>A device that does not need to do
+ <entry>VIDEO_MODE_AUTO</entry><entry>A device that does not need to do
TV format switching</entry>
</row>
</tbody>
@@ -582,32 +584,32 @@
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>audio</><entry>The input the user wishes to query</>
+ <entry>audio</entry><entry>The input the user wishes to query</entry>
</row><row>
- <entry>volume</><entry>The volume setting on a scale of 0-65535</>
+ <entry>volume</entry><entry>The volume setting on a scale of 0-65535</entry>
</row><row>
- <entry>base</><entry>The base level on a scale of 0-65535</>
+ <entry>base</entry><entry>The base level on a scale of 0-65535</entry>
</row><row>
- <entry>treble</><entry>The treble level on a scale of 0-65535</>
+ <entry>treble</entry><entry>The treble level on a scale of 0-65535</entry>
</row><row>
- <entry>flags</><entry>The features this audio device supports
+ <entry>flags</entry><entry>The features this audio device supports
</entry>
</row><row>
- <entry>name</><entry>A text name to display to the user. We picked
- "Radio" as it explains things quite nicely.</>
+ <entry>name</entry><entry>A text name to display to the user. We picked
+ "Radio" as it explains things quite nicely.</entry>
</row><row>
- <entry>mode</><entry>The current reception mode for the audio
+ <entry>mode</entry><entry>The current reception mode for the audio
We report MONO because our card is too stupid to know if it is in
mono or stereo.
</entry>
</row><row>
- <entry>balance</><entry>The stereo balance on a scale of 0-65535, 32768 is
- middle.</>
+ <entry>balance</entry><entry>The stereo balance on a scale of 0-65535, 32768 is
+ middle.</entry>
</row><row>
- <entry>step</><entry>The step by which the volume control jumps. This is
+ <entry>step</entry><entry>The step by which the volume control jumps. This is
used to help make it easy for applications to set
- slider behaviour.</>
+ slider behaviour.</entry>
</row>
</tbody>
</tgroup>
@@ -617,15 +619,15 @@
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>VIDEO_AUDIO_MUTE</><entry>The audio is currently muted. We
+ <entry>VIDEO_AUDIO_MUTE</entry><entry>The audio is currently muted. We
could fake this in our driver but we
choose not to bother.</entry>
</row><row>
- <entry>VIDEO_AUDIO_MUTABLE</><entry>The input has a mute option</entry>
+ <entry>VIDEO_AUDIO_MUTABLE</entry><entry>The input has a mute option</entry>
</row><row>
- <entry>VIDEO_AUDIO_TREBLE</><entry>The input has a treble control</entry>
+ <entry>VIDEO_AUDIO_TREBLE</entry><entry>The input has a treble control</entry>
</row><row>
- <entry>VIDEO_AUDIO_BASS</><entry>The input has a base control</entry>
+ <entry>VIDEO_AUDIO_BASS</entry><entry>The input has a base control</entry>
</row>
</tbody>
</tgroup>
@@ -635,13 +637,13 @@
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>VIDEO_SOUND_MONO</><entry>Mono sound</entry>
+ <entry>VIDEO_SOUND_MONO</entry><entry>Mono sound</entry>
</row><row>
- <entry>VIDEO_SOUND_STEREO</><entry>Stereo sound</entry>
+ <entry>VIDEO_SOUND_STEREO</entry><entry>Stereo sound</entry>
</row><row>
- <entry>VIDEO_SOUND_LANG1</><entry>Alternative language 1 (TV specific)</entry>
+ <entry>VIDEO_SOUND_LANG1</entry><entry>Alternative language 1 (TV specific)</entry>
</row><row>
- <entry>VIDEO_SOUND_LANG2</><entry>Alternative language 2 (TV specific)</entry>
+ <entry>VIDEO_SOUND_LANG2</entry><entry>Alternative language 2 (TV specific)</entry>
</row>
</tbody>
</tgroup>
@@ -866,37 +868,37 @@
<tgroup cols="2" align="left">
<tbody>
<row>
-<entry>VID_TYPE_CAPTURE</><entry>We support image capture</>
+<entry>VID_TYPE_CAPTURE</entry><entry>We support image capture</entry>
</row><row>
-<entry>VID_TYPE_TELETEXT</><entry>A teletext capture device (vbi{n])</>
+<entry>VID_TYPE_TELETEXT</entry><entry>A teletext capture device (vbi{n])</entry>
</row><row>
-<entry>VID_TYPE_OVERLAY</><entry>The image can be directly overlaid onto the
- frame buffer</>
+<entry>VID_TYPE_OVERLAY</entry><entry>The image can be directly overlaid onto the
+ frame buffer</entry>
</row><row>
-<entry>VID_TYPE_CHROMAKEY</><entry>Chromakey can be used to select which parts
- of the image to display</>
+<entry>VID_TYPE_CHROMAKEY</entry><entry>Chromakey can be used to select which parts
+ of the image to display</entry>
</row><row>
-<entry>VID_TYPE_CLIPPING</><entry>It is possible to give the board a list of
- rectangles to draw around. </>
+<entry>VID_TYPE_CLIPPING</entry><entry>It is possible to give the board a list of
+ rectangles to draw around. </entry>
</row><row>
-<entry>VID_TYPE_FRAMERAM</><entry>The video capture goes into the video memory
+<entry>VID_TYPE_FRAMERAM</entry><entry>The video capture goes into the video memory
and actually changes it. Applications need
to know this so they can clean up after the
- card</>
+ card</entry>
</row><row>
-<entry>VID_TYPE_SCALES</><entry>The image can be scaled to various sizes,
- rather than being a single fixed size.</>
+<entry>VID_TYPE_SCALES</entry><entry>The image can be scaled to various sizes,
+ rather than being a single fixed size.</entry>
</row><row>
-<entry>VID_TYPE_MONOCHROME</><entry>The capture will be monochrome. This isn't a
+<entry>VID_TYPE_MONOCHROME</entry><entry>The capture will be monochrome. This isn't a
complete answer to the question since a mono
camera on a colour capture card will still
- produce mono output.</>
+ produce mono output.</entry>
</row><row>
-<entry>VID_TYPE_SUBCAPTURE</><entry>The card allows only part of its field of
+<entry>VID_TYPE_SUBCAPTURE</entry><entry>The card allows only part of its field of
view to be captured. This enables
applications to avoid copying all of a large
image into memory when only some section is
- relevant.</>
+ relevant.</entry>
</row>
</tbody>
</tgroup>
@@ -1207,18 +1209,18 @@
<tbody>
<row>
- <entry>channel</><entry>The channel number we are selecting</entry>
+ <entry>channel</entry><entry>The channel number we are selecting</entry>
</row><row>
- <entry>name</><entry>The name for this channel. This is intended
+ <entry>name</entry><entry>The name for this channel. This is intended
to describe the port to the user.
Appropriate names are therefore things like
"Camera" "SCART input"</entry>
</row><row>
- <entry>flags</><entry>Channel properties</entry>
+ <entry>flags</entry><entry>Channel properties</entry>
</row><row>
- <entry>type</><entry>Input type</entry>
+ <entry>type</entry><entry>Input type</entry>
</row><row>
- <entry>norm</><entry>The current television encoding being used
+ <entry>norm</entry><entry>The current television encoding being used
if relevant for this channel.
</entry>
</row>
@@ -1229,9 +1231,9 @@
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>VIDEO_VC_TUNER</><entry>Channel has a tuner.</entry>
+ <entry>VIDEO_VC_TUNER</entry><entry>Channel has a tuner.</entry>
</row><row>
- <entry>VIDEO_VC_AUDIO</><entry>Channel has audio.</entry>
+ <entry>VIDEO_VC_AUDIO</entry><entry>Channel has audio.</entry>
</row>
</tbody>
</tgroup>
@@ -1240,11 +1242,11 @@
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>VIDEO_TYPE_TV</><entry>Television input.</entry>
+ <entry>VIDEO_TYPE_TV</entry><entry>Television input.</entry>
</row><row>
- <entry>VIDEO_TYPE_CAMERA</><entry>Fixed camera input.</entry>
+ <entry>VIDEO_TYPE_CAMERA</entry><entry>Fixed camera input.</entry>
</row><row>
- <entry>0</><entry>Type is unknown.</entry>
+ <entry>0</entry><entry>Type is unknown.</entry>
</row>
</tbody>
</tgroup>
@@ -1253,13 +1255,13 @@
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>VIDEO_MODE_PAL</><entry>PAL encoded Television</entry>
+ <entry>VIDEO_MODE_PAL</entry><entry>PAL encoded Television</entry>
</row><row>
- <entry>VIDEO_MODE_NTSC</><entry>NTSC (US) encoded Television</entry>
+ <entry>VIDEO_MODE_NTSC</entry><entry>NTSC (US) encoded Television</entry>
</row><row>
- <entry>VIDEO_MODE_SECAM</><entry>SECAM (French) Television </entry>
+ <entry>VIDEO_MODE_SECAM</entry><entry>SECAM (French) Television </entry>
</row><row>
- <entry>VIDEO_MODE_AUTO</><entry>Automatic switching, or format does not
+ <entry>VIDEO_MODE_AUTO</entry><entry>Automatic switching, or format does not
matter</entry>
</row>
</tbody>
@@ -1339,14 +1341,14 @@
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>GREY</><entry>Linear greyscale. This is for simple cameras and the
- like</>
+ <entry>GREY</entry><entry>Linear greyscale. This is for simple cameras and the
+ like</entry>
</row><row>
- <entry>RGB565</><entry>The top 5 bits hold 32 red levels, the next six bits
- hold green and the low 5 bits hold blue. </>
+ <entry>RGB565</entry><entry>The top 5 bits hold 32 red levels, the next six bits
+ hold green and the low 5 bits hold blue. </entry>
</row><row>
- <entry>RGB555</><entry>The top bit is clear. The red green and blue levels
- each occupy five bits.</>
+ <entry>RGB555</entry><entry>The top bit is clear. The red green and blue levels
+ each occupy five bits.</entry>
</row>
</tbody>
</tgroup>
@@ -1477,32 +1479,32 @@
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>width</><entry>The width in pixels of the desired image. The card
- may use a smaller size if this size is not available</>
+ <entry>width</entry><entry>The width in pixels of the desired image. The card
+ may use a smaller size if this size is not available</entry>
</row><row>
- <entry>height</><entry>The height of the image. The card may use a smaller
- size if this size is not available.</>
+ <entry>height</entry><entry>The height of the image. The card may use a smaller
+ size if this size is not available.</entry>
</row><row>
- <entry>x</><entry> The X position of the top left of the window. This
+ <entry>x</entry><entry> The X position of the top left of the window. This
is in pixels relative to the left hand edge of the
picture. Not all cards can display images aligned on
any pixel boundary. If the position is unsuitable
the card adjusts the image right and reduces the
- width.</>
+ width.</entry>
</row><row>
- <entry>y</><entry> The Y position of the top left of the window. This
+ <entry>y</entry><entry> The Y position of the top left of the window. This
is counted in pixels relative to the top edge of the
picture. As with the width if the card cannot
display starting on this line it will adjust the
- values.</>
+ values.</entry>
</row><row>
- <entry>chromakey</><entry>The colour (expressed in RGB32 format) for the
- chromakey colour if chroma keying is being used. </>
+ <entry>chromakey</entry><entry>The colour (expressed in RGB32 format) for the
+ chromakey colour if chroma keying is being used. </entry>
</row><row>
- <entry>clips</><entry>An array of rectangles that must not be drawn
- over.</>
+ <entry>clips</entry><entry>An array of rectangles that must not be drawn
+ over.</entry>
</row><row>
- <entry>clipcount</><entry>The number of clips in this array.</>
+ <entry>clipcount</entry><entry>The number of clips in this array.</entry>
</row>
</tbody>
</tgroup>
@@ -1514,11 +1516,11 @@
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>x, y</><entry>Co-ordinates relative to the display</>
+ <entry>x, y</entry><entry>Co-ordinates relative to the display</entry>
</row><row>
- <entry>width, height</><entry>Width and height in pixels</>
+ <entry>width, height</entry><entry>Width and height in pixels</entry>
</row><row>
- <entry>next</><entry>A spare field for the application to use</>
+ <entry>next</entry><entry>A spare field for the application to use</entry>
</row>
</tbody>
</tgroup>
diff -Nru a/Documentation/DocBook/wanbook.tmpl b/Documentation/DocBook/wanbook.tmpl
--- a/Documentation/DocBook/wanbook.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/wanbook.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/writing_usb_driver.tmpl b/Documentation/DocBook/writing_usb_driver.tmpl
--- a/Documentation/DocBook/writing_usb_driver.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/writing_usb_driver.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
diff -Nru a/Documentation/DocBook/z8530book.tmpl b/Documentation/DocBook/z8530book.tmpl
--- a/Documentation/DocBook/z8530book.tmpl Thu Mar 3 11:42:18 2005
+++ b/Documentation/DocBook/z8530book.tmpl Thu Mar 3 11:42:18 2005
@@ -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>
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 9/16] DocBook: s/sgml/xml/ in scripts/kernel-doc
2005-03-03 10:28 Documentation update Martin Waitz
` (9 preceding siblings ...)
2005-03-03 10:42 ` [PATCH 8/16] DocBook: convert template files to XML Martin Waitz
@ 2005-03-03 10:42 ` Martin Waitz
2005-03-03 10:42 ` [PATCH 10/16] DocBook: move kernel-doc comment next to function Martin Waitz
` (7 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:42 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
DocBook: s/sgml/xml/ in scripts/kernel-doc
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2034
# DocBook: s/sgml/xml/ in scripts/kernel-doc
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/scripts/kernel-doc b/scripts/kernel-doc
--- a/scripts/kernel-doc Thu Mar 3 11:42:30 2005
+++ b/scripts/kernel-doc Thu Mar 3 11:42:30 2005
@@ -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";
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 10/16] DocBook: move kernel-doc comment next to function
2005-03-03 10:28 Documentation update Martin Waitz
` (10 preceding siblings ...)
2005-03-03 10:42 ` [PATCH 9/16] DocBook: s/sgml/xml/ in scripts/kernel-doc Martin Waitz
@ 2005-03-03 10:42 ` Martin Waitz
2005-03-03 10:42 ` [PATCH 11/16] DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile Martin Waitz
` (6 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:42 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
DocBook: move kernel-doc comment next to function
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2035
# DocBook: move kernel-doc comment next to function
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/drivers/video/fbmem.c b/drivers/video/fbmem.c
--- a/drivers/video/fbmem.c Thu Mar 3 11:42:38 2005
+++ b/drivers/video/fbmem.c Thu Mar 3 11:42:38 2005
@@ -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;
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 11/16] DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile
2005-03-03 10:28 Documentation update Martin Waitz
` (11 preceding siblings ...)
2005-03-03 10:42 ` [PATCH 10/16] DocBook: move kernel-doc comment next to function Martin Waitz
@ 2005-03-03 10:42 ` Martin Waitz
2005-03-03 10:42 ` [PATCH 12/16] DocBook: fix XML in templates Martin Waitz
` (5 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:42 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2036
# DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
--- a/Documentation/DocBook/Makefile Thu Mar 3 11:42:47 2005
+++ b/Documentation/DocBook/Makefile Thu Mar 3 11:42:47 2005
@@ -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/
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 12/16] DocBook: fix XML in templates
2005-03-03 10:28 Documentation update Martin Waitz
` (12 preceding siblings ...)
2005-03-03 10:42 ` [PATCH 11/16] DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile Martin Waitz
@ 2005-03-03 10:42 ` Martin Waitz
2005-03-03 10:43 ` [PATCH 13/16] [DocBook] kernel-docify comments Martin Waitz
` (4 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:42 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
DocBook: fix XML in templates
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2037
# DocBook: fix XML in templates
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/Documentation/DocBook/librs.tmpl b/Documentation/DocBook/librs.tmpl
--- a/Documentation/DocBook/librs.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/librs.tmpl Thu Mar 3 11:42:55 2005
@@ -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>
diff -Nru a/Documentation/DocBook/mtdnand.tmpl b/Documentation/DocBook/mtdnand.tmpl
--- a/Documentation/DocBook/mtdnand.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/mtdnand.tmpl Thu Mar 3 11:42:55 2005
@@ -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;
diff -Nru a/Documentation/DocBook/procfs-guide.tmpl b/Documentation/DocBook/procfs-guide.tmpl
--- a/Documentation/DocBook/procfs-guide.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/procfs-guide.tmpl Thu Mar 3 11:42:55 2005
@@ -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">
diff -Nru a/Documentation/DocBook/sis900.tmpl b/Documentation/DocBook/sis900.tmpl
--- a/Documentation/DocBook/sis900.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/sis900.tmpl Thu Mar 3 11:42:55 2005
@@ -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>
diff -Nru a/Documentation/DocBook/via-audio.tmpl b/Documentation/DocBook/via-audio.tmpl
--- a/Documentation/DocBook/via-audio.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/via-audio.tmpl Thu Mar 3 11:42:55 2005
@@ -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>
diff -Nru a/Documentation/DocBook/videobook.tmpl b/Documentation/DocBook/videobook.tmpl
--- a/Documentation/DocBook/videobook.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/videobook.tmpl Thu Mar 3 11:42:55 2005
@@ -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);
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 13/16] [DocBook] kernel-docify comments
2005-03-03 10:28 Documentation update Martin Waitz
` (13 preceding siblings ...)
2005-03-03 10:42 ` [PATCH 12/16] DocBook: fix XML in templates Martin Waitz
@ 2005-03-03 10:43 ` Martin Waitz
2005-03-03 10:43 ` [PATCH 14/16] [DocBook] add kfifo to kernel-api docs Martin Waitz
` (3 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:43 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
[DocBook] kernel-docify comments
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2038
# [DocBook] kernel-docify comments
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/include/linux/kfifo.h b/include/linux/kfifo.h
--- a/include/linux/kfifo.h Thu Mar 3 11:43:04 2005
+++ b/include/linux/kfifo.h Thu Mar 3 11:43:04 2005
@@ -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.
*/
diff -Nru a/kernel/kfifo.c b/kernel/kfifo.c
--- a/kernel/kfifo.c Thu Mar 3 11:43:04 2005
+++ b/kernel/kfifo.c Thu Mar 3 11:43:04 2005
@@ -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.
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 14/16] [DocBook] add kfifo to kernel-api docs
2005-03-03 10:28 Documentation update Martin Waitz
` (14 preceding siblings ...)
2005-03-03 10:43 ` [PATCH 13/16] [DocBook] kernel-docify comments Martin Waitz
@ 2005-03-03 10:43 ` Martin Waitz
2005-03-03 10:43 ` [PATCH 15/16] [DocBook] factor out escaping of XML special characters Martin Waitz
` (2 subsequent siblings)
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:43 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
[DocBook] add kfifo to kernel-api docs
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2039
# [DocBook] add kfifo to kernel-api docs
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl
--- a/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 11:43:12 2005
+++ b/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 11:43:12 2005
@@ -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>
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 15/16] [DocBook] factor out escaping of XML special characters
2005-03-03 10:28 Documentation update Martin Waitz
` (15 preceding siblings ...)
2005-03-03 10:43 ` [PATCH 14/16] [DocBook] add kfifo to kernel-api docs Martin Waitz
@ 2005-03-03 10:43 ` Martin Waitz
2005-03-05 23:17 ` Martin Waitz
2005-03-03 10:43 ` [PATCH 16/16] [DocBook] escape declaration_purpose Martin Waitz
2005-03-03 11:15 ` Documentation update Jeff Garzik
18 siblings, 1 reply; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:43 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
[DocBook] factor out escaping of XML special characters
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2040
# [DocBook] factor out escaping of XML special characters
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/scripts/kernel-doc b/scripts/kernel-doc
--- a/scripts/kernel-doc Thu Mar 3 11:43:21 2005
+++ b/scripts/kernel-doc Thu Mar 3 11:43:21 2005
@@ -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 {
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH 16/16] [DocBook] escape declaration_purpose
2005-03-03 10:28 Documentation update Martin Waitz
` (16 preceding siblings ...)
2005-03-03 10:43 ` [PATCH 15/16] [DocBook] factor out escaping of XML special characters Martin Waitz
@ 2005-03-03 10:43 ` Martin Waitz
2005-03-03 11:15 ` Documentation update Jeff Garzik
18 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-03 10:43 UTC (permalink / raw)
To: tali; +Cc: linux-kernel
[DocBook] escape declaration_purpose
Signed-off-by: Martin Waitz <tali@admingilde.org>
# 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 tali@admingilde.org 1.2041
# [DocBook] escape declaration_purpose
#
# Signed-off-by: Martin Waitz <tali@admingilde.org>
# --------------------------------------------
#
diff -Nru a/scripts/kernel-doc b/scripts/kernel-doc
--- a/scripts/kernel-doc Thu Mar 3 11:43:30 2005
+++ b/scripts/kernel-doc Thu Mar 3 11:43:30 2005
@@ -1673,7 +1673,7 @@
$state = 2;
if (/-(.*)/) {
- $declaration_purpose = $1;
+ $declaration_purpose = xml_escape($1);
} else {
$declaration_purpose = "";
}
^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: Documentation update
2005-03-03 10:28 Documentation update Martin Waitz
` (17 preceding siblings ...)
2005-03-03 10:43 ` [PATCH 16/16] [DocBook] escape declaration_purpose Martin Waitz
@ 2005-03-03 11:15 ` Jeff Garzik
18 siblings, 0 replies; 21+ messages in thread
From: Jeff Garzik @ 2005-03-03 11:15 UTC (permalink / raw)
To: Martin Waitz; +Cc: Linus Torvalds, linux-kernel, Andrew Morton
Martin Waitz wrote:
> 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:
> @@ -1248,6 +1249,9 @@
> return retval;
> }
>
> +
> +extern const char *global_mode_option;
> +
> /**
> * video_setup - process command line options
> * @options: string of options
> @@ -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
^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [PATCH 15/16] [DocBook] factor out escaping of XML special characters
2005-03-03 10:43 ` [PATCH 15/16] [DocBook] factor out escaping of XML special characters Martin Waitz
@ 2005-03-05 23:17 ` Martin Waitz
0 siblings, 0 replies; 21+ messages in thread
From: Martin Waitz @ 2005-03-05 23:17 UTC (permalink / raw)
To: Andrew Morton; +Cc: linux-kernel
[-- Attachment #1: Type: text/plain, Size: 658 bytes --]
hoi :)
well, this patch is broken :(
On Thu, Mar 03, 2005 at 11:43:17AM +0100, Martin Waitz wrote:
> --- a/scripts/kernel-doc Thu Mar 3 11:43:21 2005
> +++ b/scripts/kernel-doc Thu Mar 3 11:43:21 2005
> @@ -1624,6 +1624,15 @@
> }
> }
>
> +# replace <, >, and &
> +sub xml_escape($) {
> + shift;
this must be: $_ = shift;
> + 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)
--
Martin Waitz
[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 189 bytes --]
^ permalink raw reply [flat|nested] 21+ messages in thread
end of thread, other threads:[~2005-03-06 8:07 UTC | newest]
Thread overview: 21+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2005-03-03 10:28 Documentation update Martin Waitz
2005-03-03 10:37 ` [PATCH 1/16] DocBook: remove reference to drivers/net/net_init.c Martin Waitz
2005-03-03 10:37 ` [PATCH 2/16] DocBook: allow preprocessor directives between kernel-doc and function Martin Waitz
2005-03-03 10:41 ` [PATCH 1/16] DocBook: remove reference to drivers/net/net_init.c Martin Waitz
2005-03-03 10:41 ` [PATCH 2/16] DocBook: allow preprocessor directives between kernel-doc and function Martin Waitz
2005-03-03 10:41 ` [PATCH 3/16] DocBook: update function parameter description in network code Martin Waitz
2005-03-03 10:41 ` [PATCH 4/16] DocBook: update function parameter description in block/fs code Martin Waitz
2005-03-03 10:41 ` [PATCH 5/16] DocBook: update function parameter description in USB code Martin Waitz
2005-03-03 10:41 ` [PATCH 6/16] DocBook: fix function parameter descriptin in fbmem Martin Waitz
2005-03-03 10:42 ` [PATCH 7/16] DocBook: new kernel-doc comments for might_sleep & wait_event_* Martin Waitz
2005-03-03 10:42 ` [PATCH 8/16] DocBook: convert template files to XML Martin Waitz
2005-03-03 10:42 ` [PATCH 9/16] DocBook: s/sgml/xml/ in scripts/kernel-doc Martin Waitz
2005-03-03 10:42 ` [PATCH 10/16] DocBook: move kernel-doc comment next to function Martin Waitz
2005-03-03 10:42 ` [PATCH 11/16] DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile Martin Waitz
2005-03-03 10:42 ` [PATCH 12/16] DocBook: fix XML in templates Martin Waitz
2005-03-03 10:43 ` [PATCH 13/16] [DocBook] kernel-docify comments Martin Waitz
2005-03-03 10:43 ` [PATCH 14/16] [DocBook] add kfifo to kernel-api docs Martin Waitz
2005-03-03 10:43 ` [PATCH 15/16] [DocBook] factor out escaping of XML special characters Martin Waitz
2005-03-05 23:17 ` Martin Waitz
2005-03-03 10:43 ` [PATCH 16/16] [DocBook] escape declaration_purpose Martin Waitz
2005-03-03 11:15 ` Documentation update Jeff Garzik
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).