aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorJeff Garzik <jgarzik@pobox.com>2005-11-18 11:44:17 -0500
committerJeff Garzik <jgarzik@pobox.com>2005-11-18 11:44:17 -0500
commitf333b3f111e9db76109e304df8ee777ace7fbf86 (patch)
treece9a74a7327020c48c80d278e1db5f12552f0fb0 /Documentation
parentf4256e301d9800b1e0276404cb01b3ac85b51067 (diff)
parent79bfb0a98fdc73ed6a18469cef245cbf50a1d8bb (diff)
Merge branch 'upstream'
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/DocBook/Makefile48
-rw-r--r--Documentation/DocBook/kernel-api.tmpl6
-rw-r--r--Documentation/DocBook/stylesheet.xsl1
-rw-r--r--Documentation/atomic_ops.txt27
-rw-r--r--Documentation/block/biodoc.txt4
-rw-r--r--Documentation/devices.txt12
-rw-r--r--Documentation/feature-removal-schedule.txt19
-rw-r--r--Documentation/oops-tracing.txt7
-rw-r--r--Documentation/usb/bluetooth.txt44
-rw-r--r--Documentation/video4linux/CARDLIST.bttv1
-rw-r--r--Documentation/video4linux/CARDLIST.saa71342
-rw-r--r--Documentation/video4linux/CARDLIST.tuner1
-rw-r--r--Documentation/x86_64/boot-options.txt12
-rw-r--r--Documentation/x86_64/mm.txt6
14 files changed, 115 insertions, 75 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index 7018f5c6a447..1c955883cf58 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -20,6 +20,12 @@ DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \
20# +--> DIR=file (htmldocs) 20# +--> DIR=file (htmldocs)
21# +--> man/ (mandocs) 21# +--> man/ (mandocs)
22 22
23
24# for PDF and PS output you can choose between xmlto and docbook-utils tools
25PDF_METHOD = $(prefer-db2x)
26PS_METHOD = $(prefer-db2x)
27
28
23### 29###
24# The targets that may be used. 30# The targets that may be used.
25.PHONY: xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs 31.PHONY: xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs
@@ -93,27 +99,39 @@ C-procfs-example = procfs_example.xml
93C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example)) 99C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example))
94$(obj)/procfs-guide.xml: $(C-procfs-example2) 100$(obj)/procfs-guide.xml: $(C-procfs-example2)
95 101
96### 102notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
97# Rules to generate postscript, PDF and HTML 103 exit 1
98# db2html creates a directory. Generate a html file used for timestamp 104db2xtemplate = db2TYPE -o $(dir $@) $<
105xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
106
107# determine which methods are available
108ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
109 use-db2x = db2x
110 prefer-db2x = db2x
111else
112 use-db2x = notfound
113 prefer-db2x = $(use-xmlto)
114endif
115ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
116 use-xmlto = xmlto
117 prefer-xmlto = xmlto
118else
119 use-xmlto = notfound
120 prefer-xmlto = $(use-db2x)
121endif
99 122
100quiet_cmd_db2ps = XMLTO $@ 123# the commands, generated from the chosen template
101 cmd_db2ps = xmlto ps $(XMLTOFLAGS) -o $(dir $@) $< 124quiet_cmd_db2ps = PS $@
125 cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
102%.ps : %.xml 126%.ps : %.xml
103 @(which xmlto > /dev/null 2>&1) || \
104 (echo "*** You need to install xmlto ***"; \
105 exit 1)
106 $(call cmd,db2ps) 127 $(call cmd,db2ps)
107 128
108quiet_cmd_db2pdf = XMLTO $@ 129quiet_cmd_db2pdf = PDF $@
109 cmd_db2pdf = xmlto pdf $(XMLTOFLAGS) -o $(dir $@) $< 130 cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
110%.pdf : %.xml 131%.pdf : %.xml
111 @(which xmlto > /dev/null 2>&1) || \
112 (echo "*** You need to install xmlto ***"; \
113 exit 1)
114 $(call cmd,db2pdf) 132 $(call cmd,db2pdf)
115 133
116quiet_cmd_db2html = XMLTO $@ 134quiet_cmd_db2html = HTML $@
117 cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ 135 cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
118 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \ 136 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
119 Goto $(patsubst %.html,%,$(notdir $@))</a><p>' > $@ 137 Goto $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
@@ -127,7 +145,7 @@ quiet_cmd_db2html = XMLTO $@
127 @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \ 145 @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
128 cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi 146 cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
129 147
130quiet_cmd_db2man = XMLTO $@ 148quiet_cmd_db2man = MAN $@
131 cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi 149 cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi
132%.9 : %.xml 150%.9 : %.xml
133 @(which xmlto > /dev/null 2>&1) || \ 151 @(which xmlto > /dev/null 2>&1) || \
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl
index a8316b1a3e3d..096aed62c326 100644
--- a/Documentation/DocBook/kernel-api.tmpl
+++ b/Documentation/DocBook/kernel-api.tmpl
@@ -68,9 +68,7 @@ X!Iinclude/linux/kobject.h
68 68
69 <sect1><title>Kernel utility functions</title> 69 <sect1><title>Kernel utility functions</title>
70!Iinclude/linux/kernel.h 70!Iinclude/linux/kernel.h
71<!-- This needs to clean up to make kernel-doc happy 71!Ekernel/printk.c
72X!Ekernel/printk.c
73 -->
74!Ekernel/panic.c 72!Ekernel/panic.c
75!Ekernel/sys.c 73!Ekernel/sys.c
76!Ekernel/rcupdate.c 74!Ekernel/rcupdate.c
@@ -388,7 +386,7 @@ X!Edrivers/pnp/system.c
388 386
389 <chapter id="blkdev"> 387 <chapter id="blkdev">
390 <title>Block Devices</title> 388 <title>Block Devices</title>
391!Edrivers/block/ll_rw_blk.c 389!Eblock/ll_rw_blk.c
392 </chapter> 390 </chapter>
393 391
394 <chapter id="miscdev"> 392 <chapter id="miscdev">
diff --git a/Documentation/DocBook/stylesheet.xsl b/Documentation/DocBook/stylesheet.xsl
index 64be9f7ee3bb..3ccce886c349 100644
--- a/Documentation/DocBook/stylesheet.xsl
+++ b/Documentation/DocBook/stylesheet.xsl
@@ -3,4 +3,5 @@
3<param name="chunk.quietly">1</param> 3<param name="chunk.quietly">1</param>
4<param name="funcsynopsis.style">ansi</param> 4<param name="funcsynopsis.style">ansi</param>
5<param name="funcsynopsis.tabular.threshold">80</param> 5<param name="funcsynopsis.tabular.threshold">80</param>
6<!-- <param name="paper.type">A4</param> -->
6</stylesheet> 7</stylesheet>
diff --git a/Documentation/atomic_ops.txt b/Documentation/atomic_ops.txt
index 8eedaa24f5e2..23a1c2402bcc 100644
--- a/Documentation/atomic_ops.txt
+++ b/Documentation/atomic_ops.txt
@@ -115,6 +115,33 @@ boolean is return which indicates whether the resulting counter value
115is negative. It requires explicit memory barrier semantics around the 115is negative. It requires explicit memory barrier semantics around the
116operation. 116operation.
117 117
118Then:
119
120 int atomic_cmpxchg(atomic_t *v, int old, int new);
121
122This performs an atomic compare exchange operation on the atomic value v,
123with the given old and new values. Like all atomic_xxx operations,
124atomic_cmpxchg will only satisfy its atomicity semantics as long as all
125other accesses of *v are performed through atomic_xxx operations.
126
127atomic_cmpxchg requires explicit memory barriers around the operation.
128
129The semantics for atomic_cmpxchg are the same as those defined for 'cas'
130below.
131
132Finally:
133
134 int atomic_add_unless(atomic_t *v, int a, int u);
135
136If the atomic value v is not equal to u, this function adds a to v, and
137returns non zero. If v is equal to u then it returns zero. This is done as
138an atomic operation.
139
140atomic_add_unless requires explicit memory barriers around the operation.
141
142atomic_inc_not_zero, equivalent to atomic_add_unless(v, 1, 0)
143
144
118If a caller requires memory barrier semantics around an atomic_t 145If a caller requires memory barrier semantics around an atomic_t
119operation which does not return a value, a set of interfaces are 146operation which does not return a value, a set of interfaces are
120defined which accomplish this: 147defined which accomplish this:
diff --git a/Documentation/block/biodoc.txt b/Documentation/block/biodoc.txt
index 2d65c2182161..0fe01c805480 100644
--- a/Documentation/block/biodoc.txt
+++ b/Documentation/block/biodoc.txt
@@ -1063,8 +1063,8 @@ Aside:
10634.4 I/O contexts 10634.4 I/O contexts
1064I/O contexts provide a dynamically allocated per process data area. They may 1064I/O contexts provide a dynamically allocated per process data area. They may
1065be used in I/O schedulers, and in the block layer (could be used for IO statis, 1065be used in I/O schedulers, and in the block layer (could be used for IO statis,
1066priorities for example). See *io_context in drivers/block/ll_rw_blk.c, and 1066priorities for example). See *io_context in block/ll_rw_blk.c, and as-iosched.c
1067as-iosched.c for an example of usage in an i/o scheduler. 1067for an example of usage in an i/o scheduler.
1068 1068
1069 1069
10705. Scalability related changes 10705. Scalability related changes
diff --git a/Documentation/devices.txt b/Documentation/devices.txt
index 0f515175c72a..3c406acd4dfa 100644
--- a/Documentation/devices.txt
+++ b/Documentation/devices.txt
@@ -2903,14 +2903,14 @@ Your cooperation is appreciated.
2903 196 = /dev/dvb/adapter3/video0 first video decoder of fourth card 2903 196 = /dev/dvb/adapter3/video0 first video decoder of fourth card
2904 2904
2905 2905
2906216 char USB BlueTooth devices 2906216 char Bluetooth RFCOMM TTY devices
2907 0 = /dev/ttyUB0 First USB BlueTooth device 2907 0 = /dev/rfcomm0 First Bluetooth RFCOMM TTY device
2908 1 = /dev/ttyUB1 Second USB BlueTooth device 2908 1 = /dev/rfcomm1 Second Bluetooth RFCOMM TTY device
2909 ... 2909 ...
2910 2910
2911217 char USB BlueTooth devices (alternate devices) 2911217 char Bluetooth RFCOMM TTY devices (alternate devices)
2912 0 = /dev/cuub0 Callout device for ttyUB0 2912 0 = /dev/curf0 Callout device for rfcomm0
2913 1 = /dev/cuub1 Callout device for ttyUB1 2913 1 = /dev/curf1 Callout device for rfcomm1
2914 ... 2914 ...
2915 2915
2916218 char The Logical Company bus Unibus/Qbus adapters 2916218 char The Logical Company bus Unibus/Qbus adapters
diff --git a/Documentation/feature-removal-schedule.txt b/Documentation/feature-removal-schedule.txt
index 429db4bf98ec..9b743198f77a 100644
--- a/Documentation/feature-removal-schedule.txt
+++ b/Documentation/feature-removal-schedule.txt
@@ -140,3 +140,22 @@ What: EXPORT_SYMBOL(lookup_hash)
140When: January 2006 140When: January 2006
141Why: Too low-level interface. Use lookup_one_len or lookup_create instead. 141Why: Too low-level interface. Use lookup_one_len or lookup_create instead.
142Who: Christoph Hellwig <hch@lst.de> 142Who: Christoph Hellwig <hch@lst.de>
143
144---------------------------
145
146What: START_ARRAY ioctl for md
147When: July 2006
148Files: drivers/md/md.c
149Why: Not reliable by design - can fail when most needed.
150 Alternatives exist
151Who: NeilBrown <neilb@suse.de>
152
153---------------------------
154
155What: au1x00_uart driver
156When: January 2006
157Why: The 8250 serial driver now has the ability to deal with the differences
158 between the standard 8250 family of UARTs and their slightly strange
159 brother on Alchemy SOCs. The loss of features is not considered an
160 issue.
161Who: Ralf Baechle <ralf@linux-mips.org>
diff --git a/Documentation/oops-tracing.txt b/Documentation/oops-tracing.txt
index c563842ed805..05960f8a748e 100644
--- a/Documentation/oops-tracing.txt
+++ b/Documentation/oops-tracing.txt
@@ -30,7 +30,12 @@ the disk is not available then you have three options :-
30 30
31(1) Hand copy the text from the screen and type it in after the machine 31(1) Hand copy the text from the screen and type it in after the machine
32 has restarted. Messy but it is the only option if you have not 32 has restarted. Messy but it is the only option if you have not
33 planned for a crash. 33 planned for a crash. Alternatively, you can take a picture of
34 the screen with a digital camera - not nice, but better than
35 nothing. If the messages scroll off the top of the console, you
36 may find that booting with a higher resolution (eg, vga=791)
37 will allow you to read more of the text. (Caveat: This needs vesafb,
38 so won't help for 'early' oopses)
34 39
35(2) Boot with a serial console (see Documentation/serial-console.txt), 40(2) Boot with a serial console (see Documentation/serial-console.txt),
36 run a null modem to a second machine and capture the output there 41 run a null modem to a second machine and capture the output there
diff --git a/Documentation/usb/bluetooth.txt b/Documentation/usb/bluetooth.txt
deleted file mode 100644
index 774f5d3835cc..000000000000
--- a/Documentation/usb/bluetooth.txt
+++ /dev/null
@@ -1,44 +0,0 @@
1INTRODUCTION
2
3 The USB Bluetooth driver supports any USB Bluetooth device.
4 It currently works well with the Linux USB Bluetooth stack from Axis
5 (available at http://developer.axis.com/software/bluetooth/ ) and
6 has been rumored to work with other Linux USB Bluetooth stacks.
7
8
9CONFIGURATION
10
11 Currently the driver can handle up to 256 different USB Bluetooth
12 devices at once.
13
14 If you are not using devfs:
15 The major number that the driver uses is 216 so to use the driver,
16 create the following nodes:
17 mknod /dev/ttyUB0 c 216 0
18 mknod /dev/ttyUB1 c 216 1
19 mknod /dev/ttyUB2 c 216 2
20 mknod /dev/ttyUB3 c 216 3
21 .
22 .
23 .
24 mknod /dev/ttyUB254 c 216 254
25 mknod /dev/ttyUB255 c 216 255
26
27 If you are using devfs:
28 The devices supported by this driver will show up as
29 /dev/usb/ttub/{0,1,...}
30
31 When the device is connected and recognized by the driver, the driver
32 will print to the system log, which node the device has been bound to.
33
34
35CONTACT:
36
37 If anyone has any problems using this driver, please contact me, or
38 join the Linux-USB mailing list (information on joining the mailing
39 list, as well as a link to its searchable archive is at
40 http://www.linux-usb.org/ )
41
42
43Greg Kroah-Hartman
44greg@kroah.com
diff --git a/Documentation/video4linux/CARDLIST.bttv b/Documentation/video4linux/CARDLIST.bttv
index 2404099996ac..330246ac80f8 100644
--- a/Documentation/video4linux/CARDLIST.bttv
+++ b/Documentation/video4linux/CARDLIST.bttv
@@ -140,3 +140,4 @@
140139 -> Prolink PixelView PlayTV MPEG2 PV-M4900 140139 -> Prolink PixelView PlayTV MPEG2 PV-M4900
141140 -> Osprey 440 [0070:ff07] 141140 -> Osprey 440 [0070:ff07]
142141 -> Asound Skyeye PCTV 142141 -> Asound Skyeye PCTV
143142 -> Sabrent TV-FM (bttv version)
diff --git a/Documentation/video4linux/CARDLIST.saa7134 b/Documentation/video4linux/CARDLIST.saa7134
index 57c9d631db56..efb708ec116a 100644
--- a/Documentation/video4linux/CARDLIST.saa7134
+++ b/Documentation/video4linux/CARDLIST.saa7134
@@ -80,3 +80,5 @@
80 79 -> Sedna/MuchTV PC TV Cardbus TV/Radio (ITO25 Rev:2B) 80 79 -> Sedna/MuchTV PC TV Cardbus TV/Radio (ITO25 Rev:2B)
81 80 -> ASUS Digimatrix TV [1043:0210] 81 80 -> ASUS Digimatrix TV [1043:0210]
82 81 -> Philips Tiger reference design [1131:2018] 82 81 -> Philips Tiger reference design [1131:2018]
83 82 -> MSI TV@Anywhere plus [1462:6231]
84
diff --git a/Documentation/video4linux/CARDLIST.tuner b/Documentation/video4linux/CARDLIST.tuner
index ec840ca6f455..9d6544ea9f41 100644
--- a/Documentation/video4linux/CARDLIST.tuner
+++ b/Documentation/video4linux/CARDLIST.tuner
@@ -67,3 +67,4 @@ tuner=65 - Ymec TVF66T5-B/DFF
67tuner=66 - LG NTSC (TALN mini series) 67tuner=66 - LG NTSC (TALN mini series)
68tuner=67 - Philips TD1316 Hybrid Tuner 68tuner=67 - Philips TD1316 Hybrid Tuner
69tuner=68 - Philips TUV1236D ATSC/NTSC dual in 69tuner=68 - Philips TUV1236D ATSC/NTSC dual in
70tuner=69 - Tena TNF 5335 MF
diff --git a/Documentation/x86_64/boot-options.txt b/Documentation/x86_64/boot-options.txt
index ffe1c062088b..e566affeed7f 100644
--- a/Documentation/x86_64/boot-options.txt
+++ b/Documentation/x86_64/boot-options.txt
@@ -7,10 +7,12 @@ Machine check
7 7
8 mce=off disable machine check 8 mce=off disable machine check
9 mce=bootlog Enable logging of machine checks left over from booting. 9 mce=bootlog Enable logging of machine checks left over from booting.
10 Disabled by default because some BIOS leave bogus ones. 10 Disabled by default on AMD because some BIOS leave bogus ones.
11 If your BIOS doesn't do that it's a good idea to enable though 11 If your BIOS doesn't do that it's a good idea to enable though
12 to make sure you log even machine check events that result 12 to make sure you log even machine check events that result
13 in a reboot. 13 in a reboot. On Intel systems it is enabled by default.
14 mce=nobootlog
15 Disable boot machine check logging.
14 mce=tolerancelevel (number) 16 mce=tolerancelevel (number)
15 0: always panic, 1: panic if deadlock possible, 17 0: always panic, 1: panic if deadlock possible,
16 2: try to avoid panic, 3: never panic or exit (for testing) 18 2: try to avoid panic, 3: never panic or exit (for testing)
@@ -122,6 +124,9 @@ SMP
122 124
123 cpumask=MASK only use cpus with bits set in mask 125 cpumask=MASK only use cpus with bits set in mask
124 126
127 additional_cpus=NUM Allow NUM more CPUs for hotplug
128 (defaults are specified by the BIOS or half the available CPUs)
129
125NUMA 130NUMA
126 131
127 numa=off Only set up a single NUMA node spanning all memory. 132 numa=off Only set up a single NUMA node spanning all memory.
@@ -188,6 +193,9 @@ Debugging
188 193
189 kstack=N Print that many words from the kernel stack in oops dumps. 194 kstack=N Print that many words from the kernel stack in oops dumps.
190 195
196 pagefaulttrace Dump all page faults. Only useful for extreme debugging
197 and will create a lot of output.
198
191Misc 199Misc
192 200
193 noreplacement Don't replace instructions with more appropiate ones 201 noreplacement Don't replace instructions with more appropiate ones
diff --git a/Documentation/x86_64/mm.txt b/Documentation/x86_64/mm.txt
index 662b73971a67..133561b9cb0c 100644
--- a/Documentation/x86_64/mm.txt
+++ b/Documentation/x86_64/mm.txt
@@ -6,7 +6,7 @@ Virtual memory map with 4 level page tables:
60000000000000000 - 00007fffffffffff (=47bits) user space, different per mm 60000000000000000 - 00007fffffffffff (=47bits) user space, different per mm
7hole caused by [48:63] sign extension 7hole caused by [48:63] sign extension
8ffff800000000000 - ffff80ffffffffff (=40bits) guard hole 8ffff800000000000 - ffff80ffffffffff (=40bits) guard hole
9ffff810000000000 - ffffc0ffffffffff (=46bits) direct mapping of phys. memory 9ffff810000000000 - ffffc0ffffffffff (=46bits) direct mapping of all phys. memory
10ffffc10000000000 - ffffc1ffffffffff (=40bits) hole 10ffffc10000000000 - ffffc1ffffffffff (=40bits) hole
11ffffc20000000000 - ffffe1ffffffffff (=45bits) vmalloc/ioremap space 11ffffc20000000000 - ffffe1ffffffffff (=45bits) vmalloc/ioremap space
12... unused hole ... 12... unused hole ...
@@ -14,6 +14,10 @@ ffffffff80000000 - ffffffff82800000 (=40MB) kernel text mapping, from phys 0
14... unused hole ... 14... unused hole ...
15ffffffff88000000 - fffffffffff00000 (=1919MB) module mapping space 15ffffffff88000000 - fffffffffff00000 (=1919MB) module mapping space
16 16
17The direct mapping covers all memory in the system upto the highest
18memory address (this means in some cases it can also include PCI memory
19holes)
20
17vmalloc space is lazily synchronized into the different PML4 pages of 21vmalloc space is lazily synchronized into the different PML4 pages of
18the processes using the page fault handler, with init_level4_pgt as 22the processes using the page fault handler, with init_level4_pgt as
19reference. 23reference.