Skip to content

L
linux
Commit f25aad9e authored by Martin Waitz's avatar Martin Waitz Committed by Linus Torvalds
Browse files
Options

[PATCH] docbook: convert template files to XML 

Convert template files to XML
Signed-off-by: default avatarMartin Waitz <tali@admingilde.org>
Signed-off-by: default avatarAndrew Morton <akpm@osdl.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@osdl.org>
parent 54314729
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 574 additions and 529 deletions
Documentation/DocBook/deviceiobook.tmpl
View file @ f25aad9e
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="DoingIO">
<bookinfo>
......
Documentation/DocBook/gadget.tmpl
View file @ f25aad9e
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="USB-Gadget-API">
<bookinfo>
<title>USB Gadget API for Linux</title>
......
Documentation/DocBook/journal-api.tmpl
View file @ f25aad9e
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="LinuxJBDAPI">
<bookinfo>
<title>The Linux Journalling API</title>
......
Documentation/DocBook/kernel-api.tmpl
View file @ f25aad9e
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="LinuxKernelAPI">
<bookinfo>
<title>The Linux Kernel API</title>
......
Documentation/DocBook/kernel-hacking.tmpl
View file @ f25aad9e
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="lk-hacking-guide">
<bookinfo>
......
Documentation/DocBook/kernel-locking.tmpl
View file @ f25aad9e
<!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>
......
Documentation/DocBook/libata.tmpl
View file @ f25aad9e
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="libataDevGuide">
<bookinfo>
......
Documentation/DocBook/librs.tmpl
View file @ f25aad9e
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="Reed-Solomon-Library-Guide">
<bookinfo>
......
Documentation/DocBook/lsm.tmpl
View file @ f25aad9e
<!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 @@ security; it merely provides the infrastructure to support security
modules. The LSM kernel patch also moves most of the capabilities
logic into an optional security module, with the system defaulting
to the traditional superuser logic. This capabilities module
is discussed further in <XRef LinkEnd="cap">.
is discussed further in <xref linkend="cap"/>.
</para>
<para>
......
Documentation/DocBook/mcabook.tmpl
View file @ f25aad9e
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="MCAGuide">
<bookinfo>
......
Documentation/DocBook/mtdnand.tmpl
View file @ f25aad9e
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="MTD-NAND-Guide">
<bookinfo>
......
Documentation/DocBook/procfs-guide.tmpl
View file @ f25aad9e
<!-- -*- 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 @@ entry->write_proc = write_proc_foo;
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 @@ entry->write_proc = write_proc_foo;
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 @@ entry->write_proc = write_proc_foo;
</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 @@ entry->write_proc = write_proc_foo;
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 @@ int foo_read_func(char *page, char **start, off_t off,
<para>
This function creates a regular file in exactly the same way
as <function>create_proc_entry</function> from <xref
linkend="regularfile"> does, but also allows to set the read
linkend="regularfile"/> does, but also allows to set the read
function <parameter>read_proc</parameter> in one call. This
function can set the <parameter>data</parameter> as well, like
explained in <xref linkend="usingdata">.
explained in <xref linkend="usingdata"/>.
</para>
</sect1>
......
Documentation/DocBook/scsidrivers.tmpl
View file @ f25aad9e
<!-- -*- sgml -*- -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN"[]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="scsidrivers">
<bookinfo>
......
Documentation/DocBook/sis900.tmpl
View file @ f25aad9e
This diff is collapsed.
Documentation/DocBook/tulip-user.tmpl
View file @ f25aad9e
<!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 @@ Jeff Garzik, Takashi Manabe and a cast of thousands.
<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 @@ For 2.4.x and later kernels, the Linux Tulip driver is available at
<para>
Additional information on Donald Becker's tulip.c
is available at <ULink URL="http://www.scyld.com/network/tulip.html">http://www.scyld.com/network/tulip.html</ULink>
is available at <ulink url="http://www.scyld.com/network/tulip.html">http://www.scyld.com/network/tulip.html</ulink>
</para>
</chapter>
......
Documentation/DocBook/usb.tmpl
View file @ f25aad9e
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="Linux-USB-API">
<bookinfo>
<title>The Linux-USB Host Side API</title>
......
Documentation/DocBook/via-audio.tmpl
View file @ f25aad9e
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="ViaAudioGuide">
<bookinfo>
......
Documentation/DocBook/videobook.tmpl
View file @ f25aad9e
This diff is collapsed.
Documentation/DocBook/wanbook.tmpl
View file @ f25aad9e
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="WANGuide">
<bookinfo>
......
Documentation/DocBook/writing_usb_driver.tmpl
View file @ f25aad9e
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="USBDeviceDriver">
<bookinfo>
......
Documentation/DocBook/z8530book.tmpl
View file @ f25aad9e
<!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>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7