aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/SubmittingPatches26
-rw-r--r--Documentation/atomic_ops.txt2
-rw-r--r--Documentation/driver-model/platform.txt40
-rw-r--r--Documentation/feature-removal-schedule.txt1
-rw-r--r--Documentation/filesystems/tmpfs.txt10
-rw-r--r--Documentation/firmware_class/README2
-rw-r--r--Documentation/firmware_class/firmware_sample_driver.c2
-rw-r--r--Documentation/firmware_class/firmware_sample_firmware_class.c4
8 files changed, 76 insertions, 11 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index d91125ab6f49..0958e97d4bf4 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -340,8 +340,32 @@ now, but you can do this to mark internal company procedures or just
340point out some special detail about the sign-off. 340point out some special detail about the sign-off.
341 341
342 342
34313) When to use Acked-by:
343 344
34413) The canonical patch format 345The Signed-off-by: tag indicates that the signer was involved in the
346development of the patch, or that he/she was in the patch's delivery path.
347
348If a person was not directly involved in the preparation or handling of a
349patch but wishes to signify and record their approval of it then they can
350arrange to have an Acked-by: line added to the patch's changelog.
351
352Acked-by: is often used by the maintainer of the affected code when that
353maintainer neither contributed to nor forwarded the patch.
354
355Acked-by: is not as formal as Signed-off-by:. It is a record that the acker
356has at least reviewed the patch and has indicated acceptance. Hence patch
357mergers will sometimes manually convert an acker's "yep, looks good to me"
358into an Acked-by:.
359
360Acked-by: does not necessarily indicate acknowledgement of the entire patch.
361For example, if a patch affects multiple subsystems and has an Acked-by: from
362one subsystem maintainer then this usually indicates acknowledgement of just
363the part which affects that maintainer's code. Judgement should be used here.
364 When in doubt people should refer to the original discussion in the mailing
365list archives.
366
367
36814) The canonical patch format
345 369
346The canonical patch subject line is: 370The canonical patch subject line is:
347 371
diff --git a/Documentation/atomic_ops.txt b/Documentation/atomic_ops.txt
index 2a63d5662a93..05851e9982ed 100644
--- a/Documentation/atomic_ops.txt
+++ b/Documentation/atomic_ops.txt
@@ -149,7 +149,7 @@ defined which accomplish this:
149 void smp_mb__before_atomic_dec(void); 149 void smp_mb__before_atomic_dec(void);
150 void smp_mb__after_atomic_dec(void); 150 void smp_mb__after_atomic_dec(void);
151 void smp_mb__before_atomic_inc(void); 151 void smp_mb__before_atomic_inc(void);
152 void smp_mb__after_atomic_dec(void); 152 void smp_mb__after_atomic_inc(void);
153 153
154For example, smp_mb__before_atomic_dec() can be used like so: 154For example, smp_mb__before_atomic_dec() can be used like so:
155 155
diff --git a/Documentation/driver-model/platform.txt b/Documentation/driver-model/platform.txt
index 19c4a6e13676..2a97320ee17f 100644
--- a/Documentation/driver-model/platform.txt
+++ b/Documentation/driver-model/platform.txt
@@ -96,6 +96,46 @@ System setup also associates those clocks with the device, so that that
96calls to clk_get(&pdev->dev, clock_name) return them as needed. 96calls to clk_get(&pdev->dev, clock_name) return them as needed.
97 97
98 98
99Legacy Drivers: Device Probing
100~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101Some drivers are not fully converted to the driver model, because they take
102on a non-driver role: the driver registers its platform device, rather than
103leaving that for system infrastructure. Such drivers can't be hotplugged
104or coldplugged, since those mechanisms require device creation to be in a
105different system component than the driver.
106
107The only "good" reason for this is to handle older system designs which, like
108original IBM PCs, rely on error-prone "probe-the-hardware" models for hardware
109configuration. Newer systems have largely abandoned that model, in favor of
110bus-level support for dynamic configuration (PCI, USB), or device tables
111provided by the boot firmware (e.g. PNPACPI on x86). There are too many
112conflicting options about what might be where, and even educated guesses by
113an operating system will be wrong often enough to make trouble.
114
115This style of driver is discouraged. If you're updating such a driver,
116please try to move the device enumeration to a more appropriate location,
117outside the driver. This will usually be cleanup, since such drivers
118tend to already have "normal" modes, such as ones using device nodes that
119were created by PNP or by platform device setup.
120
121None the less, there are some APIs to support such legacy drivers. Avoid
122using these calls except with such hotplug-deficient drivers.
123
124 struct platform_device *platform_device_alloc(
125 char *name, unsigned id);
126
127You can use platform_device_alloc() to dynamically allocate a device, which
128you will then initialize with resources and platform_device_register().
129A better solution is usually:
130
131 struct platform_device *platform_device_register_simple(
132 char *name, unsigned id,
133 struct resource *res, unsigned nres);
134
135You can use platform_device_register_simple() as a one-step call to allocate
136and register a device.
137
138
99Device Naming and Driver Binding 139Device Naming and Driver Binding
100~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 140~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101The platform_device.dev.bus_id is the canonical name for the devices. 141The platform_device.dev.bus_id is the canonical name for the devices.
diff --git a/Documentation/feature-removal-schedule.txt b/Documentation/feature-removal-schedule.txt
index 49ae1ea9e868..7d3f205b0ba5 100644
--- a/Documentation/feature-removal-schedule.txt
+++ b/Documentation/feature-removal-schedule.txt
@@ -104,6 +104,7 @@ Who: Dominik Brodowski <linux@brodo.de>
104What: remove EXPORT_SYMBOL(kernel_thread) 104What: remove EXPORT_SYMBOL(kernel_thread)
105When: August 2006 105When: August 2006
106Files: arch/*/kernel/*_ksyms.c 106Files: arch/*/kernel/*_ksyms.c
107Funcs: kernel_thread
107Why: kernel_thread is a low-level implementation detail. Drivers should 108Why: kernel_thread is a low-level implementation detail. Drivers should
108 use the <linux/kthread.h> API instead which shields them from 109 use the <linux/kthread.h> API instead which shields them from
109 implementation details and provides a higherlevel interface that 110 implementation details and provides a higherlevel interface that
diff --git a/Documentation/filesystems/tmpfs.txt b/Documentation/filesystems/tmpfs.txt
index 6dd050878a20..145e44086358 100644
--- a/Documentation/filesystems/tmpfs.txt
+++ b/Documentation/filesystems/tmpfs.txt
@@ -94,10 +94,10 @@ largest node numbers in the range. For example, mpol=bind:0-3,5,7,9-15
94 94
95Note that trying to mount a tmpfs with an mpol option will fail if the 95Note that trying to mount a tmpfs with an mpol option will fail if the
96running kernel does not support NUMA; and will fail if its nodelist 96running kernel does not support NUMA; and will fail if its nodelist
97specifies a node >= MAX_NUMNODES. If your system relies on that tmpfs 97specifies a node which is not online. If your system relies on that
98being mounted, but from time to time runs a kernel built without NUMA 98tmpfs being mounted, but from time to time runs a kernel built without
99capability (perhaps a safe recovery kernel), or configured to support 99NUMA capability (perhaps a safe recovery kernel), or with fewer nodes
100fewer nodes, then it is advisable to omit the mpol option from automatic 100online, then it is advisable to omit the mpol option from automatic
101mount options. It can be added later, when the tmpfs is already mounted 101mount options. It can be added later, when the tmpfs is already mounted
102on MountPoint, by 'mount -o remount,mpol=Policy:NodeList MountPoint'. 102on MountPoint, by 'mount -o remount,mpol=Policy:NodeList MountPoint'.
103 103
@@ -121,4 +121,4 @@ RAM/SWAP in 10240 inodes and it is only accessible by root.
121Author: 121Author:
122 Christoph Rohland <cr@sap.com>, 1.12.01 122 Christoph Rohland <cr@sap.com>, 1.12.01
123Updated: 123Updated:
124 Hugh Dickins <hugh@veritas.com>, 19 February 2006 124 Hugh Dickins <hugh@veritas.com>, 4 June 2007
diff --git a/Documentation/firmware_class/README b/Documentation/firmware_class/README
index e9cc8bb26f7d..c3480aa66ba8 100644
--- a/Documentation/firmware_class/README
+++ b/Documentation/firmware_class/README
@@ -1,7 +1,7 @@
1 1
2 request_firmware() hotplug interface: 2 request_firmware() hotplug interface:
3 ------------------------------------ 3 ------------------------------------
4 Copyright (C) 2003 Manuel Estrada Sainz <ranty@debian.org> 4 Copyright (C) 2003 Manuel Estrada Sainz
5 5
6 Why: 6 Why:
7 --- 7 ---
diff --git a/Documentation/firmware_class/firmware_sample_driver.c b/Documentation/firmware_class/firmware_sample_driver.c
index 87feccdb5c9f..6865cbe075ec 100644
--- a/Documentation/firmware_class/firmware_sample_driver.c
+++ b/Documentation/firmware_class/firmware_sample_driver.c
@@ -1,7 +1,7 @@
1/* 1/*
2 * firmware_sample_driver.c - 2 * firmware_sample_driver.c -
3 * 3 *
4 * Copyright (c) 2003 Manuel Estrada Sainz <ranty@debian.org> 4 * Copyright (c) 2003 Manuel Estrada Sainz
5 * 5 *
6 * Sample code on how to use request_firmware() from drivers. 6 * Sample code on how to use request_firmware() from drivers.
7 * 7 *
diff --git a/Documentation/firmware_class/firmware_sample_firmware_class.c b/Documentation/firmware_class/firmware_sample_firmware_class.c
index 9e1b0e4051cd..4994f1f28f8c 100644
--- a/Documentation/firmware_class/firmware_sample_firmware_class.c
+++ b/Documentation/firmware_class/firmware_sample_firmware_class.c
@@ -1,7 +1,7 @@
1/* 1/*
2 * firmware_sample_firmware_class.c - 2 * firmware_sample_firmware_class.c -
3 * 3 *
4 * Copyright (c) 2003 Manuel Estrada Sainz <ranty@debian.org> 4 * Copyright (c) 2003 Manuel Estrada Sainz
5 * 5 *
6 * NOTE: This is just a probe of concept, if you think that your driver would 6 * NOTE: This is just a probe of concept, if you think that your driver would
7 * be well served by this mechanism please contact me first. 7 * be well served by this mechanism please contact me first.
@@ -19,7 +19,7 @@
19#include <linux/firmware.h> 19#include <linux/firmware.h>
20 20
21 21
22MODULE_AUTHOR("Manuel Estrada Sainz <ranty@debian.org>"); 22MODULE_AUTHOR("Manuel Estrada Sainz");
23MODULE_DESCRIPTION("Hackish sample for using firmware class directly"); 23MODULE_DESCRIPTION("Hackish sample for using firmware class directly");
24MODULE_LICENSE("GPL"); 24MODULE_LICENSE("GPL");
25 25