Commit 53ecbbba authored by Dave Jones's avatar Dave Jones Committed by Linus Torvalds

[PATCH] Updated submitting drivers docs

parent 93c5435c
...@@ -2,9 +2,8 @@ Submitting Drivers For The Linux Kernel ...@@ -2,9 +2,8 @@ Submitting Drivers For The Linux Kernel
--------------------------------------- ---------------------------------------
This document is intended to explain how to submit device drivers to the This document is intended to explain how to submit device drivers to the
Linux 2.2 and 2.4 kernel trees. Note that if you are interested in video various kernel trees. Note that if you are interested in video card drivers
card drivers you should probably talk to XFree86 (http://www.xfree86.org) you should probably talk to XFree86 (http://www.xfree86.org) instead.
instead.
Also read the Documentation/SubmittingPatches document. Also read the Documentation/SubmittingPatches document.
...@@ -35,21 +34,23 @@ Linux 2.2: ...@@ -35,21 +34,23 @@ Linux 2.2:
maintainer then please contact Alan Cox <alan@lxorguk.ukuu.org.uk> maintainer then please contact Alan Cox <alan@lxorguk.ukuu.org.uk>
Linux 2.4: Linux 2.4:
This kernel tree is under active development. The same rules apply The same rules apply as 2.2 but this kernel tree is under active
as 2.2 but you may wish to submit your driver via linux-kernel (see development. The final contact point for Linux 2.4 submissions is
resources) and follow that list to track changes in API's. These Marcelo Tosatti <marcelo@conectiva.com.br>.
should no longer be occuring as we are now in a code freeze.
The final contact point for Linux 2.4 submissions is Linux 2.5:
<torvalds@transmeta.com>. The same rules apply as 2.4 except that you should follow linux-kernel
to track changes in API's. The final contact point for Linux 2.5
submissions is Linus Torvalds <torvalds@transmeta.com>.
What Criteria Determine Acceptance What Criteria Determine Acceptance
---------------------------------- ----------------------------------
Licensing: The code must be released to us under the GNU General Public License. Licensing: The code must be released to us under the
We don't insist on any kind of exclusively GPL licensing, GNU General Public License. We don't insist on any kind
and if you wish the driver to be useful to other communities of exclusively GPL licensing, and if you wish the driver
such as BSD you may well wish to release under multiple to be useful to other communities such as BSD you may well
licenses. wish to release under multiple licenses.
Interfaces: If your driver uses existing interfaces and behaves like Interfaces: If your driver uses existing interfaces and behaves like
other drivers in the same class it will be much more likely other drivers in the same class it will be much more likely
...@@ -64,12 +65,13 @@ Code: Please use the Linux style of code formatting as documented ...@@ -64,12 +65,13 @@ Code: Please use the Linux style of code formatting as documented
maintain them just once seperate them out nicely and note maintain them just once seperate them out nicely and note
this fact. this fact.
Portability: Pointers are not always 32bits, people do not all have Portability: Pointers are not always 32bits, not all computers are little
floating point and you shouldn't use inline x86 assembler in endian, people do not all have floating point and you
your driver without careful thought. Pure x86 drivers shouldn't use inline x86 assembler in your driver without
generally are not popular. If you only have x86 hardware it careful thought. Pure x86 drivers generally are not popular.
is hard to test portability but it is easy to make sure the If you only have x86 hardware it is hard to test portability
code can easily be made portable. but it is easy to make sure the code can easily be made
portable.
Clarity: It helps if anyone can see how to fix the driver. It helps Clarity: It helps if anyone can see how to fix the driver. It helps
you because you get patches not bug reports. If you submit a you because you get patches not bug reports. If you submit a
......
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