如果想評論或更新本文的內(nèi)容,請直接聯(lián)系原文檔的維護者。如果你使用英文
交流有困難的話,也可以向中文版維護者求助。如果本翻譯更新不及時或者翻
譯存在問題,請聯(lián)系中文版維護者。
英文版維護者: Greg Kroah-Hartman <greg@kroah.com>
中文版維護者: 李陽 Li Yang <leoli@freescale.com>
中文版翻譯者: 李陽 Li Yang <leoli@freescale.com>
中文版校譯者: 鐘宇 TripleX Chung <xxx.phy@gmail.com>
陳琦 Maggie Chen <chenqi@beyondsoft.com>
王聰 Wang Cong <xiyou.wangcong@gmail.com>
以下為正文
---------------------------------------------------------------------
如何參與Linux內(nèi)核開發(fā)
---------------------
這是一篇將如何參與Linux內(nèi)核開發(fā)的相關(guān)問題一網(wǎng)打盡的終極秘笈。它將指導(dǎo)你
成為一名Linux內(nèi)核開發(fā)者,并且學(xué)會如何同Linux內(nèi)核開發(fā)社區(qū)合作。它盡可能不
包括任何關(guān)于內(nèi)核編程的技術(shù)細節(jié),但會給你指引一條獲得這些知識的正確途徑。
如果這篇文章中的任何內(nèi)容不再適用,請給文末列出的文件維護者發(fā)送補丁。
入門
----
你想了解如何成為一名Linux內(nèi)核開發(fā)者?或者老板吩咐你“給這個設(shè)備寫個Linux
驅(qū)動程序”?這篇文章的目的就是教會你達成這些目標的全部訣竅,它將描述你需
要經(jīng)過的流程以及給出如何同內(nèi)核社區(qū)合作的一些提示。它還將試圖解釋內(nèi)核社區(qū)
為何這樣運作。
Linux內(nèi)核大部分是由C語言寫成的,一些體系結(jié)構(gòu)相關(guān)的代碼用到了匯編語言。要
參與內(nèi)核開發(fā),你必須精通C語言。除非你想為某個架構(gòu)開發(fā)底層代碼,否則你并
不需要了解(任何體系結(jié)構(gòu)的)匯編語言。下面列舉的書籍雖然不能替代扎實的C
語言教育和多年的開發(fā)經(jīng)驗,但如果需要的話,做為參考還是不錯的:
- "The C Programming Language" by Kernighan and Ritchie [Prentice Hall]
《C程序設(shè)計語言(第2版·新版)》(徐寶文 李志 譯)[機械工業(yè)出版社]
- "Practical C Programming" by Steve Oualline [O'Reilly]
《實用C語言編程(第三版)》(郭大海 譯)[中國電力出版社]
- "C: A Reference Manual" by Harbison and Steele [Prentice Hall]
《C語言參考手冊(原書第5版)》(邱仲潘 等譯)[機械工業(yè)出版社]
Linux內(nèi)核使用GNU C和GNU工具鏈開發(fā)。雖然它遵循ISO C89標準,但也用到了一些
標準中沒有定義的擴展。內(nèi)核是自給自足的C環(huán)境,不依賴于標準C庫的支持,所以
并不支持C標準中的部分定義。比如long long類型的大數(shù)除法和浮點運算就不允許
使用。有時候確實很難弄清楚內(nèi)核對工具鏈的要求和它所使用的擴展,不幸的是目
前還沒有明確的參考資料可以解釋它們。請查閱gcc信息頁(使用“info gcc”命令
顯示)獲得一些這方面信息。
請記住你是在學(xué)習(xí)怎么和已經(jīng)存在的開發(fā)社區(qū)打交道。它由一群形形色色的人組成,
他們對代碼、風格和過程有著很高的標準。這些標準是在長期實踐中總結(jié)出來的,
適應(yīng)于地理上分散的大型開發(fā)團隊。它們已經(jīng)被很好得整理成檔,建議你在開發(fā)
之前盡可能多的學(xué)習(xí)這些標準,而不要期望別人來適應(yīng)你或者你公司的行為方式。
法律問題
--------
Linux內(nèi)核源代碼都是在GPL(通用公共許可證)的保護下發(fā)布的。要了解這種許可
的細節(jié)請查看源代碼主目錄下的COPYING文件。如果你對它還有更深入問題請聯(lián)系
律師,而不要在Linux內(nèi)核郵件組上提問。因為郵件組里的人并不是律師,不要期
望他們的話有法律效力。
對于GPL的常見問題和解答,請訪問以下鏈接:
http://www./licenses/gpl-faq.html
文檔
----
Linux內(nèi)核代碼中包含有大量的文檔。這些文檔對于學(xué)習(xí)如何與內(nèi)核社區(qū)互動有著
不可估量的價值。當一個新的功能被加入內(nèi)核,最好把解釋如何使用這個功能的文
檔也放進內(nèi)核。當內(nèi)核的改動導(dǎo)致面向用戶空間的接口發(fā)生變化時,最好將相關(guān)信
息或手冊頁(manpages)的補丁發(fā)到mtk.manpages@gmail.com,以向手冊頁(manpages)
的維護者解釋這些變化。
以下是內(nèi)核代碼中需要閱讀的文檔:
README
文件簡要介紹了Linux內(nèi)核的背景,并且描述了如何配置和編譯內(nèi)核。內(nèi)核的
新用戶應(yīng)該從這里開始。
Documentation/Changes
文件給出了用來編譯和使用內(nèi)核所需要的最小軟件包列表。
Documentation/CodingStyle
描述Linux內(nèi)核的代碼風格和理由。所有新代碼需要遵守這篇文檔中定義的規(guī)
范。大多數(shù)維護者只會接收符合規(guī)定的補丁,很多人也只會幫忙檢查符合風格
的代碼。
Documentation/SubmittingPatches
Documentation/SubmittingDrivers
這兩份文檔明確描述如何創(chuàng)建和發(fā)送補丁,其中包括(但不僅限于):
- 郵件內(nèi)容
- 郵件格式
- 選擇收件人
遵守這些規(guī)定并不能保證提交成功(因為所有補丁需要通過嚴格的內(nèi)容和風格
審查),但是忽視他們幾乎就意味著失敗。
其他關(guān)于如何正確地生成補丁的優(yōu)秀文檔包括:
"The Perfect Patch"
http://userweb./~akpm/stuff/tpp.txt
"Linux kernel patch submission format"
http://linux./patch-format.html
Documentation/stable_api_nonsense.txt
論證內(nèi)核為什么特意不包括穩(wěn)定的內(nèi)核內(nèi)部API,也就是說不包括像這樣的特
性:
- 子系統(tǒng)中間層(為了兼容性?)
- 在不同操作系統(tǒng)間易于移植的驅(qū)動程序
- 減緩(甚至阻止)內(nèi)核代碼的快速變化
這篇文檔對于理解Linux的開發(fā)哲學(xué)至關(guān)重要。對于將開發(fā)平臺從其他操作系
統(tǒng)轉(zhuǎn)移到Linux的人來說也很重要。
Documentation/SecurityBugs
如果你認為自己發(fā)現(xiàn)了Linux內(nèi)核的安全性問題,請根據(jù)這篇文檔中的步驟來
提醒其他內(nèi)核開發(fā)者并幫助解決這個問題。
Documentation/ManagementStyle
描述內(nèi)核維護者的工作方法及其共有特點。這對于剛剛接觸內(nèi)核開發(fā)(或者對
它感到好奇)的人來說很重要,因為它解釋了很多對于內(nèi)核維護者獨特行為的
普遍誤解與迷惑。
Documentation/stable_kernel_rules.txt
解釋了穩(wěn)定版內(nèi)核發(fā)布的規(guī)則,以及如何將改動放入這些版本的步驟。
Documentation/kernel-docs.txt
有助于內(nèi)核開發(fā)的外部文檔列表。如果你在內(nèi)核自帶的文檔中沒有找到你想找
的內(nèi)容,可以查看這些文檔。
Documentation/applying-patches.txt
關(guān)于補丁是什么以及如何將它打在不同內(nèi)核開發(fā)分支上的好介紹
內(nèi)核還擁有大量從代碼自動生成的文檔。它包含內(nèi)核內(nèi)部API的全面介紹以及如何
妥善處理加鎖的規(guī)則。生成的文檔會放在 Documentation/DocBook/目錄下。在內(nèi)
核源碼的主目錄中使用以下不同命令將會分別生成PDF、Postscript、HTML和手冊
頁等不同格式的文檔:
make pdfdocs
make psdocs
make htmldocs
make mandocs
如何成為內(nèi)核開發(fā)者
------------------
如果你對Linux內(nèi)核開發(fā)一無所知,你應(yīng)該訪問“Linux內(nèi)核新手”計劃:
http://
它擁有一個可以問各種最基本的內(nèi)核開發(fā)問題的郵件列表(在提問之前一定要記得
查找已往的郵件,確認是否有人已經(jīng)回答過相同的問題)。它還擁有一個可以獲得
實時反饋的IRC聊天頻道,以及大量對于學(xué)習(xí)Linux內(nèi)核開發(fā)相當有幫助的文檔。
網(wǎng)站簡要介紹了源代碼組織結(jié)構(gòu)、子系統(tǒng)劃分以及目前正在進行的項目(包括內(nèi)核
中的和單獨維護的)。它還提供了一些基本的幫助信息,比如如何編譯內(nèi)核和打補
丁。
如果你想加入內(nèi)核開發(fā)社區(qū)并協(xié)助完成一些任務(wù),卻找不到從哪里開始,可以訪問
“Linux內(nèi)核房管員”計劃:
http:///KernelJanitors
這是極佳的起點。它提供一個相對簡單的任務(wù)列表,列出內(nèi)核代碼中需要被重新
整理或者改正的地方。通過和負責這個計劃的開發(fā)者們一同工作,你會學(xué)到將補丁
集成進內(nèi)核的基本原理。如果還沒有決定下一步要做什么的話,你還可能會得到方
向性的指點。
如果你已經(jīng)有一些現(xiàn)成的代碼想要放到內(nèi)核中,但是需要一些幫助來使它們擁有正
確的格式。請訪問“內(nèi)核導(dǎo)師”計劃。這個計劃就是用來幫助你完成這個目標的。它
是一個郵件列表,地址如下:
http:///mailman/listinfo/kernel-mentors
在真正動手修改內(nèi)核代碼之前,理解要修改的代碼如何運作是必需的。要達到這個
目的,沒什么辦法比直接讀代碼更有效了(大多數(shù)花招都會有相應(yīng)的注釋),而且
一些特制的工具還可以提供幫助。例如,“Linux代碼交叉引用”項目就是一個值得
特別推薦的幫助工具,它將源代碼顯示在有編目和索引的網(wǎng)頁上。其中一個更新及
時的內(nèi)核源碼庫,可以通過以下地址訪問:
http:///~coywolf/lxr/
開發(fā)流程
--------
目前Linux內(nèi)核開發(fā)流程包括幾個“主內(nèi)核分支”和很多子系統(tǒng)相關(guān)的內(nèi)核分支。這
些分支包括:
- 2.6.x主內(nèi)核源碼樹
- 2.6.x.y -stable內(nèi)核源碼樹
- 2.6.x -git內(nèi)核補丁集
- 2.6.x -mm內(nèi)核補丁集
- 子系統(tǒng)相關(guān)的內(nèi)核源碼樹和補丁集
2.6.x內(nèi)核主源碼樹
-----------------
2.6.x內(nèi)核是由Linus Torvalds(Linux的創(chuàng)造者)親自維護的。你可以在
網(wǎng)站的pub/linux/kernel/v2.6/目錄下找到它。它的開發(fā)遵循以下步
驟:
- 每當一個新版本的內(nèi)核被發(fā)布,為期兩周的集成窗口將被打開。在這段時間里
維護者可以向Linus提交大段的修改,通常這些修改已經(jīng)被放到-mm內(nèi)核中幾個
星期了。提交大量修改的首選方式是使用git工具(內(nèi)核的代碼版本管理工具
,更多的信息可以在http://git./獲取),不過使用普通補丁也是可以
的。
- 兩個星期以后-rc1版本內(nèi)核發(fā)布。之后只有不包含可能影響整個內(nèi)核穩(wěn)定性的
新功能的補丁才可能被接受。請注意一個全新的驅(qū)動程序(或者文件系統(tǒng))有
可能在-rc1后被接受是因為這樣的修改完全獨立,不會影響其他的代碼,所以
沒有造成內(nèi)核退步的風險。在-rc1以后也可以用git向Linus提交補丁,不過所
有的補丁需要同時被發(fā)送到相應(yīng)的公眾郵件列表以征詢意見。
- 當Linus認為當前的git源碼樹已經(jīng)達到一個合理健全的狀態(tài)足以發(fā)布供人測試
時,一個新的-rc版本就會被發(fā)布。計劃是每周都發(fā)布新的-rc版本。
- 這個過程一直持續(xù)下去直到內(nèi)核被認為達到足夠穩(wěn)定的狀態(tài),持續(xù)時間大概是
6個星期。
- 以下地址跟蹤了在每個-rc發(fā)布中發(fā)現(xiàn)的退步列表:
http:///known_regressions
關(guān)于內(nèi)核發(fā)布,值得一提的是Andrew Morton在linux-kernel郵件列表中如是說:
“沒有人知道新內(nèi)核何時會被發(fā)布,因為發(fā)布是根據(jù)已知bug的情況來決定
的,而不是根據(jù)一個事先制定好的時間表?!?/div>
2.6.x.y -stable(穩(wěn)定版)內(nèi)核源碼樹
-----------------------------------
由4個數(shù)字組成的內(nèi)核版本號說明此內(nèi)核是-stable版本。它們包含基于2.6.x版本
內(nèi)核的相對較小且至關(guān)重要的修補,這些修補針對安全性問題或者嚴重的內(nèi)核退步。
這種版本的內(nèi)核適用于那些期望獲得最新的穩(wěn)定版內(nèi)核并且不想?yún)⑴c測試開發(fā)版或
者實驗版的用戶。
如果沒有2.6.x.y版本內(nèi)核存在,那么最新的2.6.x版本內(nèi)核就相當于是當前的穩(wěn)定
版內(nèi)核。
2.6.x.y版本由“穩(wěn)定版”小組(郵件地址<stable@>)維護,一般隔周發(fā)
布新版本。
內(nèi)核源碼中的Documentation/stable_kernel_rules.txt文件具體描述了可被穩(wěn)定
版內(nèi)核接受的修改類型以及發(fā)布的流程。
2.6.x -git補丁集
----------------
Linus的內(nèi)核源碼樹的每日快照,這個源碼樹是由git工具管理的(由此得名)。這
些補丁通常每天更新以反映Linus的源碼樹的最新狀態(tài)。它們比-rc版本的內(nèi)核源碼
樹更具試驗性質(zhì),因為這個補丁集是全自動生成的,沒有任何人來確認其是否真正
健全。
2.6.x -mm補丁集
---------------
這是由Andrew Morton維護的試驗性內(nèi)核補丁集。Andrew將所有子系統(tǒng)的內(nèi)核源碼
和補丁拼湊到一起,并且加入了大量從linux-kernel郵件列表中采集的補丁。這個
源碼樹是新功能和補丁的試煉場。當補丁在-mm補丁集里證明了其價值以后Andrew
或者相應(yīng)子系統(tǒng)的維護者會將補丁發(fā)給Linus以便集成進主內(nèi)核源碼樹。
在將所有新補丁發(fā)給Linus以集成到主內(nèi)核源碼樹之前,我們非常鼓勵先把這些補
丁放在-mm版內(nèi)核源碼樹中進行測試。
這些內(nèi)核版本不適合在需要穩(wěn)定運行的系統(tǒng)上運行,因為運行它們比運行任何其他
內(nèi)核分支都更具有風險。
如果你想為內(nèi)核開發(fā)進程提供幫助,請嘗試并使用這些內(nèi)核版本,并在
linux-kernel郵件列表中提供反饋,告訴大家你遇到了問題還是一切正常。
通常-mm版補丁集不光包括這些額外的試驗性補丁,還包括發(fā)布時-git版主源碼樹
中的改動。
-mm版內(nèi)核沒有固定的發(fā)布周期,但是通常在每兩個-rc版內(nèi)核發(fā)布之間都會有若干
個-mm版內(nèi)核發(fā)布(一般是1至3個)。
子系統(tǒng)相關(guān)內(nèi)核源碼樹和補丁集
----------------------------
相當一部分內(nèi)核子系統(tǒng)開發(fā)者會公開他們自己的開發(fā)源碼樹,以便其他人能了解內(nèi)
核的不同領(lǐng)域正在發(fā)生的事情。如上所述,這些源碼樹會被集成到-mm版本內(nèi)核中。
下面是目前可用的一些內(nèi)核源碼樹的列表:
通過git管理的源碼樹:
- Kbuild開發(fā)源碼樹, Sam Ravnborg <sam@ravnborg.org>
git.:/pub/scm/linux/kernel/git/sam/kbuild.git
- ACPI開發(fā)源碼樹, Len Brown <len.brown@intel.com>
git.:/pub/scm/linux/kernel/git/lenb/linux-acpi-2.6.git
- 塊設(shè)備開發(fā)源碼樹, Jens Axboe <axboe@suse.de>
git.:/pub/scm/linux/kernel/git/axboe/linux-2.6-block.git
- DRM開發(fā)源碼樹, Dave Airlie <airlied@linux.ie>
git.:/pub/scm/linux/kernel/git/airlied/drm-2.6.git
- ia64開發(fā)源碼樹, Tony Luck <tony.luck@intel.com>
git.:/pub/scm/linux/kernel/git/aegl/linux-2.6.git
- ieee1394開發(fā)源碼樹, Jody McIntyre <scjody@modernduck.com>
git.:/pub/scm/linux/kernel/git/scjody/ieee1394.git
- infiniband開發(fā)源碼樹, Roland Dreier <rolandd@cisco.com>
git.:/pub/scm/linux/kernel/git/roland/infiniband.git
- libata開發(fā)源碼樹, Jeff Garzik <jgarzik@pobox.com>
git.:/pub/scm/linux/kernel/git/jgarzik/libata-dev.git
- 網(wǎng)絡(luò)驅(qū)動程序開發(fā)源碼樹, Jeff Garzik <jgarzik@pobox.com>
git.:/pub/scm/linux/kernel/git/jgarzik/netdev-2.6.git
- pcmcia開發(fā)源碼樹, Dominik Brodowski <linux@dominikbrodowski.net>
git.:/pub/scm/linux/kernel/git/brodo/pcmcia-2.6.git
- SCSI開發(fā)源碼樹, James Bottomley <James.Bottomley@SteelEye.com>
git.:/pub/scm/linux/kernel/git/jejb/scsi-misc-2.6.git
使用quilt管理的補丁集:
- USB, PCI, 驅(qū)動程序核心和I2C, Greg Kroah-Hartman <gregkh@linuxfoundation.org>
/pub/linux/kernel/people/gregkh/gregkh-2.6/
- x86-64, 部分i386, Andi Kleen <ak@suse.de>
ftp.firstfloor.org:/pub/ak/x86_64/quilt/
其他內(nèi)核源碼樹可以在http://git.的列表中和MAINTAINERS文件里
找到。
報告bug
-------
bugzilla.是Linux內(nèi)核開發(fā)者們用來跟蹤內(nèi)核Bug的網(wǎng)站。我們鼓勵用
戶在這個工具中報告找到的所有bug。如何使用內(nèi)核bugzilla的細節(jié)請訪問:
http://test./bugzilla/faq.html
內(nèi)核源碼主目錄中的REPORTING-BUGS文件里有一個很好的模板。它指導(dǎo)用戶如何報
告可能的內(nèi)核bug以及需要提供哪些信息來幫助內(nèi)核開發(fā)者們找到問題的根源。
利用bug報告
-----------
練習(xí)內(nèi)核開發(fā)技能的最好辦法就是修改其他人報告的bug。你不光可以幫助內(nèi)核變
得更加穩(wěn)定,還可以學(xué)會如何解決實際問題從而提高自己的技能,并且讓其他開發(fā)
者感受到你的存在。修改bug是贏得其他開發(fā)者贊譽的最好辦法,因為并不是很多
人都喜歡浪費時間去修改別人報告的bug。
要嘗試修改已知的bug,請訪問http://bugzilla.網(wǎng)址。如果你想獲得
最新bug的通知,可以訂閱bugme-new郵件列表(只有新的bug報告會被寄到這里)
或者訂閱bugme-janitor郵件列表(所有bugzilla的變動都會被寄到這里)。
https://lists./mailman/listinfo/bugme-new
https://lists./mailman/listinfo/bugme-janitors
郵件列表
--------
正如上面的文檔所描述,大多數(shù)的骨干內(nèi)核開發(fā)者都加入了Linux Kernel郵件列
表。如何訂閱和退訂列表的細節(jié)可以在這里找到:
http://vger./vger-lists.html#linux-kernel
網(wǎng)上很多地方都有這個郵件列表的存檔(archive)。可以使用搜索引擎來找到這些
存檔。比如:
http://dir./gmane.linux.kernel
在發(fā)信之前,我們強烈建議你先在存檔中搜索你想要討論的問題。很多已經(jīng)被詳細
討論過的問題只在郵件列表的存檔中可以找到。
大多數(shù)內(nèi)核子系統(tǒng)也有自己獨立的郵件列表來協(xié)調(diào)各自的開發(fā)工作。從
MAINTAINERS文件中可以找到不同話題對應(yīng)的郵件列表。
很多郵件列表架設(shè)在服務(wù)器上。這些列表的信息可以在這里找到:
http://vger./vger-lists.html
在使用這些郵件列表時,請記住保持良好的行為習(xí)慣。下面的鏈接提供了與這些列
表(或任何其它郵件列表)交流的一些簡單規(guī)則,雖然內(nèi)容有點濫竽充數(shù)。
http://www./netiquette/
當有很多人回復(fù)你的郵件時,郵件的抄送列表會變得很長。請不要將任何人從抄送
列表中刪除,除非你有足夠的理由這么做。也不要只回復(fù)到郵件列表。請習(xí)慣于同
一封郵件接收兩次(一封來自發(fā)送者一封來自郵件列表),而不要試圖通過添加一
些奇特的郵件頭來解決這個問題,人們不會喜歡的。
記住保留你所回復(fù)內(nèi)容的上下文和源頭。在你回復(fù)郵件的頂部保留“某某某說到……”
這幾行。將你的評論加在被引用的段落之間而不要放在郵件的頂部。
如果你在郵件中附帶補丁,請確認它們是可以直接閱讀的純文本(如
Documentation/SubmittingPatches文檔中所述)。內(nèi)核開發(fā)者們不希望遇到附件
或者被壓縮了的補丁。只有這樣才能保證他們可以直接評論你的每行代碼。請確保
你使用的郵件發(fā)送程序不會修改空格和制表符。一個防范性的測試方法是先將郵件
發(fā)送給自己,然后自己嘗試是否可以順利地打上收到的補丁。如果測試不成功,請
調(diào)整或者更換你的郵件發(fā)送程序直到它正確工作為止。
總而言之,請尊重其他的郵件列表訂閱者。
同內(nèi)核社區(qū)合作
----------------
內(nèi)核社區(qū)的目標就是提供盡善盡美的內(nèi)核。所以當你提交補丁期望被接受進內(nèi)核的
時候,它的技術(shù)價值以及其他方面都將被評審。那么你可能會得到什么呢?
- 批評
- 評論
- 要求修改
- 要求證明修改的必要性
- 沉默
要記住,這些是把補丁放進內(nèi)核的正常情況。你必須學(xué)會聽取對補丁的批評和評論,
從技術(shù)層面評估它們,然后要么重寫你的補丁要么簡明扼要地論證修改是不必要
的。如果你發(fā)的郵件沒有得到任何回應(yīng),請過幾天后再試一次,因為有時信件會湮
沒在茫茫信海中。
你不應(yīng)該做的事情:
- 期望自己的補丁不受任何質(zhì)疑就直接被接受
- 翻臉
- 忽略別人的評論
- 沒有按照別人的要求做任何修改就重新提交
在一個努力追尋最好技術(shù)方案的社區(qū)里,對于一個補丁有多少好處總會有不同的見
解。你必須要抱著合作的態(tài)度,愿意改變自己的觀點來適應(yīng)內(nèi)核的風格?;蛘咧辽?/div>
愿意去證明你的想法是有價值的。記住,犯錯誤是允許的,只要你愿意朝著正確的
方案去努力。
如果你的第一個補丁換來的是一堆修改建議,這是很正常的。這并不代表你的補丁
不會被接受,也不意味著有人和你作對。你只需要改正所有提出的問題然后重新發(fā)
送你的補丁。
內(nèi)核社區(qū)和公司文化的差異
------------------------
內(nèi)核社區(qū)的工作模式同大多數(shù)傳統(tǒng)公司開發(fā)隊伍的工作模式并不相同。下面這些例
子,可以幫助你避免某些可能發(fā)生問題:
用這些話介紹你的修改提案會有好處:
- 它同時解決了多個問題
- 它刪除了2000行代碼
- 這是補丁,它已經(jīng)解釋了我想要說明的
- 我在5種不同的體系結(jié)構(gòu)上測試過它……
- 這是一系列小補丁用來……
- 這個修改提高了普通機器的性能……
應(yīng)該避免如下的說法:
- 我們在AIX/ptx/Solaris就是這么做的,所以這么做肯定是好的……
- 我做這行已經(jīng)20年了,所以……
- 為了我們公司賺錢考慮必須這么做
- 這是我們的企業(yè)產(chǎn)品線所需要的
- 這里是描述我觀點的1000頁設(shè)計文檔
- 這是一個5000行的補丁用來……
- 我重寫了現(xiàn)在亂七八糟的代碼,這就是……
- 我被規(guī)定了最后期限,所以這個補丁需要立刻被接受
另外一個內(nèi)核社區(qū)與大部分傳統(tǒng)公司的軟件開發(fā)隊伍不同的地方是無法面對面地交
流。使用電子郵件和IRC聊天工具做為主要溝通工具的一個好處是性別和種族歧視
將會更少。Linux內(nèi)核的工作環(huán)境更能接受婦女和少數(shù)族群,因為每個人在別人眼
里只是一個郵件地址。國際化也幫助了公平的實現(xiàn),因為你無法通過姓名來判斷人
的性別。男人有可能叫李麗,女人也有可能叫王剛。大多數(shù)在Linux內(nèi)核上工作過
并表達過看法的女性對在linux上工作的經(jīng)歷都給出了正面的評價。
對于一些不習(xí)慣使用英語的人來說,語言可能是一個引起問題的障礙。在郵件列表
中要正確地表達想法必需良好地掌握語言,所以建議你在發(fā)送郵件之前最好檢查一
下英文寫得是否正確。
拆分修改
--------
Linux內(nèi)核社區(qū)并不喜歡一下接收大段的代碼。修改需要被恰當?shù)亟榻B、討論并且
拆分成獨立的小段。這幾乎完全和公司中的習(xí)慣背道而馳。你的想法應(yīng)該在開發(fā)最
開始的階段就讓大家知道,這樣你就可以及時獲得對你正在進行的開發(fā)的反饋。這
樣也會讓社區(qū)覺得你是在和他們協(xié)作,而不是僅僅把他們當作傾銷新功能的對象。
無論如何,你不要一次性地向郵件列表發(fā)送50封信,你的補丁序列應(yīng)該永遠用不到
這么多。
將補丁拆開的原因如下:
1) 小的補丁更有可能被接受,因為它們不需要太多的時間和精力去驗證其正確性。
一個5行的補丁,可能在維護者看了一眼以后就會被接受。而500行的補丁則
需要數(shù)個小時來審查其正確性(所需時間隨補丁大小增加大約呈指數(shù)級增長)。
當出了問題的時候,小的補丁也會讓調(diào)試變得非常容易。一個一個補丁地回溯
將會比仔細剖析一個被打上的大補丁(這個補丁破壞了其他東西)容易得多。
2)不光發(fā)送小的補丁很重要,在提交之前重新編排、化簡(或者僅僅重新排列)
補丁也是很重要的。
這里有內(nèi)核開發(fā)者Al Viro打的一個比方:
“想象一個老師正在給學(xué)生批改數(shù)學(xué)作業(yè)。老師并不希望看到學(xué)生為了得
到正確解法所進行的嘗試和產(chǎn)生的錯誤。他希望看到的是最干凈最優(yōu)雅的
解答。好學(xué)生了解這點,絕不會把最終解決之前的中間方案提交上去。”
內(nèi)核開發(fā)也是這樣。維護者和評審者不希望看到一個人在解決問題時的思
考過程。他們只希望看到簡單和優(yōu)雅的解決方案。
直接給出一流的解決方案,和社區(qū)一起協(xié)作討論尚未完成的工作,這兩者之間似乎
很難找到一個平衡點。所以最好盡早開始收集有利于你進行改進的反饋;同時也要
保證修改分成很多小塊,這樣在整個項目都準備好被包含進內(nèi)核之前,其中的一部
分可能會先被接收。
必須了解這樣做是不可接受的:試圖將未完成的工作提交進內(nèi)核,然后再找時間修
復(fù)。
證明修改的必要性
----------------
除了將補丁拆成小塊,很重要的一點是讓Linux社區(qū)了解他們?yōu)槭裁葱枰@樣修改。
你必須證明新功能是有人需要的并且是有用的。
記錄修改
--------
當你發(fā)送補丁的時候,需要特別留意郵件正文的內(nèi)容。因為這里的信息將會做為補
丁的修改記錄(ChangeLog),會被一直保留以備大家查閱。它需要完全地描述補丁,
包括:
- 為什么需要這個修改
- 補丁的總體設(shè)計
- 實現(xiàn)細節(jié)
- 測試結(jié)果
想了解它具體應(yīng)該看起來像什么,請查閱以下文檔中的“ChangeLog”章節(jié):
“The Perfect Patch”
http://userweb./~akpm/stuff/tpp.txt
這些事情有時候做起來很難。要在任何方面都做到完美可能需要好幾年時間。這是
一個持續(xù)提高的過程,它需要大量的耐心和決心。只要不放棄,你一定可以做到。
很多人已經(jīng)做到了,而他們都曾經(jīng)和現(xiàn)在的你站在同樣的起點上。
---------------
感謝Paolo Ciarrocchi允許“開發(fā)流程”部分基于他所寫的文章
(http://www./newbie/2.6-development_process),感謝Randy
Dunlap和Gerrit Huizenga完善了應(yīng)該說和不該說的列表。感謝Pat Mochel, Hanna
Linder, Randy Dunlap, Kay Sievers, Vojtech Pavlik, Jan Kara, Josh Boyer,
Kees Cook, Andrew Morton, Andi Kleen, Vadim Lobanov, Jesper Juhl, Adrian
Bunk, Keri Harris, Frans Pop, David A. Wheeler, Junio Hamano, Michael
Kerrisk和Alex Shepard的評審、建議和貢獻。沒有他們的幫助,這篇文檔是不可
能完成的。
英文版維護者: Greg Kroah-Hartman <greg@kroah.com>
|
|
來自: quain館 > 《學(xué)習(xí)》