Skip to content

Commit

Permalink
---
Browse files Browse the repository at this point in the history
yaml
---
r: 57019
b: refs/heads/master
c: 869b2b4
h: refs/heads/master
i:
  57017: 7f57a6e
  57015: 5ede51c
v: v3
  • Loading branch information
Martin Peschke authored and James Bottomley committed May 16, 2007
1 parent 14da73e commit fa1943d
Show file tree
Hide file tree
Showing 891 changed files with 6,247 additions and 41,740 deletions.
2 changes: 1 addition & 1 deletion [refs]
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
---
refs/heads/master: d5d4db704b962773c03ee3beb3258b6450611e66
refs/heads/master: 869b2b444c58302e3233ce0b671fabf28135a37d
49 changes: 19 additions & 30 deletions trunk/Documentation/CodingStyle
Original file line number Diff line number Diff line change
Expand Up @@ -495,40 +495,29 @@ re-formatting you may want to take a look at the man page. But
remember: "indent" is not a fix for bad programming.


Chapter 10: Kconfig configuration files
Chapter 10: Configuration-files

For all of the Kconfig* configuration files throughout the source tree,
the indentation is somewhat different. Lines under a "config" definition
are indented with one tab, while help text is indented an additional two
spaces. Example:
For configuration options (arch/xxx/Kconfig, and all the Kconfig files),
somewhat different indentation is used.

config AUDIT
bool "Auditing support"
depends on NET
help
Enable auditing infrastructure that can be used with another
kernel subsystem, such as SELinux (which requires this for
logging of avc messages output). Does not do system-call
auditing without CONFIG_AUDITSYSCALL.

Features that might still be considered unstable should be defined as
dependent on "EXPERIMENTAL":

config SLUB
depends on EXPERIMENTAL && !ARCH_USES_SLAB_PAGE_STRUCT
bool "SLUB (Unqueued Allocator)"
...
Help text is indented with 2 spaces.

while seriously dangerous features (such as write support for certain
filesystems) should advertise this prominently in their prompt string:

config ADFS_FS_RW
bool "ADFS write support (DANGEROUS)"
depends on ADFS_FS
...
if CONFIG_EXPERIMENTAL
tristate CONFIG_BOOM
default n
help
Apply nitroglycerine inside the keyboard (DANGEROUS)
bool CONFIG_CHEER
depends on CONFIG_BOOM
default y
help
Output nice messages when you explode
endif

For full documentation on the configuration files, see the file
Documentation/kbuild/kconfig-language.txt.
Generally, CONFIG_EXPERIMENTAL should surround all options not considered
stable. All options that are known to trash data (experimental write-
support for file-systems, for instance) should be denoted (DANGEROUS), other
experimental options should be denoted (EXPERIMENTAL).


Chapter 11: Data structures
Expand Down
2 changes: 1 addition & 1 deletion trunk/Documentation/DocBook/gadget.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@

<toc></toc>

<chapter id="intro"><title>Introduction</title>
<chapter><title>Introduction</title>

<para>This document presents a Linux-USB "Gadget"
kernel mode
Expand Down
123 changes: 45 additions & 78 deletions trunk/Documentation/DocBook/kernel-locking.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -551,12 +551,10 @@
<function>spin_lock_irqsave()</function>, which is a superset
of all other spinlock primitives.
</para>

<table>
<title>Table of Locking Requirements</title>
<tgroup cols="11">
<tbody>

<row>
<entry></entry>
<entry>IRQ Handler A</entry>
Expand All @@ -578,128 +576,97 @@

<row>
<entry>IRQ Handler B</entry>
<entry>SLIS</entry>
<entry>spin_lock_irqsave</entry>
<entry>None</entry>
</row>

<row>
<entry>Softirq A</entry>
<entry>SLI</entry>
<entry>SLI</entry>
<entry>SL</entry>
<entry>spin_lock_irq</entry>
<entry>spin_lock_irq</entry>
<entry>spin_lock</entry>
</row>

<row>
<entry>Softirq B</entry>
<entry>SLI</entry>
<entry>SLI</entry>
<entry>SL</entry>
<entry>SL</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>SLI</entry>
<entry>SLI</entry>
<entry>SL</entry>
<entry>SL</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>SLI</entry>
<entry>SLI</entry>
<entry>SL</entry>
<entry>SL</entry>
<entry>SL</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>SLI</entry>
<entry>SLI</entry>
<entry>SL</entry>
<entry>SL</entry>
<entry>SL</entry>
<entry>SL</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>SLI</entry>
<entry>SLI</entry>
<entry>SL</entry>
<entry>SL</entry>
<entry>SL</entry>
<entry>SL</entry>
<entry>SL</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>SLI</entry>
<entry>SLI</entry>
<entry>SLBH</entry>
<entry>SLBH</entry>
<entry>SLBH</entry>
<entry>SLBH</entry>
<entry>SLBH</entry>
<entry>SLBH</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>SLI</entry>
<entry>SLI</entry>
<entry>SLBH</entry>
<entry>SLBH</entry>
<entry>SLBH</entry>
<entry>SLBH</entry>
<entry>SLBH</entry>
<entry>SLBH</entry>
<entry>DI</entry>
<entry>None</entry>
</row>

