2.4.36-stable kernel tree
Revision | fa44f7009d166697b93f57582679de8cd9955857 (tree) |
---|---|
Zeit | 2007-07-22 21:45:10 |
Autor | Willy Tarreau <w@1wt....> |
Commiter | Willy Tarreau |
[PATCH] Documentations/SubmittingPatches was outdated
Li Yang <leo@zh-kernel.org> proposed a patch to update
SubmittingPatches in 2.6, and looking at 2.4's state, it
was clearly outdated. I just updated to the 2.6 version
without the section about power management.
@@ -3,7 +3,8 @@ Submitting Drivers For The Linux Kernel | ||
3 | 3 | |
4 | 4 | This document is intended to explain how to submit device drivers to the |
5 | 5 | various kernel trees. Note that if you are interested in video card drivers |
6 | -you should probably talk to XFree86 (http://www.xfree86.org) instead. | |
6 | +you should probably talk to XFree86 (http://www.xfree86.org/) and/or X.Org | |
7 | +(http://x.org/) instead. | |
7 | 8 | |
8 | 9 | Also read the Documentation/SubmittingPatches document. |
9 | 10 |
@@ -12,48 +13,56 @@ Allocating Device Numbers | ||
12 | 13 | ------------------------- |
13 | 14 | |
14 | 15 | Major and minor numbers for block and character devices are allocated |
15 | -by the Linux assigned name and number authority (currently better | |
16 | -known as H Peter Anvin). The site is http://www.lanana.org/. This | |
16 | +by the Linux assigned name and number authority (currently this is | |
17 | +Torben Mathiasen). The site is http://www.lanana.org/. This | |
17 | 18 | also deals with allocating numbers for devices that are not going to |
18 | 19 | be submitted to the mainstream kernel. |
20 | +See Documentation/devices.txt for more information on this. | |
19 | 21 | |
20 | -If you don't use assigned numbers then when you device is submitted it will | |
21 | -get given an assigned number even if that is different from values you may | |
22 | +If you don't use assigned numbers then when your device is submitted it will | |
23 | +be given an assigned number even if that is different from values you may | |
22 | 24 | have shipped to customers before. |
23 | 25 | |
24 | 26 | Who To Submit Drivers To |
25 | 27 | ------------------------ |
26 | 28 | |
27 | 29 | Linux 2.0: |
28 | - No new drivers are accepted for this kernel tree | |
30 | + No new drivers are accepted for this kernel tree. | |
29 | 31 | |
30 | 32 | Linux 2.2: |
33 | + No new drivers are accepted for this kernel tree. | |
34 | + | |
35 | +Linux 2.4: | |
31 | 36 | If the code area has a general maintainer then please submit it to |
32 | 37 | the maintainer listed in MAINTAINERS in the kernel file. If the |
33 | 38 | maintainer does not respond or you cannot find the appropriate |
34 | - maintainer then please contact Alan Cox <alan@lxorguk.ukuu.org.uk> | |
39 | + maintainer then please contact Willy Tarreau <w@1wt.eu>. | |
35 | 40 | |
36 | -Linux 2.4: | |
37 | - The same rules apply as 2.2. The final contact point for Linux 2.4 | |
38 | - submissions is Marcelo Tosatti <marcelo.tosatti@cyclades.com>. | |
39 | - | |
40 | -Linux 2.5: | |
41 | +Linux 2.6: | |
41 | 42 | The same rules apply as 2.4 except that you should follow linux-kernel |
42 | - to track changes in API's. The final contact point for Linux 2.5 | |
43 | - submissions is Linus Torvalds <torvalds@osdl.org>. | |
43 | + to track changes in API's. The final contact point for Linux 2.6 | |
44 | + submissions is Andrew Morton <akpm@osdl.org>. | |
44 | 45 | |
45 | 46 | What Criteria Determine Acceptance |
46 | 47 | ---------------------------------- |
47 | 48 | |
48 | 49 | Licensing: The code must be released to us under the |
49 | 50 | GNU General Public License. We don't insist on any kind |
50 | - of exclusively GPL licensing, and if you wish the driver | |
51 | + of exclusive GPL licensing, and if you wish the driver | |
51 | 52 | to be useful to other communities such as BSD you may well |
52 | 53 | wish to release under multiple licenses. |
54 | + See accepted licenses at include/linux/module.h | |
55 | + | |
56 | +Copyright: The copyright owner must agree to use of GPL. | |
57 | + It's best if the submitter and copyright owner | |
58 | + are the same person/entity. If not, the name of | |
59 | + the person/entity authorizing use of GPL should be | |
60 | + listed in case it's necessary to verify the will of | |
61 | + the copyright owner. | |
53 | 62 | |
54 | 63 | Interfaces: If your driver uses existing interfaces and behaves like |
55 | 64 | other drivers in the same class it will be much more likely |
56 | - to be accepted than if it invents gratuitous new ones. | |
65 | + to be accepted than if it invents gratuitous new ones. | |
57 | 66 | If you need to implement a common API over Linux and NT |
58 | 67 | drivers do it in userspace. |
59 | 68 |
@@ -61,7 +70,7 @@ Code: Please use the Linux style of code formatting as documented | ||
61 | 70 | in Documentation/CodingStyle. If you have sections of code |
62 | 71 | that need to be in other formats, for example because they |
63 | 72 | are shared with a windows driver kit and you want to |
64 | - maintain them just once seperate them out nicely and note | |
73 | + maintain them just once separate them out nicely and note | |
65 | 74 | this fact. |
66 | 75 | |
67 | 76 | Portability: Pointers are not always 32bits, not all computers are little |
@@ -78,7 +87,7 @@ Clarity: It helps if anyone can see how to fix the driver. It helps | ||
78 | 87 | it will go in the bitbucket. |
79 | 88 | |
80 | 89 | Control: In general if there is active maintainance of a driver by |
81 | - the author then patches will be redirected to them unless | |
90 | + the author then patches will be redirected to them unless | |
82 | 91 | they are totally obvious and without need of checking. |
83 | 92 | If you want to be the contact and update point for the |
84 | 93 | driver it is a good idea to state this in the comments, |
@@ -90,7 +99,7 @@ What Criteria Do Not Determine Acceptance | ||
90 | 99 | Vendor: Being the hardware vendor and maintaining the driver is |
91 | 100 | often a good thing. If there is a stable working driver from |
92 | 101 | other people already in the tree don't expect 'we are the |
93 | - vendor' to get your driver chosen. Ideally work with the | |
102 | + vendor' to get your driver chosen. Ideally work with the | |
94 | 103 | existing driver author to build a single perfect driver. |
95 | 104 | |
96 | 105 | Author: It doesn't matter if a large Linux company wrote the driver, |
@@ -106,14 +115,33 @@ Linux kernel master tree: | ||
106 | 115 | ftp.??.kernel.org:/pub/linux/kernel/... |
107 | 116 | ?? == your country code, such as "us", "uk", "fr", etc. |
108 | 117 | |
109 | -Linux kernel mailing list: | |
118 | +Linux kernel mailing list: | |
110 | 119 | linux-kernel@vger.kernel.org |
111 | 120 | [mail majordomo@vger.kernel.org to subscribe] |
112 | 121 | |
113 | -Kernel traffic: | |
114 | - Weekly summary of kernel list activity (much easier to read) | |
115 | - [http://kt.zork.net/kernel-traffic] | |
122 | +Linux Device Drivers, Third Edition (covers 2.6.10): | |
123 | + http://lwn.net/Kernel/LDD3/ (free version) | |
124 | + | |
125 | +LWN.net: | |
126 | + Weekly summary of kernel development activity - http://lwn.net/ | |
127 | + 2.6 API changes: | |
128 | + http://lwn.net/Articles/2.6-kernel-api/ | |
129 | + Porting drivers from prior kernels to 2.6: | |
130 | + http://lwn.net/Articles/driver-porting/ | |
131 | + | |
132 | +KernelTrap: | |
133 | + Occasional Linux kernel articles and developer interviews | |
134 | + http://kerneltrap.org/ | |
135 | + | |
136 | +KernelNewbies: | |
137 | + Documentation and assistance for new kernel programmers | |
138 | + http://kernelnewbies.org/ | |
116 | 139 | |
117 | 140 | Linux USB project: |
118 | - http://sourceforge.net/projects/linux-usb/ | |
141 | + http://www.linux-usb.org/ | |
142 | + | |
143 | +How to NOT write kernel driver by Arjan van de Ven: | |
144 | + http://www.fenrus.org/how-to-not-write-a-device-driver-paper.pdf | |
119 | 145 | |
146 | +Kernel Janitor: | |
147 | + http://janitor.kernelnewbies.org/ |