</tbody>
</tgroup>
</table>

<table>
<title>Legend for Locking Requirements Table</title>
<tgroup cols="2">
<tbody>

<row>
<entry>SLIS</entry>
<entry>spin_lock_irqsave</entry>
</row>
<row>
<entry>SLI</entry>
<entry>spin_lock_irq</entry>
</row>
<row>
<entry>SL</entry>
<entry>spin_lock</entry>
</row>
<row>
<entry>SLBH</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>
</row>
<row>
<entry>DI</entry>
<entry>down_interruptible</entry>
<entry>None</entry>
</row>

</tbody>
</tgroup>
</table>

</sect1>
</chapter>

Expand Down
28 changes: 14 additions & 14 deletions trunk/Documentation/DocBook/usb.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@

</chapter>

<chapter id="types"><title>USB-Standard Types</title>
<chapter><title>USB-Standard Types</title>

<para>In <filename>&lt;linux/usb/ch9.h&gt;</filename> you will find
the USB data types defined in chapter 9 of the USB specification.
Expand All @@ -197,7 +197,7 @@

</chapter>

<chapter id="hostside"><title>Host-Side Data Types and Macros</title>
<chapter><title>Host-Side Data Types and Macros</title>

<para>The host side API exposes several layers to drivers, some of
which are more necessary than others.
Expand All @@ -211,7 +211,7 @@

</chapter>

<chapter id="usbcore"><title>USB Core APIs</title>
<chapter><title>USB Core APIs</title>

<para>There are two basic I/O models in the USB API.
The most elemental one is asynchronous: drivers submit requests
Expand Down Expand Up @@ -248,7 +248,7 @@
!Edrivers/usb/core/hub.c
</chapter>

<chapter id="hcd"><title>Host Controller APIs</title>
<chapter><title>Host Controller APIs</title>

<para>These APIs are only for use by host controller drivers,
most of which implement standard register interfaces such as
Expand Down Expand Up @@ -285,7 +285,7 @@
!Idrivers/usb/core/buffer.c
</chapter>

<chapter id="usbfs">
<chapter>
<title>The USB Filesystem (usbfs)</title>

<para>This chapter presents the Linux <emphasis>usbfs</emphasis>.
Expand Down Expand Up @@ -317,7 +317,7 @@
not it has a kernel driver.
</para>

<sect1 id="usbfs-files">
<sect1>
<title>What files are in "usbfs"?</title>

<para>Conventionally mounted at
Expand Down Expand Up @@ -356,7 +356,7 @@

</sect1>

<sect1 id="usbfs-fstab">
<sect1>
<title>Mounting and Access Control</title>

<para>There are a number of mount options for usbfs, which will
Expand Down Expand Up @@ -439,7 +439,7 @@

</sect1>

<sect1 id="usbfs-devices">
<sect1>
<title>/proc/bus/usb/devices</title>

<para>This file is handy for status viewing tools in user
Expand Down Expand Up @@ -473,7 +473,7 @@ for (;;) {
</para>
</sect1>

<sect1 id="usbfs-bbbddd">
<sect1>
<title>/proc/bus/usb/BBB/DDD</title>

<para>Use these files in one of these basic ways:
Expand Down Expand Up @@ -510,7 +510,7 @@ for (;;) {
</sect1>


<sect1 id="usbfs-lifecycle">
<sect1>
<title>Life Cycle of User Mode Drivers</title>

<para>Such a driver first needs to find a device file
Expand Down Expand Up @@ -565,7 +565,7 @@ for (;;) {

</sect1>

<sect1 id="usbfs-ioctl"><title>The ioctl() Requests</title>
<sect1><title>The ioctl() Requests</title>

<para>To use these ioctls, you need to include the following
headers in your userspace program:
Expand Down Expand Up @@ -604,7 +604,7 @@ for (;;) {
</para>


<sect2 id="usbfs-mgmt">
<sect2>
<title>Management/Status Requests</title>

<para>A number of usbfs requests don't deal very directly
Expand Down Expand Up @@ -736,7 +736,7 @@ usbdev_ioctl (int fd, int ifno, unsigned request, void *param)

</sect2>

<sect2 id="usbfs-sync">
<sect2>
<title>Synchronous I/O Support</title>

<para>Synchronous requests involve the kernel blocking
Expand Down Expand Up @@ -865,7 +865,7 @@ usbdev_ioctl (int fd, int ifno, unsigned request, void *param)
</variablelist>
</sect2>

<sect2 id="usbfs-async">
<sect2>
<title>Asynchronous I/O Support</title>

<para>As mentioned above, there are situations where it may be
Expand Down
Loading

0 comments on commit fa1943d

Please sign in to comment.