提交 390f915a 编写于 作者: H Hu Haowen 提交者: Jonathan Corbet

docs/zh_TW: add translations for zh_TW/process

Create new translations for zh_TW/process and link them to index.
Signed-off-by: NHu Haowen <src.res@email.cn>
Reviewed-by: NPan Yunwang <panyunwang849@gmail.com>
Link: https://lore.kernel.org/r/20210729155627.41744-2-src.res@email.cnSigned-off-by: NJonathan Corbet <corbet@lwn.net>
上级 76f1fc26
......@@ -22,9 +22,7 @@
下面的文檔介紹了Linux內核原始碼的許可證(GPLv2)、如何在原始碼樹中正確標記
單個文件的許可證、以及指向完整許可證文本的連結。
TODOList:
* Documentation/translations/zh_TW/process/license-rules.rst
Documentation/translations/zh_TW/process/license-rules.rst
用戶文檔
--------
......@@ -67,9 +65,13 @@ TODOlist:
開發人員做出貢獻。與任何大型社區一樣,知道如何完成任務將使得更改合併的過程
變得更加容易。
.. toctree::
:maxdepth: 2
process/index
TODOList:
* process/index
* dev-tools/index
* doc-guide/index
* kernel-hacking/index
......
.. SPDX-License-Identifier: GPL-2.0
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/1.Intro.rst <development_process_intro>`
:Translator:
時奎亮 Alex Shi <alex.shi@linux.alibaba.com>
:校譯:
吳想成 Wu XiangCheng <bobwxc@email.cn>
胡皓文 Hu Haowen <src.res@email.cn>
.. _tw_development_process_intro:
引言
====
內容提要
--------
本節的其餘部分涵蓋了內核開發的過程,以及開發人員及其僱主在這方面可能遇到的
各種問題。有很多原因使內核代碼應被合併到正式的(「主線」)內核中,包括對用戶
的自動可用性、多種形式的社區支持以及影響內核開發方向的能力。提供給Linux內核
的代碼必須在與GPL兼容的許可證下可用。
:ref:`tw_development_process` 介紹了開發過程、內核發布周期和合併窗口的機制。
涵蓋了補丁開發、審查和合併周期中的各個階段。還有一些關於工具和郵件列表的討論?
鼓勵希望開始內核開發的開發人員跟蹤並修復缺陷以作爲初步練習。
:ref:`tw_development_early_stage` 包括項目的早期規劃,重點是儘快讓開發社區
參與進來。
:ref:`tw_development_coding` 是關於編程過程的;介紹了其他開發人員遇到的幾個
陷阱。也涵蓋了對補丁的一些要求,並且介紹了一些工具,這些工具有助於確保內核
補丁是正確的。
:ref:`tw_development_posting` 描述發布補丁以供評審的過程。爲了讓開發社區能
認真對待,補丁必須被正確格式化和描述,並且必須發送到正確的地方。遵循本節中的
建議有助於確保您的工作能被較好地接納。
:ref:`tw_development_followthrough` 介紹了發布補丁之後發生的事情;工作在這時
還遠遠沒有完成。與審閱者一起工作是開發過程中的一個重要部分;本節提供了一些
關於如何在這個重要階段避免問題的提示。當補丁被合併到主線中時,開發人員要注意
不要假定任務已經完成。
:ref:`tw_development_advancedtopics` 介紹了兩個「高級」主題:使用Git管理補丁
和查看其他人發布的補丁。
:ref:`tw_development_conclusion` 總結了有關內核開發的更多信息,附帶有相關資源
連結。
這個文檔是關於什麼的
--------------------
Linux內核有超過800萬行代碼,每個版本的貢獻者超過1000人,是現存最大、最活躍的
免費軟體項目之一。從1991年開始,這個內核已經發展成爲一個最好的作業系統組件,
運行在袖珍數位音樂播放器、桌上型電腦、現存最大的超級計算機以及所有類型的系統上。
它是一種適用於幾乎任何情況的健壯、高效和可擴展的解決方案。
隨著Linux的發展,希望參與其開發的開發人員(和公司)的數量也在增加。硬體供應商
希望確保Linux能夠很好地支持他們的產品,使這些產品對Linux用戶具有吸引力。嵌入
式系統供應商使用Linux作爲集成產品的組件,希望Linux能夠儘可能地勝任手頭的任務。
分銷商和其他基於Linux的軟體供應商切實關心Linux內核的功能、性能和可靠性。最終
用戶也常常希望修改Linux,使之能更好地滿足他們的需求。
Linux最引人注目的特性之一是這些開發人員可以訪問它;任何具備必要技能的人都可以
改進Linux並影響其開發方向。專有產品不能提供這種開放性,這是自由軟體的一個特點。
如果有什麼不同的話,那就是內核比大多數其他自由軟體項目更開放。一個典型的三個
月內核開發周期可以涉及1000多個開發人員,他們爲100多個不同的公司(或者根本不
隸屬公司)工作。
與內核開發社區合作並不是特別困難。但儘管如此,仍有許多潛在的貢獻者在嘗試做
內核工作時遇到了困難。內核社區已經發展出自己獨特的操作方式,使其能夠在每天
都要更改數千行代碼的環境中順利運行(並生成高質量的產品)。因此,Linux內核開發
過程與專有的開發模式有很大的不同也就不足爲奇了。
對於新開發人員來說,內核的開發過程可能會讓人感到奇怪和恐懼,但這背後有充分的
理由和堅實的經驗。一個不了解內核社區工作方式的開發人員(或者更糟的是,他們
試圖拋棄或規避之)會得到令人沮喪的體驗。開發社區在幫助那些試圖學習的人的同時,
沒有時間幫助那些不願意傾聽或不關心開發過程的人。
希望閱讀本文的人能夠避免這種令人沮喪的經歷。這些材料很長,但閱讀它們時所做的
努力會在短時間內得到回報。開發社區總是需要能讓內核變更好的開發人員;下面的
文字應該幫助您或爲您工作的人員加入我們的社區。
致謝
----
本文檔由Jonathan Corbet <corbet@lwn.net> 撰寫。以下人員的建議使之更爲完善:
Johannes Berg, James Berry, Alex Chiang, Roland Dreier, Randy Dunlap,
Jake Edge, Jiri Kosina, Matt Mackall, Arthur Marsh, Amanda McPherson,
Andrew Morton, Andrew Price, Tsugikazu Shibata 和 Jochen Voß 。
這項工作得到了Linux基金會的支持,特別感謝Amanda McPherson,他看到了這項工作
的價值並將其變成現實。
代碼進入主線的重要性
--------------------
有些公司和開發人員偶爾會想,爲什麼他們要費心學習如何與內核社區合作,並將代碼
放入主線內核(「主線」是由Linus Torvalds維護的內核,Linux發行商將其用作基礎)。
在短期內,貢獻代碼看起來像是一種可以避免的開銷;維護獨立代碼並直接支持用戶
似乎更容易。事實上,保持代碼獨立(「樹外」)是在經濟上是錯誤的。
爲了說明樹外代碼成本,下面給出內核開發過程的一些相關方面;本文稍後將更詳細地
討論其中的大部分內容。請考慮:
- 所有Linux用戶都可以使用合併到主線內核中的代碼。它將自動出現在所有啓用它的
發行版上。無需驅動程序磁碟、額外下載,也不需要爲多個發行版的多個版本提供
支持;這一切將方便所有開發人員和用戶。併入主線解決了大量的分發和支持問題。
- 當內核開發人員努力維護一個穩定的用戶空間接口時,內核內部API處於不斷變化之中。
不維持穩定的內部接口是一個慎重的設計決策;它允許在任何時候進行基本的改進,
並產出更高質量的代碼。但該策略導致結果是,若要使用新的內核,任何樹外代碼都
需要持續的維護。維護樹外代碼會需要大量的工作才能使代碼保持正常運行。
相反,位於主線中的代碼不需要這樣做,因爲基本規則要求進行API更改的任何開發
人員也必須修復由於該更改而破壞的任何代碼。因此,合併到主線中的代碼大大降低
了維護成本。
- 除此之外,內核中的代碼通常會被其他開發人員改進。您授權的用戶社區和客戶對您
產品的改進可能會令人驚喜。
- 內核代碼在合併到主線之前和之後都要經過審查。無論原始開發人員的技能有多強,
這個審查過程總是能找到改進代碼的方法。審查經常發現嚴重的錯誤和安全問題。
對於在封閉環境中開發的代碼尤其如此;這種代碼從外部開發人員的審查中獲益匪淺。
樹外代碼是低質量代碼。
- 參與開發過程是您影響內核開發方向的方式。旁觀者的抱怨會被聽到,但是活躍的
開發人員有更強的聲音——並且能夠實現使內核更好地滿足其需求的更改。
- 當單獨維護代碼時,總是存在第三方爲類似功能提供不同實現的可能性。如果發生
這種情況,合併代碼將變得更加困難——甚至成爲不可能。之後,您將面臨以下令人
不快的選擇:(1)無限期地維護樹外的非標準特性,或(2)放棄代碼並將用戶遷移
到樹內版本。
- 代碼的貢獻是使整個流程工作的根本。通過貢獻代碼,您可以向內核添加新功能,並
提供其他內核開發人員使用的功能和示例。如果您已經爲Linux開發了代碼(或者正在
考慮這樣做),那麼您顯然對這個平台的持續成功感興趣;貢獻代碼是確保成功的
最好方法之一。
上述所有理由都適用於任何樹外內核代碼,包括以專有的、僅二進位形式分發的代碼。
然而,在考慮任何類型的純二進位內核代碼分布之前,還需要考慮其他因素。包括:
- 圍繞專有內核模塊分發的法律問題其實較爲模糊;相當多的內核版權所有者認爲,
大多數僅二進位的模塊是內核的派生產品,因此,它們的分發違反了GNU通用公共
許可證(下面將詳細介紹)。本文作者不是律師,本文檔中的任何內容都不可能被
視爲法律建議。封閉原始碼模塊的真實法律地位只能由法院決定。但不管怎樣,困擾
這些模塊的不確定性仍然存在。
- 二進位模塊大大增加了調試內核問題的難度,以至於大多數內核開發人員甚至都不會
嘗試。因此,只分發二進位模塊將使您的用戶更難從社區獲得支持。
- 對於僅二進位的模塊的發行者來說,支持也更加困難,他們必須爲他們希望支持的
每個發行版和每個內核版本提供不同版本的模塊。爲了提供較爲全面的覆蓋範圍,
可能需要一個模塊的幾十個構建,並且每次升級內核時,您的用戶都必須單獨升級
這些模塊。
- 上面提到的關於代碼評審的所有問題都更加存在於封閉原始碼中。由於該代碼根本
不可得,因此社區無法對其進行審查,毫無疑問,它將存在嚴重問題。
尤其是嵌入式系統的製造商,可能會傾向於忽視本節中所說的大部分內容;因爲他們
相信自己正在商用一種使用凍結內核版本的獨立產品,在發布後不需要再進行開發。
這個論點忽略了廣泛的代碼審查的價值以及允許用戶向產品添加功能的價值。但這些
產品的商業壽命有限,之後必須發布新版本的產品。在這一點上,代碼在主線上並得到
良好維護的供應商將能夠更好地占位,以使新產品快速上市。
許可
----
代碼是根據一些許可證提供給Linux內核的,但是所有代碼都必須與GNU通用公共許可
證(GPLV2)的版本2兼容,該版本是覆蓋整個內核分發的許可證。在實踐中,這意味
著所有代碼貢獻都由GPLv2(可選地,語言允許在更高版本的GPL下分發)或3子句BSD
許可(New BSD License,譯者注)覆蓋。任何不包含在兼容許可證中的貢獻都不會
被接受到內核中。
貢獻給內核的代碼不需要(或請求)版權分配。合併到主線內核中的所有代碼都保留
其原始所有權;因此,內核現在擁有數千個所有者。
這種所有權結構也暗示著,任何改變內核許可的嘗試都註定會失敗。很少有實際情況
可以獲得所有版權所有者的同意(或者從內核中刪除他們的代碼)。因此,尤其是在
可預見的將來,許可證不大可能遷移到GPL的版本3。
所有貢獻給內核的代碼都必須是合法的免費軟體。因此,不接受匿名(或化名)貢獻
者的代碼。所有貢獻者都需要在他們的代碼上「sign off(簽發)」,聲明代碼可以
在GPL下與內核一起分發。無法提供未被其所有者許可爲免費軟體的代碼,或可能爲
內核造成版權相關問題的代碼(例如,由缺乏適當保護的反向工程工作派生的代碼)
不能被接受。
有關版權問題的提問在Linux開發郵件列表中很常見。這樣的問題通常會得到不少答案,
但請記住,回答這些問題的人不是律師,不能提供法律諮詢。如果您有關於Linux原始碼
的法律問題,沒有什麼可以代替諮詢了解這一領域的律師。依賴從技術郵件列表中獲得
的答案是一件冒險的事情。
此差异已折叠。
.. SPDX-License-Identifier: GPL-2.0
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/3.Early-stage.rst <development_early_stage>`
:Translator:
時奎亮 Alex Shi <alex.shi@linux.alibaba.com>
:校譯:
吳想成 Wu XiangCheng <bobwxc@email.cn>
胡皓文 Hu Haowen <src.res@email.cn>
.. _tw_development_early_stage:
早期規劃
========
當考慮一個Linux內核開發項目時,很可能會直接跳進去開始編碼。然而,與任何重要
的項目一樣,許多成功的基礎最好是在第一行代碼編寫之前就打下。在早期計劃和
溝通中花費一些時間可以在之後節省更多的時間。
搞清問題
--------
與任何工程項目一樣,成功的內核改善從清晰描述要解決的問題開始。在某些情況
下,這個步驟很容易:例如當某個特定硬體需要驅動程序時。不過,在其他情況下,
很容易將實際問題與建議的解決方案混在一起,這可能會導致麻煩。
舉個例子:幾年前,Linux音頻的開發人員尋求一種方法來運行應用程式,而不會因
系統延遲過大而導致退出或其他問題。他們得到的解決方案是一個連接到Linux安全
模塊(LSM)框架中的內核模塊;這個模塊可以配置爲允許特定的應用程式訪問實時
調度程序。這個模塊被實現並發到linux-kernel郵件列表,在那裡它立即遇到了麻煩。
對於音頻開發人員來說,這個安全模塊足以解決他們當前的問題。但是,對於更廣泛的
內核社區來說,這被視爲對LSM框架的濫用(LSM框架並不打算授予他們原本不具備的
進程特權),並對系統穩定性造成風險。他們首選的解決方案包括短期的通過rlimit
機制進行實時調度訪問,以及長期的減少延遲的工作。
然而,音頻社區無法超越他們實施的特定解決方案來看問題;他們不願意接受替代方案。
由此產生的分歧使這些開發人員對整個內核開發過程感到失望;其中一個開發人員返回
到audio列表並發布了以下內容:
有很多非常好的Linux內核開發人員,但他們往往會被一羣傲慢的傻瓜所壓倒。
試圖向這些人傳達用戶需求是浪費時間。他們太「聰明」了,根本聽不到少數
人的話。
(http://lwn.net/articles/131776/)
實際情況卻是不同的;與特定模塊相比,內核開發人員更關心系統穩定性、長期維護
以及找到問題的正確解決方案。這個故事的寓意是把重點放在問題上——而不是具體的
解決方案上——並在開始編寫代碼之前與開發社區討論這個問題。
因此,在考慮一個內核開發項目時,我們應該得到一組簡短問題的答案:
- 需要解決的問題究竟是什麼?
- 受此問題影響的用戶有哪些?解決方案應該解決哪些使用案例?
- 內核現在爲何沒能解決這個問題?
只有這樣,才能開始考慮可能的解決方案。
早期討論
--------
在計劃內核開發項目時,在開始實施之前與社區進行討論是很有意義的。早期溝通可以
通過多種方式節省時間和麻煩:
- 很可能問題是由內核以您不理解的方式解決的。Linux內核很大,具有許多不明顯
的特性和功能。並不是所有的內核功能都像人們所希望的那樣有文檔記錄,而且很
容易遺漏一些東西。某作者發布了一個完整的驅動程序,重複了一個其不
知道的現有驅動程序。重新發明現有輪子的代碼不僅浪費,而且不會被接受到主線
內核中。
- 建議的解決方案中可能有一些要素不適合併入主線。在編寫代碼之前,最好先了解
這樣的問題。
- 其他開發人員完全有可能考慮過這個問題;他們可能有更好的解決方案的想法,並且
可能願意幫助創建這個解決方案。
在內核開發社區的多年經驗給了我們一個明確的教訓:閉門設計和開發的內核代碼總是
有一些問題,這些問題只有在代碼發布到社區中時才會被發現。有時這些問題很嚴重,
需要數月或數年的努力才能使代碼達到內核社區的標準。例如:
- 設計並實現了單處理器系統的DeviceScape網絡棧。只有使其適合於多處理器系統,
才能將其合併到主線中。在代碼中修改鎖等等是一項困難的任務;因此,這段代碼
(現在稱爲mac80211)的合併被推遲了一年多。
- Reiser4文件系統包含許多功能,核心內核開發人員認爲這些功能應該在虛擬文件
系統層中實現。它還包括一些特性,這些特性在不將系統暴露於用戶引起的死鎖的
情況下是不容易實現的。這些問題過遲發現——以及拒絕處理其中一些問題——已經
導致Reiser4置身主線內核之外。
- Apparmor安全模塊以被認爲不安全和不可靠的方式使用內部虛擬文件系統數據結構。
這種擔心(包括其他)使Apparmor多年來無法進入主線。
在這些情況下,與內核開發人員的早期討論,可以避免大量的痛苦和額外的工作。
找誰交流?
----------
當開發人員決定公開他們的計劃時,下一個問題是:我們從哪裡開始?答案是找到正確
的郵件列表和正確的維護者。對於郵件列表,最好的方法是在維護者(MAINTAINERS)文件
中查找要發布的相關位置。如果有一個合適的子系統列表,那麼其上發布通常比在
linux-kernel上發布更可取;您更有可能接觸到在相關子系統中具有專業知識的開發
人員,並且環境可能具支持性。
找到維護人員可能會有點困難。同樣,維護者文件是開始的地方。但是,該文件往往不
是最新的,並且並非所有子系統都在那裡顯示。實際上,維護者文件中列出的人員可能
不是當前實際擔任該角色的人員。因此,當對聯繫誰有疑問時,一個有用的技巧是使用
git(尤其是「git-log」)查看感興趣的子系統中當前活動的用戶。看看誰在寫補丁、
誰會在這些補丁上加上Signed-off-by行簽名(如有)。這些人將是幫助新開發項目的
最佳人選。
找到合適的維護者有時是非常具有挑戰性的,以至於內核開發人員添加了一個腳本來
簡化這個過程:
::
.../scripts/get_maintainer.pl
當給定「-f」選項時,此腳本將返回指定文件或目錄的當前維護者。如果在命令行上
給出了一個補丁,它將列出可能接收補丁副本的維護人員。有許多選項可以調節
get_maintainer.pl搜索維護者的嚴格程度;請小心使用更激進的選項,因爲最終結果
可能會包括對您正在修改的代碼沒有真正興趣的開發人員。
如果所有其他方法都失敗了,那麼與Andrew Morton交流是跟蹤特定代碼段維護人員
的一種有效方法。
何時郵寄?
----------
如果可能的話,在早期階段發布你的計劃只會更有幫助。描述正在解決的問題以及已經
制定的關於如何實施的任何計劃。您可以提供的任何信息都可以幫助開發社區爲項目
提供有用的輸入。
在這個階段可能發生的一件令人沮喪的事情不是得到反對意見,而是很少或根本沒有
反饋。令人傷心的事實是:(1)內核開發人員往往很忙;(2)不缺少有宏偉計劃但
代碼(甚至代碼設想)很少的人去支持他們;(3)沒有人有義務審查或評論別人發表
的想法。除此之外,高層級的設計常常隱藏著一些問題,這些問題只有在有人真正嘗試
實現這些設計時才會被發現;因此,內核開發人員寧願看到代碼。
如果發布請求評論(RFC)並沒得到什麼有用的評論,不要以爲這意味著無人對此項目
有興趣,同時你也不能假設你的想法沒有問題。在這種情況下,最好的做法是繼續進
行,把你的進展隨時通知社區。
獲得官方認可
-----------------------
如果您的工作是在公司環境中完成的,就像大多數Linux內核工作一樣;顯然,在您將
公司的計劃或代碼發布到公共郵件列表之前,必須獲得有適當權利經理的許可。發布
不確定是否兼容GPL的代碼尤其會帶來問題;公司的管理層和法律人員越早能夠就發布
內核開發項目達成一致,對參與的每個人都越好。
一些讀者可能會認爲他們的核心工作是爲了支持還沒有正式承認存在的產品。將僱主
的計劃公布在公共郵件列表上可能不是一個可行的選擇。在這種情況下,有必要考慮
保密是否真的是必要的;通常不需要把開發計劃關在門內。
的確,有些情況下一家公司在開發過程的早期無法合法地披露其計劃。擁有經驗豐富
的內核開發人員的公司可能選擇以開環的方式進行開發,前提是他們以後能夠避免
嚴重的集成問題。對於沒有這種內部專業知識的公司,最好的選擇往往是聘請外部
開發者根據保密協議審查計劃。Linux基金會運行了一個NDA程序,旨在幫助解決這種
情況;更多信息參見:
http://www.linuxfoundation.org/nda/
這種審查通常足以避免以後出現嚴重問題,而無需公開披露項目。
.. SPDX-License-Identifier: GPL-2.0
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/4.Coding.rst <development_coding>`
:Translator:
時奎亮 Alex Shi <alex.shi@linux.alibaba.com>
:校譯:
吳想成 Wu XiangCheng <bobwxc@email.cn>
胡皓文 Hu Haowen <src.res@email.cn>
.. _tw_development_coding:
使代碼正確
======================
雖然一個堅實的、面向社區的設計過程有很多值得說道的,但是任何內核開發項目工作
的證明都反映在代碼中。它是將由其他開發人員檢查併合並(或不合併)到主線樹中
的代碼。所以這段代碼的質量決定了項目的最終成功。
本節將檢查編碼過程。我們將從內核開發人員常犯的幾種錯誤開始。然後重點將轉移
到正確的做法和相關有用的工具上。
陷阱
----
代碼風格
********
內核長期以來都有其標準的代碼風格,如
:ref:`Documentation/translations/zh_TW/process/coding-style.rst <tw_codingstyle>`
中所述。在多數時候,該文檔中描述的準則至多被認爲是建議性的。因此,內核中存在
大量不符合代碼風格準則的代碼。這種代碼的存在會給內核開發人員帶來兩方面的危害。
首先,相信內核代碼標準並不重要,也不強制執行。但事實上,如果沒有按照標準
編寫代碼,那麼新代碼將很難加入到內核中;許多開發人員甚至會在審查代碼之前要求
對代碼進行重新格式化。一個像內核這麼大的代碼庫需要一些統一格式的代碼,以使
開發人員能夠快速理解其中的任何部分。所以再也經不起奇怪格式的代碼的折騰了。
內核的代碼風格偶爾會與僱主的強制風格發生衝突。在這種情況下,必須在代碼合併
之前遵從內核代碼風格。將代碼放入內核意味著以多種方式放棄一定程度的控制權——
包括控制代碼樣式。
另一個危害是認爲已經在內核中的代碼迫切需要修復代碼樣式。開發者可能會開始編寫
重新格式化補丁,作爲熟悉開發過程的一種方式,或者作爲將其名字寫入內核變更日誌
的一種方式,或者兩者兼而有之。但是純代碼風格的修復被開發社區視爲噪音,它們往
往受到冷遇。因此,最好避免編寫這種類型的補丁。在由於其他原因處理一段代碼的
同時順帶修復其樣式是很自然的,但是不應該僅爲了更改代碼樣式而更改之。
代碼風格文檔也不應該被視爲絕對不可違反的規則。如果有一個足夠的理由反對這種
樣式(例如爲了80列限制拆分行會導致可讀性大大降低),那麼就這樣做吧。
注意您還可以使用 ``clang-format`` 工具來幫助您處理這些規則,快速自動重新格式
化部分代碼,和審閱完整的文件以發現代碼樣式錯誤、拼寫錯誤和可能的改進。它還
可以方便地排序 ``#includes`` 、對齊變量/宏、重排文本和其他類似任務。有關詳細
信息,請參閱文檔 :ref:`Documentation/process/clang-format.rst <clangformat>`
抽象層
******
計算機科學教授教學生以靈活性和信息隱藏的名義廣泛使用抽象層。當然,內核廣泛
地使用了抽象;任何涉及數百萬行代碼的項目都必須做到這一點以存續下來。但經驗
表明,過度或過早的抽象可能和過早的優化一樣有害。抽象應用在適當層級,
不要過度。
簡單點,先考慮一個調用時始終只有一個參數且總爲零的函數。我們可以保留這個參數,
以在需要使用它時提供的額外靈活性。不過,在那時實現了這個額外參數的代碼很有
可能以某種從未被注意到的微妙方式被破壞——因爲它從未被使用過。或者當需要額外
的靈活性時,它並未以符合程式設計師當初期望的方式來實現。內核開發人員通常會提交
補丁來刪除未使用的參數;一般來說,一開始就不應該添加這些參數。
隱藏硬體訪問的抽象層——通常爲了允許大量的驅動程序兼容多個作業系統——尤其不受
歡迎。這樣的層使代碼變得模糊,可能會造成性能損失;它們不屬於Linux內核。
另一方面,如果您發現自己從另一個內核子系統複製了大量的代碼,那麼是時候
了解一下:是否需要將這些代碼中的部分提取到單獨的庫中,或者在更高的層次上
實現這些功能。在整個內核中複製相同的代碼沒有價值。
#ifdef 和預處理
***************
C預處理器似乎給一些C程式設計師帶來了強大的誘惑,他們認爲它是一種將大量靈活性加入
原始碼中的方法。但是預處理器不是C,大量使用它會導致代碼對其他人來說更難閱讀,
對編譯器來說更難檢查正確性。使用了大量預處理器幾乎總是代碼需要一些
清理工作的標誌。
使用#ifdef的條件編譯實際上是一個強大的功能,它在內核中使用。但是很少有人希望
看到代碼被鋪滿#ifdef塊。一般規定,ifdef的使用應儘可能限制在頭文件中。條件
編譯代碼可以限制函數,如果代碼不存在,這些函數就直接變成空的。然後編譯器將
悄悄地優化對空函數的調用。使得代碼更加清晰,更容易理解。
C預處理器宏存在許多危險性,包括可能對具有副作用且沒有類型安全的表達式進行多
重評估。如果您試圖定義宏,請考慮創建一個內聯函數替代。結果相同的代碼,內聯
函數更容易閱讀,不會多次計算其參數,並且允許編譯器對參數和返回值執行類型檢查。
內聯函數
********
不過,內聯函數本身也存在風險。程式設計師可以傾心於避免函數調用和用內聯函數填充源
文件所固有的效率。然而,這些功能實際上會降低性能。因爲它們的代碼在每個調用站
點都被複製一遍,所以最終會增加編譯內核的大小。此外,這也對處理器的內存緩存
造成壓力,從而大大降低執行速度。通常內聯函數應該非常小,而且相對較少。畢竟
函數調用的成本並不高;大量創建內聯函數是過早優化的典型例子。
一般來說,內核程式設計師會自冒風險忽略緩存效果。在數據結構課程開頭中的經典
時間/空間權衡通常不適用於當代硬體。空間 *就是* 時間,因爲一個大的程序比一個
更緊湊的程序運行得慢。
較新的編譯器越來越激進地決定一個給定函數是否應該內聯。因此,隨意放置使用
「inline」關鍵字可能不僅僅是過度的,也可能是無用的。
**
2006年5月,「deviceescape」網絡堆棧在前呼後擁下以GPL發布,並被納入主線內核。
這是一個受歡迎的消息;Linux中對無線網絡的支持充其量被認爲是不合格的,而
Deviceescape堆棧承諾修復這種情況。然而直到2007年6月(2.6.22),這段代碼才真
正進入主線。發生了什麼?
這段代碼出現了許多閉門造車的跡象。但一個大麻煩是,它並不是爲多處理器系統而
設計。在合併這個網絡堆棧(現在稱爲mac80211)之前,需要對其進行一個鎖方案的
改造。
曾經,Linux內核代碼可以在不考慮多處理器系統所帶來的並發性問題的情況下進行
開發。然而現在,這個文檔就是在雙核筆記本電腦上寫的。即使在單處理器系統上,
爲提高響應能力所做的工作也會提高內核內的並發性水平。編寫內核代碼而不考慮鎖
的日子早已遠去。
可以由多個線程並發訪問的任何資源(數據結構、硬體寄存器等)必須由鎖保護。新
的代碼應該謹記這一要求;事後修改鎖是一項相當困難的任務。內核開發人員應該花
時間充分了解可用的鎖原語,以便爲工作選擇正確的工具。對並發性缺乏關注的代碼
很難進入主線。
回歸
****
最後一個值得一提的危險是回歸:它可能會引起導致現有用戶的某些東西中斷的改變
(這也可能會帶來很大的改進)。這種變化被稱爲「回歸」,回歸已經成爲主線內核
最不受歡迎的問題。除了少數例外情況,如果回歸不能及時修正,會導致回歸的修改
將被取消。最好首先避免回歸發生。
人們常常爭論,如果回歸帶來的功能遠超過產生的問題,那麼回歸是否爲可接受的。
如果它破壞了一個系統卻爲十個系統帶來新的功能,爲何不改改態度呢?2007年7月,
Linus對這個問題給出了最佳答案:
::
所以我們不會通過引入新問題來修復錯誤。這種方式是靠不住的,沒人知道
是否真的有進展。是前進兩步、後退一步,還是前進一步、後退兩步?
(http://lwn.net/articles/243460/)
特別不受歡迎的一種回歸類型是用戶空間ABI的任何變化。一旦接口被導出到用戶空間,
就必須無限期地支持它。這一事實使得用戶空間接口的創建特別具有挑戰性:因爲它們
不能以不兼容的方式進行更改,所以必須一次就對。因此,用戶空間接口總是需要大量
的思考、清晰的文檔和廣泛的審查。
代碼檢查工具
------------
至少目前,編寫無錯誤代碼仍然是我們中很少人能達到的理想狀態。不過,我們希望做
的是,在代碼進入主線內核之前,儘可能多地捕獲並修復這些錯誤。爲此,內核開發人
員已經提供了一系列令人印象深刻的工具,可以自動捕獲各種各樣的隱藏問題。計算機
發現的任何問題都是一個以後不會困擾用戶的問題,因此,只要有可能,就應該使用
自動化工具。
第一步是注意編譯器產生的警告。當前版本的GCC可以檢測(並警告)大量潛在錯誤。
通常,這些警告都指向真正的問題。提交以供審閱的代碼一般不會產生任何編譯器警告。
在消除警告時,注意了解真正的原因,並儘量避免僅「修復」使警告消失而不解決其原因。
請注意,並非所有編譯器警告都默認啓用。使用「make KCFLAGS=-W」構建內核以
獲得完整集合。
內核提供了幾個配置選項,可以打開調試功能;大多數配置選項位於「kernel hacking」
子菜單中。對於任何用於開發或測試目的的內核,都應該啓用其中幾個選項。特別是,
您應該打開:
- FRAME_WARN 獲取大於給定數量的堆棧幀的警告。
這些警告生成的輸出可能比較冗長,但您不必擔心來自內核其他部分的警告。
- DEBUG_OBJECTS 將添加代碼以跟蹤內核創建的各種對象的生命周期,並在出現問題
時發出警告。如果你要添加創建(和導出)關於其自己的複雜對象的子系統,請
考慮打開對象調試基礎結構的支持。
- DEBUG_SLAB 可以發現各種內存分配和使用錯誤;它應該用於大多數開發內核。
- DEBUG_SPINLOCK, DEBUG_ATOMIC_SLEEP 和 DEBUG_MUTEXES 會發現許多常見的
鎖錯誤。
還有很多其他調試選項,其中一些將在下面討論。其中一些有顯著的性能影響,不應
一直使用。在學習可用選項上花費一些時間,可能會在短期內得到許多回報。
其中一個較重的調試工具是鎖檢查器或「lockdep」。該工具將跟蹤系統中每個鎖
(spinlock或mutex)的獲取和釋放、獲取鎖的相對順序、當前中斷環境等等。然後,
它可以確保總是以相同的順序獲取鎖,相同的中斷假設適用於所有情況等等。換句話
說,lockdep可以找到許多導致系統死鎖的場景。在部署的系統中,這種問題可能會
很痛苦(對於開發人員和用戶而言);LockDep允許提前以自動方式發現問題。具有
任何類型的非普通鎖的代碼在提交合併前應在啓用lockdep的情況下運行測試。
作爲一個勤奮的內核程式設計師,毫無疑問,您將檢查任何可能失敗的操作(如內存分配)
的返回狀態。然而,事實上,最終的故障復現路徑可能完全沒有經過測試。未測試的
代碼往往會出問題;如果所有這些錯誤處理路徑都被執行了幾次,那麼您可能對代碼
更有信心。
內核提供了一個可以做到這一點的錯誤注入框架,特別是在涉及內存分配的情況下。
啓用故障注入後,內存分配的可配置失敗的百分比;這些失敗可以限定在特定的代碼
範圍內。在啓用了故障注入的情況下運行,程式設計師可以看到當情況惡化時代碼如何響
應。有關如何使用此工具的詳細信息,請參閱
Documentation/fault-injection/fault-injection.rst。
「sparse」靜態分析工具可以發現其他類型的錯誤。sparse可以警告程式設計師用戶空間
和內核空間地址之間的混淆、大端序與小端序的混淆、在需要一組位標誌的地方傳遞
整數值等等。sparse必須單獨安裝(如果您的分發伺服器沒有將其打包,
可以在 https://sparse.wiki.kernel.org/index.php/Main_page 找到),
然後可以通過在make命令中添加「C=1」在代碼上運行它。
「Coccinelle」工具 :ref:`http://coccinelle.lip6.fr/ <devtools_coccinelle>`
能夠發現各種潛在的編碼問題;它還可以爲這些問題提出修複方案。在
scripts/coccinelle目錄下已經打包了相當多的內核「語義補丁」;運行
「make coccicheck」將運行這些語義補丁並報告發現的任何問題。有關詳細信息,請參閱
:ref:`Documentation/dev-tools/coccinelle.rst <devtools_coccinelle>`
其他類型的可移植性錯誤最好通過爲其他體系結構編譯代碼來發現。如果沒有S/390系統
或Blackfin開發板,您仍然可以執行編譯步驟。可以在以下位置找到一大堆用於x86系統的
交叉編譯器:
https://www.kernel.org/pub/tools/crosstool/
花一些時間安裝和使用這些編譯器將有助於避免以後的尷尬。
文檔
----
文檔通常比內核開發規則更爲例外。即便如此,足夠的文檔將有助於簡化將新代碼合併
到內核中的過程,使其他開發人員的生活更輕鬆,並對您的用戶有所幫助。在許多情況
下,添加文檔已基本上是強制性的。
任何補丁的第一個文檔是其關聯的變更日誌。日誌條目應該描述正在解決的問題、解決
方案的形式、處理補丁的人員、對性能的任何相關影響,以及理解補丁可能需要的任何
其他內容。確保變更日誌說明了*爲什麼*補丁值得應用;大量開發者未能提供這些信息。
任何添加新用戶空間接口的代碼——包括新的sysfs或/proc文件——都應該包含該接口
的文檔,該文檔使用戶空間開發人員能夠知道他們在使用什麼。請參閱
Documentation/ABI/README,了解如何此文檔格式以及需要提供哪些信息。
文檔 :ref:`Documentation/admin-guide/kernel-parameters.rst <kernelparameters>`
描述了內核的所有引導時間參數。任何添加新參數的補丁都應該向該文檔添加適當的
條目。
任何新的配置選項都必須附有幫助文本,幫助文本需清楚地解釋這些選項以及用戶可能
希望何時使用它們。
許多子系統的內部API信息通過專門格式化的注釋進行記錄;這些注釋可以通過
「kernel-doc」腳本以多種方式提取和格式化。如果您在具有kerneldoc注釋的子系統中
工作,則應該維護它們,並根據需要爲外部可用的功能添加它們。即使在沒有如此記錄
的領域中,爲將來添加kerneldoc注釋也沒有壞處;實際上,這對於剛開始開發內核的人
來說是一個有用的活動。這些注釋的格式以及如何創建kerneldoc模板的一些信息可以在
:ref:`Documentation/doc-guide/ <doc_guide>` 上找到。
任何閱讀大量現有內核代碼的人都會注意到,注釋的缺失往往是最值得注意的。同時,
對新代碼的要求比過去更高;合併未注釋的代碼將更加困難。這就是說,人們並不期望
詳細注釋的代碼。代碼本身應該是自解釋的,注釋闡釋了更微妙的方面。
某些事情應該總是被注釋。使用內存屏障時,應附上一行文字,解釋爲什麼需要設置內存
屏障。數據結構的鎖規則通常需要在某個地方解釋。一般來說,主要數據結構需要全面
的文檔。應該指出代碼中分立的位之間不明顯的依賴性。任何可能誘使代碼管理人進行
錯誤的「清理」的事情都需要一個注釋來說明爲什麼要這樣做。等等。
內部API更改
-----------
內核提供給用戶空間的二進位接口不能被破壞,除非逼不得已。而內核的內部編程接口
是高度流動的,當需要時可以更改。如果你發現自己不得不處理一個內核API,或者僅
僅因爲它不滿足你的需求導致無法使用特定的功能,這可能是API需要改變的一個標誌。
作爲內核開發人員,您有權進行此類更改。
的確可以進行API更改,但更改必須是合理的。因此任何進行內部API更改的補丁都應該
附帶關於更改內容和必要原因的描述。這種變化也應該拆分成一個單獨的補丁,而不是
埋在一個更大的補丁中。
另一個要點是,更改內部API的開發人員通常要負責修復內核樹中被更改破壞的任何代碼。
對於一個廣泛使用的函數,這個責任可以導致成百上千的變化,其中許多變化可能與其他
開發人員正在做的工作相衝突。不用說,這可能是一項大工程,所以最好確保理由是
可靠的。請注意,coccinelle工具可以幫助進行廣泛的API更改。
在進行不兼容的API更改時,應儘可能確保編譯器捕獲未更新的代碼。這將幫助您確保找
到該接口的樹內用處。它還將警告開發人員樹外代碼存在他們需要響應的更改。支持樹外
代碼不是內核開發人員需要擔心的事情,但是我們也不必使樹外開發人員的生活有不必要
的困難。
.. SPDX-License-Identifier: GPL-2.0
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/5.Posting.rst <development_posting>`
:Translator:
時奎亮 Alex Shi <alex.shi@linux.alibaba.com>
:校譯:
吳想成 Wu XiangCheng <bobwxc@email.cn>
胡皓文 Hu Haowen <src.res@email.cn>
.. _tw_development_posting:
發布補丁
========
您的工作遲早會準備好提交給社區進行審查,並最終包含到主線內核中。毫不稀奇,
內核開發社區已經發展出一套用於發布補丁的約定和過程;遵循這些約定和過程將使
參與其中的每個人的生活更加輕鬆。本文檔試圖描述這些約定的部分細節;更多信息
也可在以下文檔中找到
:ref:`Documentation/translations/zh_TW/process/submitting-patches.rst <tw_submittingpatches>`,
:ref:`Documentation/translations/zh_TW/process/submitting-drivers.rst <tw_submittingdrivers>`
和 :ref:`Documentation/translations/zh_TW/process/submit-checklist.rst <tw_submitchecklist>`。
何時郵寄
--------
在補丁完全「準備好」之前,避免發布補丁是一種持續的誘惑。對於簡單的補丁,這
不是問題。但是如果正在完成的工作很複雜,那麼在工作完成之前從社區獲得反饋就
可以獲得很多好處。因此,您應該考慮發布正在進行的工作,甚至維護一個可用的Git
樹,以便感興趣的開發人員可以隨時趕上您的工作。
當發布中有尚未準備好被包含的代碼,最好在發布中說明。還應提及任何有待完成的
主要工作和任何已知問題。很少有人會願意看那些被認爲是半生不熟的補丁,但是
那些願意的人會帶著他們的點子來一起幫助你把工作推向正確的方向。
創建補丁之前
------------
在考慮將補丁發送到開發社區之前,有許多事情應該做。包括:
- 儘可能地測試代碼。利用內核的調試工具,確保內核使用了所有可能的配置選項組合
進行構建,使用交叉編譯器爲不同的體系結構進行構建等。
- 確保您的代碼符合內核代碼風格指南。
- 您的更改是否具有性能影響?如果是這樣,您應該運行基準測試來顯示您的變更的
影響(或好處);結果的摘要應該包含在補丁中。
- 確保您有權發布代碼。如果這項工作是爲僱主完成的,僱主對這項工作具有所有權,
並且必須同意根據GPL對其進行發布。
一般來說,在發布代碼之前進行一些額外的思考,幾乎總是能在短時間內得到回報。
補丁準備
--------
準備補丁發布的工作量可能很驚人,但在此嘗試節省時間通常是不明智的,即使在短期
內亦然。
必須針對內核的特定版本準備補丁。一般來說,補丁應該基於Linus的Git樹中的當前
主線。當以主線爲基礎時,請從一個衆所周知的發布點開始——如穩定版本或 -rc
版本發布點——而不是在一個任意的主線分支點。
也可能需要針對-mm、linux-next或子系統樹生成版本,以便於更廣泛的測試和審查。
根據補丁的區域以及其他地方的情況,針對其他樹建立的補丁可能需要大量的工作來
解決衝突和處理API更改。
只有最簡單的更改才應格式化爲單個補丁;其他所有更改都應作爲一系列邏輯更改進行。
分割補丁是一門藝術;一些開發人員花了很長時間來弄清楚如何按照社區期望的方式來
分割。不過,這些經驗法則也許有幫助:
- 您發布的補丁系列幾乎肯定不會是開發過程中版本控制系統中的一系列更改。相反,
需要對您所做更改的最終形式加以考慮,然後以有意義的方式進行拆分。開發人員對
離散的、自包含的更改感興趣,而不是您創造這些更改的原始路徑。
- 每個邏輯上獨立的變更都應該格式化爲單獨的補丁。這些更改可以是小的(如「向
此結構體添加欄位」)或大的(如添加一個重要的新驅動程序),但它們在概念上
應該是小的,並且可以在一行內簡述。每個補丁都應該做一個特定的、可以單獨
檢查並驗證它所做的事情的更改。
- 換種方式重申上述準則,也就是說:不要在同一補丁中混合不同類型的更改。如果
一個補丁修復了一個關鍵的安全漏洞,又重新排列了一些結構,還重新格式化了代
碼,那麼它很有可能會被忽略,從而導致重要的修復丟失。
- 每個補丁都應該能創建一個可以正確地構建和運行的內核;如果補丁系列在中間被
斷開,那麼結果仍應是一個正常工作的內核。部分應用一系列補丁是使用
「git bisct」工具查找回歸的一個常見場景;如果結果是一個損壞的內核,那麼將使
那些從事追蹤問題的高尚工作的開發人員和用戶的生活更加艱難。
- 不要過分分割。一位開發人員曾經將一組針對單個文件的編輯分成500個單獨的補丁
發布,這並沒有使他成爲內核郵件列表中最受歡迎的人。一個補丁可以相當大,
只要它仍然包含一個單一的 *邏輯* 變更。
- 用一系列補丁添加一個全新的基礎設施,但是該設施在系列中的最後一個補丁啓用
整個變更之前不能使用,這看起來很誘人。如果可能的話,應該避免這種誘惑;
如果這個系列增加了回歸,那麼二分法將指出最後一個補丁是導致問題的補丁,
即使真正的bug在其他地方。只要有可能,添加新代碼的補丁程序應該立即激活該
代碼。
創建完美補丁系列的工作可能是一個令人沮喪的過程,在完成「真正的工作」之後需要
花費大量的時間和思考。但是如果做得好,花費的時間就是值得的。
補丁格式和更改日誌
------------------
所以現在你有了一系列完美的補丁可以發布,但是這項工作還沒有完成。每個補丁都
需要被格式化成一條消息,以快速而清晰地將其目的傳達到世界其他地方。爲此,
每個補丁將由以下部分組成:
- 可選的「From」行,表明補丁作者。只有當你通過電子郵件發送別人的補丁時,這一行
才是必須的,但是爲防止疑問加上它也不會有什麼壞處。
- 一行描述,說明補丁的作用。對於在沒有其他上下文的情況下看到該消息的讀者來說,
該消息應足以確定修補程序的範圍;此行將顯示在「short form(簡短格式)」變更
日誌中。此消息通常需要先加上子系統名稱前綴,然後是補丁的目的。例如:
::
gpio: fix build on CONFIG_GPIO_SYSFS=n
- 一行空白,後接補丁內容的詳細描述。此描述可以是任意需要的長度;它應該說明補丁
的作用以及爲什麼它應該應用於內核。
- 一個或多個標記行,至少有一個由補丁作者的 Signed-off-by 簽名。標記將在下面
詳細描述。
上面的項目一起構成補丁的變更日誌。寫一則好的變更日誌是一門至關重要但常常被
忽視的藝術;值得花一點時間來討論這個問題。當你編寫變更日誌時,你應該記住有
很多不同的人會讀你的話。其中包括子系統維護人員和審查人員,他們需要決定是否
應該合併補丁,分銷商和其他維護人員試圖決定是否應該將補丁反向移植到其他內核,
缺陷搜尋人員想知道補丁是否導致他們正在追查的問題,以及想知道內核如何變化的
用戶等等。一個好的變更日誌以最直接和最簡潔的方式向所有這些人傳達所需的信息。
在結尾,總結行應該描述變更的影響和動機,以及在一行約束條件下可能發生的變化。
然後,詳細的描述可以詳述這些主題,並提供任何需要的附加信息。如果補丁修復了
一個缺陷,請引用引入該缺陷的提交(如果可能,請在引用提交時同時提供其 id 和
標題)。如果某個問題與特定的日誌或編譯器輸出相關聯,請包含該輸出以幫助其他
人搜索同一問題的解決方案。如果更改是爲了支持以後補丁中的其他更改,那麼應當
說明。如果更改了內部API,請詳細說明這些更改以及其他開發人員應該如何響應。
一般來說,你越把自己放在每個閱讀你變更日誌的人的位置上,變更日誌(和內核
作爲一個整體)就越好。
不消說,變更日誌是將變更提交到版本控制系統時使用的文本。接下來將是:
- 補丁本身,採用統一的(「-u」)補丁格式。使用「-p」選項來diff將使函數名與
更改相關聯,從而使結果補丁更容易被其他人讀取。
您應該避免在補丁中包括與更改不相關文件(例如,構建過程生成的文件或編輯器
備份文件)。文檔目錄中的「dontdiff」文件在這方面有幫助;使用「-X」選項將
其傳遞給diff。
上面提到的標籤(tag)用於描述各種開發人員如何與這個補丁的開發相關聯。
:ref:`Documentation/translations/zh_TW/process/submitting-patches.rst <tw_submittingpatches>`
文檔中對它們進行了詳細描述;下面是一個簡短的總結。每一行的格式如下:
::
tag: Full Name <email address> optional-other-stuff
常用的標籤有:
- Signed-off-by: 這是一個開發人員的證明,證明他或她有權提交補丁以包含到內核
中。這表明同意開發者來源認證協議,其全文見
:ref:`Documentation/translations/zh_TW/process/submitting-patches.rst <tw_submittingpatches>`
如果沒有合適的簽字,則不能合併到主線中。
- Co-developed-by: 聲明補丁是由多個開發人員共同創建的;當幾個人在一個補丁上
工作時,它用於給出共同作者(除了 From: 所給出的作者之外)。由於
Co-developed-by: 表示作者身份,所以每個共同開發人,必須緊跟在相關合作作者
的Signed-off-by之後。具體內容和示例見以下文件
:ref:`Documentation/translations/zh_TW/process/submitting-patches.rst <tw_submittingpatches>`
- Acked-by: 表示另一個開發人員(通常是相關代碼的維護人員)同意補丁適合包含
在內核中。
- Tested-by: 聲明某人已經測試了補丁並確認它可以工作。
- Reviewed-by: 表示某開發人員已經審查了補丁的正確性;有關詳細信息,請參閱
:ref:`Documentation/translations/zh_TW/process/submitting-patches.rst <tw_submittingpatches>`
- Reported-by: 指定報告此補丁修復的問題的用戶;此標記用於表示感謝。
- Cc:指定某人收到了補丁的副本,並有機會對此發表評論。
在補丁中添加標籤時要小心:只有Cc:才適合在沒有指定人員明確許可的情況下添加。
發送補丁
--------
在寄出補丁之前,您還需要注意以下幾點:
- 您確定您的郵件發送程序不會損壞補丁嗎?被郵件客戶端更改空白或修飾了行的補丁
無法被另一端接受,並且通常不會進行任何詳細檢查。如果有任何疑問,先把補丁寄
給你自己,讓你自己確定它是完好無損的。
:ref:`Documentation/translations/zh_TW/process/email-clients.rst <tw_email_clients>`
提供了一些有用的提示,可以讓特定的郵件客戶端正常發送補丁。
- 你確定你的補丁沒有荒唐的錯誤嗎?您應該始終通過scripts/checkpatch.pl檢查
補丁程序,並解決它提出的問題。請記住,checkpatch.pl,雖然體現了對內核補丁
應該是什麼樣的大量思考,但它並不比您聰明。如果修復checkpatch.pl給的問題會
使代碼變得更糟,請不要這樣做。
補丁應始終以純文本形式發送。請不要將它們作爲附件發送;這使得審閱者在答覆中更難
引用補丁的部分。相反,只需將補丁直接放到您的消息中。
寄出補丁時,重要的是將副本發送給任何可能感興趣的人。與其他一些項目不同,內核
鼓勵人們甚至錯誤地發送過多的副本;不要假定相關人員會看到您在郵件列表中的發布。
尤其是,副本應發送至:
- 受影響子系統的維護人員。如前所述,維護人員文件是查找這些人員的首選地方。
- 其他在同一領域工作的開發人員,尤其是那些現在可能在那裡工作的開發人員。使用
git查看還有誰修改了您正在處理的文件,這很有幫助。
- 如果您對某錯誤報告或功能請求做出響應,也可以抄送原始發送人。
- 將副本發送到相關郵件列表,或者若無相關列表,則發送到linux-kernel列表。
- 如果您正在修復一個缺陷,請考慮該修復是否應進入下一個穩定更新。如果是這樣,
補丁副本也應發到stable@vger.kernel.org 。另外,在補丁本身的標籤中添加一個
「Cc: stable@vger.kernel.org」;這將使穩定版團隊在修復進入主線時收到通知。
當爲一個補丁選擇接收者時,最好清楚你認爲誰最終會接受這個補丁並將其合併。雖然
可以將補丁直接發給Linus Torvalds並讓他合併,但通常情況下不會這樣做。Linus很
忙,並且有子系統維護人員負責監視內核的特定部分。通常您會希望維護人員合併您的
補丁。如果沒有明顯的維護人員,Andrew Morton通常是最後的補丁接收者。
補丁需要好的主題行。補丁主題行的規範格式如下:
::
[PATCH nn/mm] subsys: one-line description of the patch
其中「nn」是補丁的序號,「mm」是系列中補丁的總數,「subsys」是受影響子系統的
名稱。當然,一個單獨的補丁可以省略nn/mm。
如果您有一系列重要的補丁,那麼通常發送一個簡介作爲第〇部分。不過,這個約定
並沒有得到普遍遵循;如果您使用它,請記住簡介中的信息不會進入內核變更日誌。
因此,請確保補丁本身具有完整的變更日誌信息。
一般來說,多部分補丁的第二部分和後續部分應作爲對第一部分的回覆發送,以便它們
在接收端都連接在一起。像git和coilt這樣的工具有命令,可以通過適當的線程發送
一組補丁。但是,如果您有一長串補丁,並正使用git,請不要使用–-chain-reply-to
選項,以避免創建過深的嵌套。
.. SPDX-License-Identifier: GPL-2.0
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/6.Followthrough.rst <development_followthrough>`
:Translator:
時奎亮 Alex Shi <alex.shi@linux.alibaba.com>
:校譯:
吳想成 Wu XiangCheng <bobwxc@email.cn>
胡皓文 Hu Haowen <src.res@email.cn>
.. _tw_development_followthrough:
跟進
====
此時,您已經遵循了到目前爲止給出的指導方針,並且,隨著您自己的工程技能的增加,
已經發布了一系列完美的補丁。即使是經驗豐富的內核開發人員也能犯的最大錯誤之一
是,認爲他們的工作現在已經完成了。事實上,發布補丁意味著進入流程的下一個階段,
可能還需要做很多工作。
一個補丁在首次發布時就非常出色、沒有改進的餘地,這是很罕見的。內核開發流程已
認識到這一事實,因此它非常注重對已發布代碼的改進。作爲代碼的作者,您應該與
內核社區合作,以確保您的代碼符合內核的質量標準。如果不參與這個過程,很可能會
無法將補丁合併到主線中。
與審閱者合作
------------
任何意義上的補丁都會導致其他開發人員在審查代碼時發表大量評論。對於許多開發
人員來說,與審閱人員合作可能是內核開發過程中最令人生畏的部分。但是如果你
記住一些事情,生活會變得容易得多:
- 如果你已經很好地解釋了你的補丁,審閱人員會理解它的價值,以及爲什麼你會
費盡心思去寫它。但是這個並不能阻止他們提出一個基本的問題:在五年或十年後
維護含有此代碼的內核會怎麼樣?你可能被要求做出的許多改變——從編碼風格的
調整到大量的重寫——都來自於對Linux的理解,即從現在起十年後,Linux仍將
在開發中。
- 代碼審查是一項艱苦的工作,這是一項相對吃力不討好的工作;人們記得誰編寫了
內核代碼,但對於那些審查它的人來說,幾乎沒有什麼長久的名聲。因此,審閱
人員可能會變得暴躁,尤其是當他們看到同樣的錯誤被一遍又一遍地犯下時。如果
你得到了一個看起來憤怒、侮辱或完全冒犯你的評論,請抑制以同樣方式回應的衝動。
代碼審查是關於代碼的,而不是關於人的,代碼審閱人員不會親自攻擊您。
- 同樣,代碼審閱人員也不想以犧牲你僱主的利益爲代價來宣傳他們僱主的議程。
內核開發人員通常希望今後幾年能在內核上工作,但他們明白他們的僱主可能會改
變。他們真的,幾乎毫無例外地,致力於創造他們所能做到的最好的內核;他們並
沒有試圖給僱主的競爭對手造成不適。
所有這些歸根結底就是,當審閱者向您發送評論時,您需要注意他們正在進行的技術
評論。不要讓他們的表達方式或你自己的驕傲阻止此事。當你在一個補丁上得到評論
時,花點時間去理解評論人想說什麼。如果可能的話,請修覆審閱者要求您修復的內
容。然後回覆審閱者:謝謝他們,並描述你將如何回答他們的問題。
請注意,您不必同意審閱者建議的每個更改。如果您認爲審閱者誤解了您的代碼,請
解釋到底發生了什麼。如果您對建議的更改有技術上的異議,請描述它並證明您對該
問題的解決方案是正確的。如果你的解釋有道理,審閱者會接受的。不過,如果你的
解釋證明缺乏說服力,尤其是當其他人開始同意審稿人的觀點時,請花些時間重新考慮
一下。你很容易對自己解決問題的方法視而不見,以至於你沒有意識到某些東西完全
是錯誤的,或者你甚至沒有解決正確的問題。
Andrew Morton建議,每一個不會導致代碼更改的審閱評論都應該產生一個額外的代碼
注釋;這可以幫助未來的審閱人員避免第一次出現的問題。
一個致命的錯誤是忽視評論,希望它們會消失。它們不會走的。如果您在沒有對之前
收到的評論做出響應的情況下重新發布代碼,那麼很可能會發現補丁毫無用處。
說到重新發布代碼:請記住,審閱者不會記住您上次發布的代碼的所有細節。因此,
提醒審閱人員以前提出的問題以及您如何處理這些問題總是一個好主意;補丁變更
日誌是提供此類信息的好地方。審閱者不必搜索列表檔案來熟悉上次所說的內容;
如果您幫助他們直接開始,當他們重新查看您的代碼時,心情會更好。
如果你已經試著做正確的事情,但事情仍然沒有進展呢?大多數技術上的分歧都可以
通過討論來解決,但有時人們仍需要做出決定。如果你真的認爲這個決定對你不利,
你可以試著向有更高權力的人上訴。對於本文,更高權力的人是 Andrew Morton 。
Andrew 在內核開發社區中非常受尊敬;他經常爲似乎被絕望阻塞的事情清障。儘管
如此,不應輕易就直接找 Andrew ,也不應在所有其他替代方案都被嘗試之前找他。
當然,記住,他也可能不同意你的意見。
接下來會發生什麼
----------------
如果一個補丁被認爲適合添加到內核中,並且大多數審查問題得到解決,下一步通常
是進入子系統維護人員的樹中。工作方式因子系統而異;每個維護人員都有自己的
工作方式。特別是可能有不止一棵樹——也許一棵樹專門用於計劃下一個合併窗口的
補丁,另一棵樹用於長期工作。
對於應用到不屬於明顯子系統樹(例如內存管理修補程序)的區域的修補程序,默認樹
通常上溯到-mm。影響多個子系統的補丁也可以最終進入-mm樹。
包含在子系統樹中可以提高補丁的可見性。現在,使用該樹的其他開發人員將默認獲
得補丁。子系統樹通常也爲Linux提供支持,使其內容對整個開發社區可見。在這一點
上,您很可能會從一組新的審閱者那裡得到更多的評論;這些評論需要像上一輪那樣
得到回應。
在這時也會發生點什麼,這取決於你的補丁的性質,是否與其他人正在做的工作發生
衝突。在最壞的情況下,嚴重的補丁衝突可能會導致一些工作被擱置,以便剩餘的補丁
可以成形併合並。另一些時候,衝突解決將涉及到與其他開發人員合作,可能還會
在樹之間移動一些補丁,以確保所有的應用都是乾淨的。這項工作可能是一件痛苦的
事情,但也需慶幸現在的幸福:在linux-next樹出現之前,這些衝突通常只在合併窗口
中出現,必須迅速解決。現在可以在合併窗口打開之前的空閒時間解決這些問題。
有朝一日,如果一切順利,您將登錄並看到您的補丁已經合併到主線內核中。祝賀你!
然而,一旦慶祝完了(並且您已經將自己添加到維護人員文件中),就一定要記住
一個重要的小事實:工作仍然沒有完成。併入主線也帶來了它的挑戰。
首先,補丁的可見性再次提高。可能會有以前不知道這個補丁的開發者的新一輪評論。
忽略它們可能很有誘惑力,因爲您的代碼不再存在任何被合併的問題。但是,要抵制
這種誘惑,您仍然需要對有問題或建議的開發人員作出響應。
不過,更重要的是:將代碼包含在主線中會將代碼交給更多的一些測試人員。即使您
爲尚未可用的硬體提供了驅動程序,您也會驚訝於有多少人會將您的代碼構建到內核
中。當然,如果有測試人員,也可能會有錯誤報告。
最糟糕的錯誤報告是回歸。如果你的補丁導致回歸,你會發現多到讓你不舒服的眼睛盯
著你;回歸需要儘快修復。如果您不願意或無法修復回歸(其他人都不會爲您修復),
那麼在穩定期內,您的補丁幾乎肯定會被移除。除了否定您爲使補丁進入主線所做的
所有工作之外,如果由於未能修復回歸而取消補丁,很可能會使將來的工作更難被合併。
在處理完任何回歸之後,可能還有其他普通缺陷需要處理。穩定期是修復這些錯誤並
確保代碼在主線內核版本中的首次發布儘可能可靠的最好機會。所以,請回應錯誤
報告,並儘可能解決問題。這就是穩定期的目的;一旦解決了舊補丁的任何問題,就
可以開始盡情創建新補丁。
別忘了,還有其他節點也可能會創建缺陷報告:下一個主線穩定版本,當著名的發行
商選擇包含您補丁的內核版本時等等。繼續響應這些報告是您工作的基本素養。但是
如果這不能提供足夠的動機,那麼也需要考慮:開發社區會記住那些在合併後對代碼
失去興趣的開發人員。下一次你發布補丁時,他們會以你以後不會持續維護它爲前提
來評估它。
其他可能發生的事情
------------------
某天,當你打開你的郵件客戶端時,看到有人給你寄了一個代碼補丁。畢竟,這是
讓您的代碼公開存在的好處之一。如果您同意這個補丁,您可以將它轉發給子系統
維護人員(確保包含一個正確的From:行,這樣屬性是正確的,並添加一個您自己的
signoff ),或者回復一個 Acked-by: 讓原始發送者向上發送它。
如果您不同意補丁,請禮貌地回復,解釋原因。如果可能的話,告訴作者需要做哪些
更改才能讓您接受補丁。合併代碼的編寫者和維護者所反對的補丁的確存在著一定的
阻力,但僅此而已。如果你被認爲不必要的阻礙了好的工作,那麼這些補丁最終會
繞過你並進入主線。在Linux內核中,沒有人對任何代碼擁有絕對的否決權。可能除
了Linus。
在非常罕見的情況下,您可能會看到完全不同的東西:另一個開發人員發布了針對您
的問題的不同解決方案。在這時,兩個補丁之一可能不會被合併,「我的補丁首先
發布」不被認爲是一個令人信服的技術論據。如果有別人的補丁取代了你的補丁而進
入了主線,那麼只有一種方法可以回應你:很高興你的問題解決了,請繼續工作吧。
以這種方式把某人的工作推到一邊可能導致傷心和氣餒,但是社區會記住你的反應,
即使很久以後他們已經忘記了誰的補丁真正被合併。
.. SPDX-License-Identifier: GPL-2.0
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/7.AdvancedTopics.rst <development_advancedtopics>`
:Translator:
時奎亮 Alex Shi <alex.shi@linux.alibaba.com>
:校譯:
吳想成 Wu XiangCheng <bobwxc@email.cn>
胡皓文 Hu Haowen <src.res@email.cn>
.. _tw_development_advancedtopics:
高級主題
========
現在,希望您能夠掌握開發流程的工作方式。然而,還有更多的東西要學!本節將介紹
一些主題,這些主題對希望成爲Linux內核開發過程常規部分的開發人員有幫助。
使用Git管理補丁
---------------
內核使用分布式版本控制始於2002年初,當時Linus首次開始使用專有的Bitkeeper應用
程序。雖然BitKeeper存在爭議,但它所體現的軟體版本管理方法卻肯定不是。分布式
版本控制可以立即加速內核開發項目。現在有好幾種免費的BitKeeper替代品。
但無論好壞,內核項目都已經選擇了Git作爲其工具。
使用Git管理補丁可以使開發人員的生活更加輕鬆,尤其是隨著補丁數量的增長。Git也
有其粗糙的邊角和一定的危險性,它是一個年輕和強大的工具,仍然在其開發人員完善
中。本文檔不會試圖教會讀者如何使用git;這會是個巨長的文檔。相反,這裡的重點
將是Git如何特別適合內核開發過程。想要加快用Git速度的開發人員可以在以下網站上
找到更多信息:
https://git-scm.com/
https://www.kernel.org/pub/software/scm/git/docs/user-manual.html
同時網上也能找到各種各樣的教程。
在嘗試使用它生成補丁供他人使用之前,第一要務是閱讀上述網頁,對Git的工作方式
有一個紮實的了解。使用Git的開發人員應能進行拉取主線存儲庫的副本,查詢修訂
歷史,提交對樹的更改,使用分支等操作。了解Git用於重寫歷史的工具(如rebase)
也很有用。Git有自己的術語和概念;Git的新用戶應該了解引用、遠程分支、索引、
快進合併、推拉、游離頭等。一開始可能有點嚇人,但這些概念不難通過一點學習來
理解。
使用git生成通過電子郵件提交的補丁是提高速度的一個很好的練習。
當您準備好開始建立Git樹供其他人查看時,無疑需要一個可以從中拉取的伺服器。
如果您有一個可以訪問網際網路的系統,那麼使用git-daemon設置這樣的伺服器相對
簡單。同時,免費的公共託管網站(例如github)也開始出現在網絡上。成熟的開發
人員可以在kernel.org上獲得一個帳戶,但這些帳戶並不容易得到;更多有關信息,
請參閱 https://kernel.org/faq/ 。
正常的Git工作流程涉及到許多分支的使用。每一條開發線都可以分爲單獨的「主題
分支」,並獨立維護。Git的分支很容易使用,沒有理由不使用它們。而且,在任何
情況下,您都不應該在任何您打算讓其他人從中拉取的分支中進行開發。應該小心地
創建公開可用的分支;當開發分支處於完整狀態並已準備好時(而不是之前)才合併
開發分支的補丁。
Git提供了一些強大的工具,可以讓您重寫開發歷史。一個不方便的補丁(比如說,
一個打破二分法的補丁,或者有其他一些明顯的缺陷)可以在適當的位置修復,或者
完全從歷史中消失。一個補丁系列可以被重寫,就好像它是在今天的主線上寫的一樣,
即使你已經花了幾個月的時間在寫它。可以透明地將更改從一個分支轉移到另一個
分支。等等。明智地使用git修改歷史的能力可以幫助創建問題更少的乾淨補丁集。
然而,過度使用這種功能可能會導致其他問題,而不僅僅是對創建完美項目歷史的
簡單癡迷。重寫歷史將重寫該歷史中包含的更改,將經過測試(希望如此)的內核樹
變爲未經測試的內核樹。除此之外,如果開發人員沒有共享項目歷史,他們就無法
輕鬆地協作;如果您重寫了其他開發人員拉入他們存儲庫的歷史,您將使這些開發
人員的生活更加困難。因此,這裡有一個簡單的經驗法則:被導出到其他地方的歷史
在此後通常被認爲是不可變的。
因此,一旦將一組更改推送到公開可用的伺服器上,就不應該重寫這些更改。如果您
嘗試強制進行無法快進合併的更改(即不共享同一歷史記錄的更改),Git將嘗試強制
執行此規則。這可能覆蓋檢查,有時甚至需要重寫導出的樹。在樹之間移動變更集以
避免linux-next中的衝突就是一個例子。但這種行爲應該是罕見的。這就是爲什麼
開發應該在私有分支中進行(必要時可以重寫)並且只有在公共分支處於合理的較新
狀態時才轉移到公共分支中的原因之一。
當主線(或其他一組變更所基於的樹)前進時,很容易與該樹合併以保持領先地位。
對於一個私有的分支,rebasing 可能是一個很容易跟上另一棵樹的方法,但是一旦
一棵樹被導出到外界,rebasing就不可取了。一旦發生這種情況,就必須進行完全
合併(merge)。合併有時是很有意義的,但是過於頻繁的合併會不必要地擾亂歷史。
在這種情況下建議的做法是不要頻繁合併,通常只在特定的發布點(如主線-rc發布)
合併。如果您對特定的更改感到緊張,則可以始終在私有分支中執行測試合併。在
這種情況下,git「rerere」工具很有用;它能記住合併衝突是如何解決的,這樣您
就不必重複相同的工作。
關於Git這樣的工具的一個最大的反覆抱怨是:補丁從一個存儲庫到另一個存儲庫的
大量移動使得很容易陷入錯誤建議的變更中,這些變更避開審查雷達進入主線。當內
核開發人員看到這種情況發生時,他們往往會感到不高興;在Git樹上放置未審閱或
主題外的補丁可能會影響您將來讓樹被拉取的能力。引用Linus的話:
::
你可以給我發補丁,但當我從你那裡拉取一個Git補丁時,我需要知道你清楚
自己在做什麼,我需要能夠相信事情而 *無需* 手動檢查每個單獨的更改。
(http://lwn.net/articles/224135/)。
爲了避免這種情況,請確保給定分支中的所有補丁都與相關主題緊密相關;「驅動程序
修復」分支不應更改核心內存管理代碼。而且,最重要的是,不要使用Git樹來繞過
審查過程。不時的將樹的摘要發布到相關的列表中,在合適時候請求linux-next中
包含該樹。
如果其他人開始發送補丁以包含到您的樹中,不要忘記審閱它們。還要確保您維護正確
的作者信息; git 「am」工具在這方面做得最好,但是如果補丁通過第三方轉發給您,
您可能需要在補丁中添加「From:」行。
請求拉取時,請務必提供所有相關信息:樹的位置、要拉取的分支以及拉取將導致的
更改。在這方面 git request-pull 命令非常有用;它將按照其他開發人員所期望的
格式化請求,並檢查以確保您已記得將這些更改推送到公共伺服器。
審閱補丁
--------
一些讀者顯然會反對將本節與「高級主題」放在一起,因爲即使是剛開始的內核開發人員
也應該審閱補丁。當然,沒有比查看其他人發布的代碼更好的方法來學習如何在內核環境
中編程了。此外,審閱者永遠供不應求;通過審閱代碼,您可以對整個流程做出重大貢獻。
審查代碼可能是一副令人生畏的圖景,特別是對一個新的內核開發人員來說,他們
可能會對公開詢問代碼感到緊張,而這些代碼是由那些有更多經驗的人發布的。不過,
即使是最有經驗的開發人員編寫的代碼也可以得到改進。也許對(所有)審閱者最好
的建議是:把審閱評論當成問題而不是批評。詢問「在這條路徑中如何釋放鎖?」
總是比說「這裡的鎖是錯誤的」更好。
不同的開發人員將從不同的角度審查代碼。部分人會主要關注代碼風格以及代碼行是
否有尾隨空格。其他人會主要關注補丁作爲一個整體實現的變更是否對內核有好處。
同時也有人會檢查是否存在鎖問題、堆棧使用過度、可能的安全問題、在其他地方
發現的代碼重複、足夠的文檔、對性能的不利影響、用戶空間ABI更改等。所有類型
的檢查,只要它們能引導更好的代碼進入內核,都是受歡迎和值得的。
.. SPDX-License-Identifier: GPL-2.0
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/8.Conclusion.rst <development_conclusion>`
:Translator:
時奎亮 Alex Shi <alex.shi@linux.alibaba.com>
:校譯:
吳想成 Wu XiangCheng <bobwxc@email.cn>
胡皓文 Hu Haowen <src.res@email.cn>
.. _tw_development_conclusion:
更多信息
========
關於Linux內核開發和相關主題的信息來源很多。首先是在內核原始碼分發中找到的
文檔目錄。頂級
:ref:`Documentation/translations/zh_TW/process/howto.rst <tw_process_howto>`
文件是一個重要的起點;
:ref:`Documentation/translations/zh_TW/process/submitting-patches.rst <tw_submittingpatches>`
和 :ref:`Documentation/translations/zh_TW/process/submitting-drivers.rst <tw_submittingdrivers>`
也是所有內核開發人員都應該閱讀的內容。許多內部內核API都是使用kerneldoc機制
記錄的;「make htmldocs」或「make pdfdocs」可用於以HTML或PDF格式生成這些文檔
(儘管某些發行版提供的tex版本會遇到內部限制,無法正確處理文檔)。
不同的網站在各個細節層次上討論內核開發。本文作者想謙虛地建議用 https://lwn.net/
作爲來源;有關許多特定內核主題的信息可以通過以下網址的 LWN 內核索引找到:
http://lwn.net/kernel/index/
除此之外,內核開發人員的一個寶貴資源是:
https://kernelnewbies.org/
當然,也不應該忘記 https://kernel.org/ ,這是內核發布信息的最終位置。
關於內核開發有很多書:
《Linux設備驅動程序》第三版(Jonathan Corbet、Alessandro Rubini和Greg Kroah Hartman)
線上版本在 http://lwn.net/kernel/ldd3/
《Linux內核設計與實現》(Robert Love)
《深入理解Linux內核》(Daniel Bovet和Marco Cesati)
然而,所有這些書都有一個共同的缺點:它們上架時就往往有些過時,而且已經上架
一段時間了。不過,在那裡還是可以找到相當多的好信息。
有關git的文檔,請訪問:
https://www.kernel.org/pub/software/scm/git/docs/
https://www.kernel.org/pub/software/scm/git/docs/user-manual.html
結論
====
祝賀所有通過這篇冗長的文檔的人。希望它能夠幫助您理解Linux內核是如何開發的,
以及您如何參與這個過程。
最後,重要的是參與。任何開源軟體項目都不會超過其貢獻者投入其中的總和。Linux
內核的發展速度和以前一樣快,因爲它得到了大量開發人員的幫助,他們都在努力使它
變得更好。內核是一個最成功的例子,說明了當成千上萬的人爲了一個共同的目標一起
工作時,可以做出什麼。
不過,內核總是可以從更大的開發人員基礎中獲益。總有更多的工作要做。但是同樣
重要的是,Linux生態系統中的大多數其他參與者可以通過爲內核做出貢獻而受益。使
代碼進入主線是提高代碼質量、降低維護和分發成本、提高對內核開發方向的影響程度
等的關鍵。這是一種共贏的局面。啓動你的編輯器,來加入我們吧;你會非常受歡迎的。
.. SPDX-License-Identifier: GPL-2.0
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/code-of-conduct-interpretation.rst <code_of_conduct_interpretation>`
:Translator: Alex Shi <alex.shi@linux.alibaba.com>
Hu Haowen <src.res@email.cn>
.. _tw_code_of_conduct_interpretation:
Linux內核貢獻者契約行為準則解釋
===============================
:ref:`tw_code_of_conduct` 準則是一個通用文檔,旨在爲幾乎所有開源社區提供一套規則。
每個開源社區都是獨一無二的,Linux內核也不例外。因此,本文描述了Linux內核社區中
如何解釋它。我們也不希望這種解釋隨著時間的推移是靜態的,並將根據需要進行調整。
與開發軟體的「傳統」方法相比,Linux內核開發工作是一個非常個人化的過程。你的貢獻
和背後的想法將被仔細審查,往往導致批判和批評。審查將幾乎總是需要改進,材料才
能包括在內核中。要知道這是因爲所有相關人員都希望看到Linux整體成功的最佳解決方
案。這個開發過程已經被證明可以創建有史以來最健壯的作業系統內核,我們不想做任何
事情來導致提交質量和最終結果的下降。
維護者
------
行為準則多次使用「維護者」一詞。在內核社區中,「維護者」是負責子系統、驅動程序或
文件的任何人,並在內核原始碼樹的維護者文件中列出。
責任
----
《行為準則》提到了維護人員的權利和責任,這需要進一步澄清。
首先,最重要的是,有一個合理的期望是由維護人員通過實例來領導。
也就是說,我們的社區是廣闊的,對維護者沒有新的要求,他們單方面處理其他人在
他們活躍的社區的行爲。這一責任由我們所有人承擔,最終《行為準則》記錄了最終的
上訴路徑,以防有關行爲問題的問題懸而未決。
維護人員應該願意在出現問題時提供幫助,並在需要時與社區中的其他人合作。如果您
不確定如何處理出現的情況,請不要害怕聯繫技術諮詢委員會(TAB)或其他維護人員。
除非您願意,否則不會將其視爲違規報告。如果您不確定是否該聯繫TAB 或任何其他維
護人員,請聯繫我們的衝突調解人 Mishi Choudhary <mishi@linux.com>。
最後,「善待對方」才是每個人的最終目標。我們知道每個人都是人,有時我們都會失敗,
但我們所有人的首要目標應該是努力友好地解決問題。執行行為準則將是最後的選擇。
我們的目標是創建一個強大的、技術先進的作業系統,以及所涉及的技術複雜性,這自
然需要專業知識和決策。
所需的專業知識因貢獻領域而異。它主要由上下文和技術複雜性決定,其次由貢獻者和
維護者的期望決定。
專家的期望和決策都要經過討論,但在最後,爲了取得進展,必須能夠做出決策。這一
特權掌握在維護人員和項目領導的手中,預計將善意使用。
因此,設定專業知識期望、作出決定和拒絕不適當的貢獻不被視爲違反行為準則。
雖然維護人員一般都歡迎新來者,但他們幫助(新)貢獻者克服障礙的能力有限,因此
他們必須確定優先事項。這也不應被視爲違反了行為準則。內核社區意識到這一點,並
以各種形式提供入門級節目,如 kernelnewbies.org 。
範圍
----
Linux內核社區主要在一組公共電子郵件列表上進行交互,這些列表分布在由多個不同
公司或個人控制的多個不同伺服器上。所有這些列表都在內核原始碼樹中的
MAINTAINERS 文件中定義。發送到這些郵件列表的任何電子郵件都被視爲包含在行爲
準則中。
使用 kernel.org bugzilla和其他子系統bugzilla 或bug跟蹤工具的開發人員應該遵循
行為準則的指導原則。Linux內核社區沒有「官方」項目電子郵件地址或「官方」社交媒體
地址。使用kernel.org電子郵件帳戶執行的任何活動必須遵循爲kernel.org發布的行爲
準則,就像任何使用公司電子郵件帳戶的個人必須遵循該公司的特定規則一樣。
行為準則並不禁止在郵件列表消息、內核更改日誌消息或代碼注釋中繼續包含名稱、
電子郵件地址和相關注釋。
其他論壇中的互動包括在適用於上述論壇的任何規則中,通常不包括在行為準則中。
除了在極端情況下可考慮的例外情況。
提交給內核的貢獻應該使用適當的語言。在行為準則之前已經存在的內容現在不會被
視爲違反。然而,不適當的語言可以被視爲一個bug;如果任何相關方提交補丁,
這樣的bug將被更快地修復。當前屬於用戶/內核API的一部分的表達式,或者反映已
發布標準或規範中使用的術語的表達式,不被視爲bug。
執行
----
行為準則中列出的地址屬於行為準則委員會。https://kernel.org/code-of-conduct.html
列出了在任何給定時間接收這些電子郵件的確切成員。成員不能訪問在加入委員會之前
或離開委員會之後所做的報告。
最初的行為準則委員會由TAB的志願者以及作爲中立第三方的專業調解人組成。委員會
的首要任務是建立文件化的流程,並將其公開。
如果報告人不希望將整個委員會納入投訴或關切,可直接聯繫委員會的任何成員,包括
調解人。
行為準則委員會根據流程審查案例(見上文),並根據需要和適當與TAB協商,例如請求
和接收有關內核社區的信息。
委員會做出的任何決定都將提交到表中,以便在必要時與相關維護人員一起執行。行爲
準則委員會的決定可以通過三分之二的投票推翻。
每季度,行為準則委員會和標籤將提供一份報告,概述行為準則委員會收到的匿名報告
及其狀態,以及任何否決決定的細節,包括完整和可識別的投票細節。
我們希望在啓動期之後爲行為準則委員會人員配備建立一個不同的流程。發生此情況時,
將使用該信息更新此文檔。
.. SPDX-License-Identifier: GPL-2.0
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/code-of-conduct.rst <code_of_conduct>`
:Translator: Alex Shi <alex.shi@linux.alibaba.com>
Hu Haowen <src.res@email.cn>
.. _tw_code_of_conduct:
貢獻者契約行為準則
++++++++++++++++++
我們的誓言
==========
爲了營造一個開放、友好的環境,我們作爲貢獻者和維護人承諾,讓我們的社區和參
與者,擁有一個無騷擾的體驗,無論年齡、體型、殘疾、種族、性別特徵、性別認同
和表達、經驗水平、教育程度、社會狀況,經濟地位、國籍、個人外貌、種族、宗教
或性身份和取向。
我們的標準
==========
有助於創造積極環境的行爲包括:
* 使用歡迎和包容的語言
* 尊重不同的觀點和經驗
* 優雅地接受建設性的批評
* 關注什麼對社區最有利
* 對其他社區成員表示同情
參與者的不可接受行爲包括:
* 使用性意味的語言或意象以及不受歡迎的性注意或者更過分的行爲
* 煽動、侮辱/貶損評論以及個人或政治攻擊
* 公開或私下騷擾
* 未經明確許可,發布他人的私人信息,如物理或電子地址。
* 在專業場合被合理認爲不適當的其他行爲
我們的責任
==========
維護人員負責澄清可接受行爲的標準,並應針對任何不可接受行爲採取適當和公平的
糾正措施。
維護人員有權和責任刪除、編輯或拒絕與本行為準則不一致的評論、承諾、代碼、
wiki編輯、問題和其他貢獻,或暫時或永久禁止任何貢獻者從事他們認爲不適當、
威脅、冒犯或有害的其他行爲。
範圍
====
當個人代表項目或其社區時,本行為準則既適用於項目空間,也適用於公共空間。
代表一個項目或社區的例子包括使用一個正式的項目電子郵件地址,通過一個正式
的社交媒體帳戶發布,或者在在線或離線事件中擔任指定的代表。項目維護人員可以
進一步定義和澄清項目的表示。
執行
====
如有濫用、騷擾或其他不可接受的行爲,可聯繫行為準則委員會<conduct@kernel.org>。
所有投訴都將接受審查和調查,並將得到必要和適當的答覆。行為準則委員會有義務
對事件報告人保密。具體執行政策的進一步細節可單獨公布。
歸屬
====
本行為準則改編自《貢獻者契約》,版本1.4,可從
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 獲取。
解釋
====
有關Linux內核社區如何解釋此文檔,請參閱 :ref:`tw_code_of_conduct_interpretation`
.. SPDX-License-Identifier: GPL-2.0
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/development-process.rst <development_process_main>`
:Translator: Alex Shi <alex.shi@linux.alibaba.com>
Hu Haowen <src.res@email.cn>
.. _tw_development_process_main:
內核開發過程指南
================
內容:
.. toctree::
:numbered:
:maxdepth: 2
1.Intro
2.Process
3.Early-stage
4.Coding
5.Posting
6.Followthrough
7.AdvancedTopics
8.Conclusion
本文檔的目的是幫助開發人員(及其經理)以最小的挫折感與開發社區合作。它試圖記錄這個社區如何以一種不熟悉Linux內核開發(或者實際上是自由軟體開發)的人可以訪問的方式工作。雖然這裡有一些技術資料,但這是一個面向過程的討論,不需要深入了解內核編程就可以理解。
.. SPDX-License-Identifier: GPL-2.0
.. _tw_email_clients:
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/email-clients.rst <email_clients>`
譯者::
中文版維護者: 賈威威 Harry Wei <harryxiyou@gmail.com>
中文版翻譯者: 賈威威 Harry Wei <harryxiyou@gmail.com>
時奎亮 Alex Shi <alex.shi@linux.alibaba.com>
中文版校譯者: Yinglin Luan <synmyth@gmail.com>
Xiaochen Wang <wangxiaochen0@gmail.com>
yaxinsn <yaxinsn@163.com>
Hu Haowen <src.res@email.cn>
Linux郵件客戶端配置信息
=======================
Git
---
現在大多數開發人員使用 ``git send-email`` 而不是常規的電子郵件客戶端。這方面
的手冊非常好。在接收端,維護人員使用 ``git am`` 加載補丁。
如果你是 ``git`` 新手,那麼把你的第一個補丁發送給你自己。將其保存爲包含所有
標題的原始文本。運行 ``git am raw_email.txt`` ,然後使用 ``git log`` 查看更
改日誌。如果工作正常,再將補丁發送到相應的郵件列表。
普通配置
--------
Linux內核補丁是通過郵件被提交的,最好把補丁作爲郵件體的內嵌文本。有些維護者
接收附件,但是附件的內容格式應該是"text/plain"。然而,附件一般是不贊成的,
因爲這會使補丁的引用部分在評論過程中變的很困難。
用來發送Linux內核補丁的郵件客戶端在發送補丁時應該處於文本的原始狀態。例如,
他們不能改變或者刪除制表符或者空格,甚至是在每一行的開頭或者結尾。
不要通過"format=flowed"模式發送補丁。這樣會引起不可預期以及有害的斷行。
不要讓你的郵件客戶端進行自動換行。這樣也會破壞你的補丁。
郵件客戶端不能改變文本的字符集編碼方式。要發送的補丁只能是ASCII或者UTF-8編碼方式,
如果你使用UTF-8編碼方式發送郵件,那麼你將會避免一些可能發生的字符集問題。
郵件客戶端應該形成並且保持 References: 或者 In-Reply-To: 標題,那麼
郵件話題就不會中斷。
複製粘帖(或者剪貼粘帖)通常不能用於補丁,因爲制表符會轉換爲空格。使用xclipboard, xclip
或者xcutsel也許可以,但是最好測試一下或者避免使用複製粘帖。
不要在使用PGP/GPG署名的郵件中包含補丁。這樣會使得很多腳本不能讀取和適用於你的補丁。
(這個問題應該是可以修復的)
在給內核郵件列表發送補丁之前,給自己發送一個補丁是個不錯的主意,保存接收到的
郵件,將補丁用'patch'命令打上,如果成功了,再給內核郵件列表發送。
一些郵件客戶端提示
------------------
這裡給出一些詳細的MUA配置提示,可以用於給Linux內核發送補丁。這些並不意味是
所有的軟體包配置總結。
說明:
TUI = 以文本爲基礎的用戶接口
GUI = 圖形界面用戶接口
Alpine (TUI)
~~~~~~~~~~~~
配置選項:
在"Sending Preferences"部分:
- "Do Not Send Flowed Text"必須開啓
- "Strip Whitespace Before Sending"必須關閉
當寫郵件時,光標應該放在補丁會出現的地方,然後按下CTRL-R組合鍵,使指定的
補丁文件嵌入到郵件中。
Evolution (GUI)
~~~~~~~~~~~~~~~
一些開發者成功的使用它發送補丁
當選擇郵件選項:Preformat
從Format->Heading->Preformatted (Ctrl-7)或者工具欄
然後使用:
Insert->Text File... (Alt-n x)插入補丁文件。
你還可以"diff -Nru old.c new.c | xclip",選擇Preformat,然後使用中間鍵進行粘帖。
Kmail (GUI)
~~~~~~~~~~~
一些開發者成功的使用它發送補丁。
默認設置不爲HTML格式是合適的;不要啓用它。
當書寫一封郵件的時候,在選項下面不要選擇自動換行。唯一的缺點就是你在郵件中輸入的任何文本
都不會被自動換行,因此你必須在發送補丁之前手動換行。最簡單的方法就是啓用自動換行來書寫郵件,
然後把它保存爲草稿。一旦你在草稿中再次打開它,它已經全部自動換行了,那麼你的郵件雖然沒有
選擇自動換行,但是還不會失去已有的自動換行。
在郵件的底部,插入補丁之前,放上常用的補丁定界符:三個連字號(---)。
然後在"Message"菜單條目,選擇插入文件,接著選取你的補丁文件。還有一個額外的選項,你可以
通過它配置你的郵件建立工具欄菜單,還可以帶上"insert file"圖標。
你可以安全地通過GPG標記附件,但是內嵌補丁最好不要使用GPG標記它們。作爲內嵌文本的簽發補丁,
當從GPG中提取7位編碼時會使他們變的更加複雜。
如果你非要以附件的形式發送補丁,那麼就右鍵點擊附件,然後選中屬性,突出"Suggest automatic
display",這樣內嵌附件更容易讓讀者看到。
當你要保存將要發送的內嵌文本補丁,你可以從消息列表窗格選擇包含補丁的郵件,然後右擊選擇
"save as"。你可以使用一個沒有更改的包含補丁的郵件,如果它是以正確的形式組成。當你正真在它
自己的窗口之下察看,那時沒有選項可以保存郵件--已經有一個這樣的bug被匯報到了kmail的bugzilla
並且希望這將會被處理。郵件是以只針對某個用戶可讀寫的權限被保存的,所以如果你想把郵件複製到其他地方,
你不得不把他們的權限改爲組或者整體可讀。
Lotus Notes (GUI)
~~~~~~~~~~~~~~~~~
不要使用它。
Mutt (TUI)
~~~~~~~~~~
很多Linux開發人員使用mutt客戶端,所以證明它肯定工作的非常漂亮。
Mutt不自帶編輯器,所以不管你使用什麼編輯器都不應該帶有自動斷行。大多數編輯器都帶有
一個"insert file"選項,它可以通過不改變文件內容的方式插入文件。
'vim'作爲mutt的編輯器:
set editor="vi"
如果使用xclip,敲入以下命令
:set paste
按中鍵之前或者shift-insert或者使用
:r filename
如果想要把補丁作爲內嵌文本。
(a)ttach工作的很好,不帶有"set paste"。
你可以通過 ``git format-patch`` 生成補丁,然後用 Mutt發送它們::
$ mutt -H 0001-some-bug-fix.patch
配置選項:
它應該以默認設置的形式工作。
然而,把"send_charset"設置爲"us-ascii::utf-8"也是一個不錯的主意。
Mutt 是高度可配置的。 這裡是個使用mutt通過 Gmail 發送的補丁的最小配置::
# .muttrc
# ================ IMAP ====================
set imap_user = 'yourusername@gmail.com'
set imap_pass = 'yourpassword'
set spoolfile = imaps://imap.gmail.com/INBOX
set folder = imaps://imap.gmail.com/
set record="imaps://imap.gmail.com/[Gmail]/Sent Mail"
set postponed="imaps://imap.gmail.com/[Gmail]/Drafts"
set mbox="imaps://imap.gmail.com/[Gmail]/All Mail"
# ================ SMTP ====================
set smtp_url = "smtp://username@smtp.gmail.com:587/"
set smtp_pass = $imap_pass
set ssl_force_tls = yes # Require encrypted connection
# ================ Composition ====================
set editor = `echo \$EDITOR`
set edit_headers = yes # See the headers when editing
set charset = UTF-8 # value of $LANG; also fallback for send_charset
# Sender, email address, and sign-off line must match
unset use_domain # because joe@localhost is just embarrassing
set realname = "YOUR NAME"
set from = "username@gmail.com"
set use_from = yes
Mutt文檔含有更多信息:
http://dev.mutt.org/trac/wiki/UseCases/Gmail
http://dev.mutt.org/doc/manual.html
Pine (TUI)
~~~~~~~~~~
Pine過去有一些空格刪減問題,但是這些現在應該都被修復了。
如果可以,請使用alpine(pine的繼承者)
配置選項:
- 最近的版本需要消除流程文本
- "no-strip-whitespace-before-send"選項也是需要的。
Sylpheed (GUI)
~~~~~~~~~~~~~~
- 內嵌文本可以很好的工作(或者使用附件)。
- 允許使用外部的編輯器。
- 對於目錄較多時非常慢。
- 如果通過non-SSL連接,無法使用TLS SMTP授權。
- 在組成窗口中有一個很有用的ruler bar。
- 給地址本中添加地址就不會正確的了解顯示名。
Thunderbird (GUI)
~~~~~~~~~~~~~~~~~
默認情況下,thunderbird很容易損壞文本,但是還有一些方法可以強制它變得更好。
- 在用戶帳號設置里,組成和尋址,不要選擇"Compose messages in HTML format"。
- 編輯你的Thunderbird配置設置來使它不要拆行使用:user_pref("mailnews.wraplength", 0);
- 編輯你的Thunderbird配置設置,使它不要使用"format=flowed"格式:user_pref("mailnews.
send_plaintext_flowed", false);
- 你需要使Thunderbird變爲預先格式方式:
如果默認情況下你書寫的是HTML格式,那不是很難。僅僅從標題欄的下拉框中選擇"Preformat"格式。
如果默認情況下你書寫的是文本格式,你不得把它改爲HTML格式(僅僅作爲一次性的)來書寫新的消息,
然後強制使它回到文本格式,否則它就會拆行。要實現它,在寫信的圖標上使用shift鍵來使它變爲HTML
格式,然後標題欄的下拉框中選擇"Preformat"格式。
- 允許使用外部的編輯器:
針對Thunderbird打補丁最簡單的方法就是使用一個"external editor"擴展,然後使用你最喜歡的
$EDITOR來讀取或者合併補丁到文本中。要實現它,可以下載並且安裝這個擴展,然後添加一個使用它的
按鍵View->Toolbars->Customize...最後當你書寫信息的時候僅僅點擊它就可以了。
TkRat (GUI)
~~~~~~~~~~~
可以使用它。使用"Insert file..."或者外部的編輯器。
Gmail (Web GUI)
~~~~~~~~~~~~~~~
不要使用它發送補丁。
Gmail網頁客戶端自動地把制表符轉換爲空格。
雖然制表符轉換爲空格問題可以被外部編輯器解決,同時它還會使用回車換行把每行拆分爲78個字符。
另一個問題是Gmail還會把任何不是ASCII的字符的信息改爲base64編碼。它把東西變的像歐洲人的名字。
###
.. SPDX-License-Identifier: GPL-2.0
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/embargoed-hardware-issues.rst <embargoed_hardware_issues>`
:Translator: Alex Shi <alex.shi@linux.alibaba.com>
Hu Haowen <src.res@email.cn>
被限制的硬體問題
================
範圍
----
導致安全問題的硬體問題與只影響Linux內核的純軟體錯誤是不同的安全錯誤類別。
必須區別對待諸如熔毀(Meltdown)、Spectre、L1TF等硬體問題,因爲它們通常會影響
所有作業系統(「OS」),因此需要在不同的OS供應商、發行版、硬體供應商和其他各方
之間進行協調。對於某些問題,軟體緩解可能依賴於微碼或固件更新,這需要進一步的
協調。
.. _tw_Contact:
接觸
----
Linux內核硬體安全小組獨立於普通的Linux內核安全小組。
該小組只負責協調被限制的硬體安全問題。Linux內核中純軟體安全漏洞的報告不由該
小組處理,報告者將被引導至常規Linux內核安全小組(:ref:`Documentation/admin-guide/
<securitybugs>`)聯繫。
可以通過電子郵件 <hardware-security@kernel.org> 與小組聯繫。這是一份私密的安全
官名單,他們將幫助您根據我們的文檔化流程協調問題。
郵件列表是加密的,發送到列表的電子郵件可以通過PGP或S/MIME加密,並且必須使用報告
者的PGP密鑰或S/MIME證書籤名。該列表的PGP密鑰和S/MIME證書可從
https://www.kernel.org/.... 獲得。
雖然硬體安全問題通常由受影響的硬體供應商處理,但我們歡迎發現潛在硬體缺陷的研究
人員或個人與我們聯繫。
硬體安全官
^^^^^^^^^^
目前的硬體安全官小組:
- Linus Torvalds(Linux基金會院士)
- Greg Kroah Hartman(Linux基金會院士)
- Thomas Gleixner(Linux基金會院士)
郵件列表的操作
^^^^^^^^^^^^^^
處理流程中使用的加密郵件列表託管在Linux Foundation的IT基礎設施上。通過提供這項
服務,Linux基金會的IT基礎設施安全總監在技術上有能力訪問被限制的信息,但根據他
的僱傭合同,他必須保密。Linux基金會的IT基礎設施安全總監還負責 kernel.org 基礎
設施。
Linux基金會目前的IT基礎設施安全總監是 Konstantin Ryabitsev。
保密協議
--------
Linux內核硬體安全小組不是正式的機構,因此無法簽訂任何保密協議。核心社區意識到
這些問題的敏感性,並提供了一份諒解備忘錄。
諒解備忘錄
----------
Linux內核社區深刻理解在不同作業系統供應商、發行商、硬體供應商和其他各方之間
進行協調時,保持硬體安全問題處於限制狀態的要求。
Linux內核社區在過去已經成功地處理了硬體安全問題,並且有必要的機制允許在限制
限制下進行符合社區的開發。
Linux內核社區有一個專門的硬體安全小組負責初始聯繫,並監督在限制規則下處理
此類問題的過程。
硬體安全小組確定開發人員(領域專家),他們將組成特定問題的初始響應小組。最初
的響應小組可以引入更多的開發人員(領域專家)以最佳的技術方式解決這個問題。
所有相關開發商承諾遵守限制規定,並對收到的信息保密。違反承諾將導致立即從當前
問題中排除,並從所有相關郵件列表中刪除。此外,硬體安全小組還將把違反者排除在
未來的問題之外。這一後果的影響在我們社區是一種非常有效的威懾。如果發生違規
情況,硬體安全小組將立即通知相關方。如果您或任何人發現潛在的違規行爲,請立即
向硬體安全人員報告。
流程
^^^^
由於Linux內核開發的全球分布式特性,面對面的會議幾乎不可能解決硬體安全問題。
由於時區和其他因素,電話會議很難協調,只能在絕對必要時使用。加密電子郵件已被
證明是解決此類問題的最有效和最安全的通信方法。
開始披露
""""""""
披露內容首先通過電子郵件聯繫Linux內核硬體安全小組。此初始聯繫人應包含問題的
描述和任何已知受影響硬體的列表。如果您的組織製造或分發受影響的硬體,我們建議
您也考慮哪些其他硬體可能會受到影響。
硬體安全小組將提供一個特定於事件的加密郵件列表,用於與報告者進行初步討論、
進一步披露和協調。
硬體安全小組將向披露方提供一份開發人員(領域專家)名單,在與開發人員確認他們
將遵守本諒解備忘錄和文件化流程後,應首先告知開發人員有關該問題的信息。這些開發
人員組成初始響應小組,並在初始接觸後負責處理問題。硬體安全小組支持響應小組,
但不一定參與緩解開發過程。
雖然個別開發人員可能通過其僱主受到保密協議的保護,但他們不能以Linux內核開發
人員的身份簽訂個別保密協議。但是,他們將同意遵守這一書面程序和諒解備忘錄。
披露方應提供已經或應該被告知該問題的所有其他實體的聯繫人名單。這有幾個目的:
- 披露的實體列表允許跨行業通信,例如其他作業系統供應商、硬體供應商等。
- 可聯繫已披露的實體,指定應參與緩解措施開發的專家。
- 如果需要處理某一問題的專家受僱於某一上市實體或某一上市實體的成員,則響應
小組可要求該實體披露該專家。這確保專家也是實體反應小組的一部分。
披露
""""
披露方通過特定的加密郵件列表向初始響應小組提供詳細信息。
根據我們的經驗,這些問題的技術文檔通常是一個足夠的起點,最好通過電子郵件進行
進一步的技術澄清。
緩解開發
""""""""
初始響應小組設置加密郵件列表,或在適當的情況下重新修改現有郵件列表。
使用郵件列表接近於正常的Linux開發過程,並且在過去已經成功地用於爲各種硬體安全
問題開發緩解措施。
郵件列表的操作方式與正常的Linux開發相同。發布、討論和審查修補程序,如果同意,
則應用於非公共git存儲庫,參與開發人員只能通過安全連接訪問該存儲庫。存儲庫包含
針對主線內核的主開發分支,並根據需要爲穩定的內核版本提供向後移植分支。
最初的響應小組將根據需要從Linux內核開發人員社區中確定更多的專家。引進專家可以
在開發過程中的任何時候發生,需要及時處理。
如果專家受僱於披露方提供的披露清單上的實體或其成員,則相關實體將要求其參與。
否則,披露方將被告知專家參與的情況。諒解備忘錄涵蓋了專家,要求披露方確認參與。
如果披露方有令人信服的理由提出異議,則必須在五個工作日內提出異議,並立即與事件
小組解決。如果披露方在五個工作日內未作出回應,則視爲默許。
在確認或解決異議後,專家由事件小組披露,並進入開發過程。
協調發布
""""""""
有關各方將協商限制結束的日期和時間。此時,準備好的緩解措施集成到相關的內核樹中
並發布。
雖然我們理解硬體安全問題需要協調限制時間,但限制時間應限制在所有有關各方制定、
測試和準備緩解措施所需的最短時間內。人爲地延長限制時間以滿足會議討論日期或其他
非技術原因,會給相關的開發人員和響應小組帶來了更多的工作和負擔,因爲補丁需要
保持最新,以便跟蹤正在進行的上游內核開發,這可能會造成衝突的更改。
CVE分配
"""""""
硬體安全小組和初始響應小組都不分配CVE,開發過程也不需要CVE。如果CVE是由披露方
提供的,則可用於文檔中。
流程專使
--------
爲了協助這一進程,我們在各組織設立了專使,他們可以回答有關報告流程和進一步處理
的問題或提供指導。專使不參與特定問題的披露,除非響應小組或相關披露方提出要求。
現任專使名單:
============= ========================================================
ARM
AMD Tom Lendacky <tom.lendacky@amd.com>
IBM
Intel Tony Luck <tony.luck@intel.com>
Qualcomm Trilok Soni <tsoni@codeaurora.org>
Microsoft Sasha Levin <sashal@kernel.org>
VMware
Xen Andrew Cooper <andrew.cooper3@citrix.com>
Canonical John Johansen <john.johansen@canonical.com>
Debian Ben Hutchings <ben@decadent.org.uk>
Oracle Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
Red Hat Josh Poimboeuf <jpoimboe@redhat.com>
SUSE Jiri Kosina <jkosina@suse.cz>
Amazon
Google Kees Cook <keescook@chromium.org>
============= ========================================================
如果要將您的組織添加到專使名單中,請與硬體安全小組聯繫。被提名的專使必須完全
理解和支持我們的過程,並且在Linux內核社區中很容易聯繫。
加密郵件列表
------------
我們使用加密郵件列表進行通信。這些列表的工作原理是,發送到列表的電子郵件使用
列表的PGP密鑰或列表的/MIME證書進行加密。郵件列表軟體對電子郵件進行解密,並
使用訂閱者的PGP密鑰或S/MIME證書爲每個訂閱者分別對其進行重新加密。有關郵件列表
軟體和用於確保列表安全和數據保護的設置的詳細信息,請訪問:
https://www.kernel.org/....
關鍵點
^^^^^^
初次接觸見 :ref:`tw_Contact`. 對於特定於事件的郵件列表,密鑰和S/MIME證書通過
特定列表發送的電子郵件傳遞給訂閱者。
訂閱事件特定列表
^^^^^^^^^^^^^^^^
訂閱由響應小組處理。希望參與通信的披露方將潛在訂戶的列表發送給響應組,以便
響應組可以驗證訂閱請求。
每個訂戶都需要通過電子郵件向響應小組發送訂閱請求。電子郵件必須使用訂閱伺服器
的PGP密鑰或S/MIME證書籤名。如果使用PGP密鑰,則必須從公鑰伺服器獲得該密鑰,
並且理想情況下該密鑰連接到Linux內核的PGP信任網。另請參見:
https://www.kernel.org/signature.html.
響應小組驗證訂閱者,並將訂閱者添加到列表中。訂閱後,訂閱者將收到來自郵件列表
的電子郵件,該郵件列表使用列表的PGP密鑰或列表的/MIME證書籤名。訂閱者的電子郵件
客戶端可以從簽名中提取PGP密鑰或S/MIME證書,以便訂閱者可以向列表發送加密電子
郵件。
此差异已折叠。
.. SPDX-License-Identifier: GPL-2.0
.. raw:: latex
\renewcommand\thesection*
\renewcommand\thesubsection*
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/index.rst <process_index>`
:Translator: Alex Shi <alex.shi@linux.alibaba.com>
Hu Haowen <src.res@email.cn>
.. _tw_process_index:
與Linux 內核社區一起工作
========================
你想成爲Linux內核開發人員嗎?歡迎之至!在學習許多關於內核的技術知識的同時,
了解我們社區的工作方式也很重要。閱讀這些文檔可以讓您以更輕鬆的、麻煩更少的
方式將更改合併到內核。
以下是每位開發人員都應閱讀的基本指南:
.. toctree::
:maxdepth: 1
howto
code-of-conduct
code-of-conduct-interpretation
submitting-patches
programming-language
coding-style
development-process
email-clients
license-rules
kernel-enforcement-statement
kernel-driver-statement
其它大多數開發人員感興趣的社區指南:
.. toctree::
:maxdepth: 1
submitting-drivers
submit-checklist
stable-api-nonsense
stable-kernel-rules
management-style
embargoed-hardware-issues
這些是一些總體性技術指南,由於不大好分類而放在這裡:
.. toctree::
:maxdepth: 1
magic-number
volatile-considered-harmful
.. only:: subproject and html
目錄
====
* :ref:`genindex`
.. SPDX-License-Identifier: GPL-2.0
.. _zh_process_statement_driver:
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/kernel-driver-statement.rst <process_statement_driver>`
:Translator: Alex Shi <alex.shi@linux.alibaba.com>
Hu Haowen <src.res@email.cn>
內核驅動聲明
------------
關於Linux內核模塊的立場聲明
===========================
我們,以下署名的Linux內核開發人員,認爲任何封閉源Linux內核模塊或驅動程序都是
有害的和不可取的。我們已經一再發現它們對Linux用戶,企業和更大的Linux生態系統
有害。這樣的模塊否定了Linux開發模型的開放性,穩定性,靈活性和可維護性,並使
他們的用戶無法使用Linux社區的專業知識。提供閉源內核模塊的供應商迫使其客戶
放棄Linux的主要優勢或選擇新的供應商。因此,爲了充分利用開源所提供的成本節省和
共享支持優勢,我們敦促供應商採取措施,以開源內核代碼在Linux上爲其客戶提供支持。
我們只爲自己說話,而不是我們今天可能會爲之工作,過去或將來會爲之工作的任何公司。
- Dave Airlie
- Nick Andrew
- Jens Axboe
- Ralf Baechle
- Felipe Balbi
- Ohad Ben-Cohen
- Muli Ben-Yehuda
- Jiri Benc
- Arnd Bergmann
- Thomas Bogendoerfer
- Vitaly Bordug
- James Bottomley
- Josh Boyer
- Neil Brown
- Mark Brown
- David Brownell
- Michael Buesch
- Franck Bui-Huu
- Adrian Bunk
- François Cami
- Ralph Campbell
- Luiz Fernando N. Capitulino
- Mauro Carvalho Chehab
- Denis Cheng
- Jonathan Corbet
- Glauber Costa
- Alan Cox
- Magnus Damm
- Ahmed S. Darwish
- Robert P. J. Day
- Hans de Goede
- Arnaldo Carvalho de Melo
- Helge Deller
- Jean Delvare
- Mathieu Desnoyers
- Sven-Thorsten Dietrich
- Alexey Dobriyan
- Daniel Drake
- Alex Dubov
- Randy Dunlap
- Michael Ellerman
- Pekka Enberg
- Jan Engelhardt
- Mark Fasheh
- J. Bruce Fields
- Larry Finger
- Jeremy Fitzhardinge
- Mike Frysinger
- Kumar Gala
- Robin Getz
- Liam Girdwood
- Jan-Benedict Glaw
- Thomas Gleixner
- Brice Goglin
- Cyrill Gorcunov
- Andy Gospodarek
- Thomas Graf
- Krzysztof Halasa
- Harvey Harrison
- Stephen Hemminger
- Michael Hennerich
- Tejun Heo
- Benjamin Herrenschmidt
- Kristian Høgsberg
- Henrique de Moraes Holschuh
- Marcel Holtmann
- Mike Isely
- Takashi Iwai
- Olof Johansson
- Dave Jones
- Jesper Juhl
- Matthias Kaehlcke
- Kenji Kaneshige
- Jan Kara
- Jeremy Kerr
- Russell King
- Olaf Kirch
- Roel Kluin
- Hans-Jürgen Koch
- Auke Kok
- Peter Korsgaard
- Jiri Kosina
- Aaro Koskinen
- Mariusz Kozlowski
- Greg Kroah-Hartman
- Michael Krufky
- Aneesh Kumar
- Clemens Ladisch
- Christoph Lameter
- Gunnar Larisch
- Anders Larsen
- Grant Likely
- John W. Linville
- Yinghai Lu
- Tony Luck
- Pavel Machek
- Matt Mackall
- Paul Mackerras
- Roland McGrath
- Patrick McHardy
- Kyle McMartin
- Paul Menage
- Thierry Merle
- Eric Miao
- Akinobu Mita
- Ingo Molnar
- James Morris
- Andrew Morton
- Paul Mundt
- Oleg Nesterov
- Luca Olivetti
- S.Çağlar Onur
- Pierre Ossman
- Keith Owens
- Venkatesh Pallipadi
- Nick Piggin
- Nicolas Pitre
- Evgeniy Polyakov
- Richard Purdie
- Mike Rapoport
- Sam Ravnborg
- Gerrit Renker
- Stefan Richter
- David Rientjes
- Luis R. Rodriguez
- Stefan Roese
- Francois Romieu
- Rami Rosen
- Stephen Rothwell
- Maciej W. Rozycki
- Mark Salyzyn
- Yoshinori Sato
- Deepak Saxena
- Holger Schurig
- Amit Shah
- Yoshihiro Shimoda
- Sergei Shtylyov
- Kay Sievers
- Sebastian Siewior
- Rik Snel
- Jes Sorensen
- Alexey Starikovskiy
- Alan Stern
- Timur Tabi
- Hirokazu Takata
- Eliezer Tamir
- Eugene Teo
- Doug Thompson
- FUJITA Tomonori
- Dmitry Torokhov
- Marcelo Tosatti
- Steven Toth
- Theodore Tso
- Matthias Urlichs
- Geert Uytterhoeven
- Arjan van de Ven
- Ivo van Doorn
- Rik van Riel
- Wim Van Sebroeck
- Hans Verkuil
- Horst H. von Brand
- Dmitri Vorobiev
- Anton Vorontsov
- Daniel Walker
- Johannes Weiner
- Harald Welte
- Matthew Wilcox
- Dan J. Williams
- Darrick J. Wong
- David Woodhouse
- Chris Wright
- Bryan Wu
- Rafael J. Wysocki
- Herbert Xu
- Vlad Yasevich
- Peter Zijlstra
- Bartlomiej Zolnierkiewicz
.. SPDX-License-Identifier: GPL-2.0
.. _tw_process_statement_kernel:
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/kernel-enforcement-statement.rst <process_statement_kernel>`
:Translator: Alex Shi <alex.shi@linux.alibaba.com>
Hu Haowen <src.res@email.cn>
Linux 內核執行聲明
------------------
作爲Linux內核的開發人員,我們對如何使用我們的軟體以及如何實施軟體許可證有著
濃厚的興趣。遵守GPL-2.0的互惠共享義務對我們軟體和社區的長期可持續性至關重要。
雖然有權強制執行對我們社區的貢獻中的單獨版權權益,但我們有共同的利益,即確保
個人強制執行行動的方式有利於我們的社區,不會對我們軟體生態系統的健康和增長
產生意外的負面影響。爲了阻止無益的執法行動,我們同意代表我們自己和我們版權
利益的任何繼承人對Linux內核用戶作出以下符合我們開發社區最大利益的承諾:
儘管有GPL-2.0的終止條款,我們同意,採用以下GPL-3.0條款作爲我們許可證下的
附加許可,作爲任何對許可證下權利的非防禦性主張,這符合我們開發社區的最佳
利益。
但是,如果您停止所有違反本許可證的行爲,則您從特定版權持有人處獲得的
許可證將被恢復:(a)暫時恢復,除非版權持有人明確並最終終止您的許可證;
以及(b)永久恢復, 如果版權持有人未能在你終止違反後60天內以合理方式
通知您違反本許可證的行爲,則永久恢復您的許可證。
此外,如果版權所有者以某種合理的方式通知您違反了本許可,這是您第一次
從該版權所有者處收到違反本許可的通知(對於任何作品),並且您在收到通知
後的30天內糾正違規行爲。則您從特定版權所有者處獲得的許可將永久恢復.
我們提供這些保證的目的是鼓勵更多地使用該軟體。我們希望公司和個人使用、修改和
分發此軟體。我們希望以公開和透明的方式與用戶合作,以消除我們對法規遵從性或強制
執行的任何不確定性,這些不確定性可能會限制我們軟體的採用。我們將法律行動視爲
最後手段,只有在其他社區努力未能解決這一問題時才採取行動。
最後,一旦一個不合規問題得到解決,我們希望用戶會感到歡迎,加入我們爲之努力的
這個項目。共同努力,我們會更強大。
除了下面提到的以外,我們只爲自己說話,而不是爲今天、過去或將來可能爲之工作的
任何公司說話。
- Laura Abbott
- Bjorn Andersson (Linaro)
- Andrea Arcangeli
- Neil Armstrong
- Jens Axboe
- Pablo Neira Ayuso
- Khalid Aziz
- Ralf Baechle
- Felipe Balbi
- Arnd Bergmann
- Ard Biesheuvel
- Tim Bird
- Paolo Bonzini
- Christian Borntraeger
- Mark Brown (Linaro)
- Paul Burton
- Javier Martinez Canillas
- Rob Clark
- Kees Cook (Google)
- Jonathan Corbet
- Dennis Dalessandro
- Vivien Didelot (Savoir-faire Linux)
- Hans de Goede
- Mel Gorman (SUSE)
- Sven Eckelmann
- Alex Elder (Linaro)
- Fabio Estevam
- Larry Finger
- Bhumika Goyal
- Andy Gross
- Juergen Gross
- Shawn Guo
- Ulf Hansson
- Stephen Hemminger (Microsoft)
- Tejun Heo
- Rob Herring
- Masami Hiramatsu
- Michal Hocko
- Simon Horman
- Johan Hovold (Hovold Consulting AB)
- Christophe JAILLET
- Olof Johansson
- Lee Jones (Linaro)
- Heiner Kallweit
- Srinivas Kandagatla
- Jan Kara
- Shuah Khan (Samsung)
- David Kershner
- Jaegeuk Kim
- Namhyung Kim
- Colin Ian King
- Jeff Kirsher
- Greg Kroah-Hartman (Linux Foundation)
- Christian König
- Vinod Koul
- Krzysztof Kozlowski
- Viresh Kumar
- Aneesh Kumar K.V
- Julia Lawall
- Doug Ledford
- Chuck Lever (Oracle)
- Daniel Lezcano
- Shaohua Li
- Xin Long
- Tony Luck
- Catalin Marinas (Arm Ltd)
- Mike Marshall
- Chris Mason
- Paul E. McKenney
- Arnaldo Carvalho de Melo
- David S. Miller
- Ingo Molnar
- Kuninori Morimoto
- Trond Myklebust
- Martin K. Petersen (Oracle)
- Borislav Petkov
- Jiri Pirko
- Josh Poimboeuf
- Sebastian Reichel (Collabora)
- Guenter Roeck
- Joerg Roedel
- Leon Romanovsky
- Steven Rostedt (VMware)
- Frank Rowand
- Ivan Safonov
- Anna Schumaker
- Jes Sorensen
- K.Y. Srinivasan
- David Sterba (SUSE)
- Heiko Stuebner
- Jiri Kosina (SUSE)
- Willy Tarreau
- Dmitry Torokhov
- Linus Torvalds
- Thierry Reding
- Rik van Riel
- Luis R. Rodriguez
- Geert Uytterhoeven (Glider bvba)
- Eduardo Valentin (Amazon.com)
- Daniel Vetter
- Linus Walleij
- Richard Weinberger
- Dan Williams
- Rafael J. Wysocki
- Arvind Yadav
- Masahiro Yamada
- Wei Yongjun
- Lv Zheng
- Marc Zyngier (Arm Ltd)
.. SPDX-License-Identifier: GPL-2.0
.. SPDX-License-Identifier: GPL-2.0
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/license-rules.rst <kernel_licensing>`
:Translator: Alex Shi <alex.shi@linux.alibaba.com>
Hu Haowen <src.res@email.cn>
.. _tw_kernel_licensing:
Linux內核許可規則
=================
Linux內核根據LICENSES/preferred/GPL-2.0中提供的GNU通用公共許可證版本2
(GPL-2.0)的條款提供,並在LICENSES/exceptions/Linux-syscall-note中顯式
描述了例外的系統調用,如COPYING文件中所述。
此文檔文件提供了如何對每個源文件進行注釋以使其許可證清晰明確的說明。
它不會取代內核的許可證。
內核原始碼作爲一個整體適用於COPYING文件中描述的許可證,但是單個源文件可以
具有不同的與GPL-20兼容的許可證::
GPL-1.0+ : GNU通用公共許可證v1.0或更高版本
GPL-2.0+ : GNU通用公共許可證v2.0或更高版本
LGPL-2.0 : 僅限GNU庫通用公共許可證v2
LGPL-2.0+: GNU 庫通用公共許可證v2或更高版本
LGPL-2.1 : 僅限GNU寬通用公共許可證v2.1
LGPL-2.1+: GNU寬通用公共許可證v2.1或更高版本
除此之外,個人文件可以在雙重許可下提供,例如一個兼容的GPL變體,或者BSD,
MIT等許可。
用戶空間API(UAPI)頭文件描述了用戶空間程序與內核的接口,這是一種特殊情況。
根據內核COPYING文件中的注釋,syscall接口是一個明確的邊界,它不會將GPL要求
擴展到任何使用它與內核通信的軟體。由於UAPI頭文件必須包含在創建在Linux內核
上運行的可執行文件的任何源文件中,因此此例外必須記錄在特別的許可證表述中。
表達源文件許可證的常用方法是將匹配的樣板文本添加到文件的頂部注釋中。由於
格式,拼寫錯誤等,這些「樣板」很難通過那些在上下文中使用的驗證許可證合規性
的工具。
樣板文本的替代方法是在每個源文件中使用軟體包數據交換(SPDX)許可證標識符。
SPDX許可證標識符是機器可解析的,並且是用於提供文件內容的許可證的精確縮寫。
SPDX許可證標識符由Linux 基金會的SPDX 工作組管理,並得到了整個行業,工具
供應商和法律團隊的合作夥伴的一致同意。有關詳細信息,請參閱
https://spdx.org/
Linux內核需要所有源文件中的精確SPDX標識符。內核中使用的有效標識符在
`許可標識符`_ 一節中進行了解釋,並且已可以在
https://spdx.org/licenses/ 上的官方SPDX許可證列表中檢索,並附帶許可證
文本。
許可標識符語法
--------------
1.安置:
   內核文件中的SPDX許可證標識符應添加到可包含注釋的文件中的第一行。對於大多
數文件,這是第一行,除了那些在第一行中需要'#!PATH_TO_INTERPRETER'的腳本。
對於這些腳本,SPDX標識符進入第二行。
|
2. 風格:
SPDX許可證標識符以注釋的形式添加。注釋樣式取決於文件類型::
C source: // SPDX-License-Identifier: <SPDX License Expression>
C header: /* SPDX-License-Identifier: <SPDX License Expression> */
ASM: /* SPDX-License-Identifier: <SPDX License Expression> */
scripts: # SPDX-License-Identifier: <SPDX License Expression>
.rst: .. SPDX-License-Identifier: <SPDX License Expression>
.dts{i}: // SPDX-License-Identifier: <SPDX License Expression>
如果特定工具無法處理標準注釋樣式,則應使用工具接受的相應注釋機制。這是在
C 頭文件中使用「/\*\*/」樣式注釋的原因。過去在使用生成的.lds文件中觀察到
構建被破壞,其中'ld'無法解析C++注釋。現在已經解決了這個問題,但仍然有較
舊的彙編程序工具無法處理C++樣式的注釋。
|
3. 句法:
<SPDX許可證表達式>是SPDX許可證列表中的SPDX短格式許可證標識符,或者在許可
證例外適用時由「WITH」分隔的兩個SPDX短格式許可證標識符的組合。當應用多個許
可證時,表達式由分隔子表達式的關鍵字「AND」,「OR」組成,並由「(」,「)」包圍。
帶有「或更高」選項的[L]GPL等許可證的許可證標識符通過使用「+」來表示「或更高」
選項來構建。::
// SPDX-License-Identifier: GPL-2.0+
// SPDX-License-Identifier: LGPL-2.1+
當需要修正的許可證時,應使用WITH。 例如,linux內核UAPI文件使用表達式::
// SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note
// SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note
其它在內核中使用WITH例外的事例如下::
// SPDX-License-Identifier: GPL-2.0 WITH mif-exception
// SPDX-License-Identifier: GPL-2.0+ WITH GCC-exception-2.0
例外只能與特定的許可證標識符一起使用。有效的許可證標識符列在異常文本文件
的標記中。有關詳細信息,請參閱 `許可標識符`_ 一章中的 `例外`_ 。
如果文件是雙重許可且只選擇一個許可證,則應使用OR。例如,一些dtsi文件在雙
許可下可用::
// SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
內核中雙許可文件中許可表達式的示例::
// SPDX-License-Identifier: GPL-2.0 OR MIT
// SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
// SPDX-License-Identifier: GPL-2.0 OR Apache-2.0
// SPDX-License-Identifier: GPL-2.0 OR MPL-1.1
// SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) OR MIT
// SPDX-License-Identifier: GPL-1.0+ OR BSD-3-Clause OR OpenSSL
如果文件具有多個許可證,其條款全部適用於使用該文件,則應使用AND。例如,
如果代碼是從另一個項目繼承的,並且已經授予了將其放入內核的權限,但原始
許可條款需要保持有效::
// SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) AND MIT
另一個需要遵守兩套許可條款的例子是::
// SPDX-License-Identifier: GPL-1.0+ AND LGPL-2.1+
許可標識符
----------
當前使用的許可證以及添加到內核的代碼許可證可以分解爲:
1. _`優先許可`:
應儘可能使用這些許可證,因爲它們已知完全兼容並廣泛使用。這些許可證在內核
目錄::
LICENSES/preferred/
此目錄中的文件包含完整的許可證文本和 `元標記`_ 。文件名與SPDX許可證標識
符相同,後者應用於源文件中的許可證。
例如::
LICENSES/preferred/GPL-2.0
包含GPLv2許可證文本和所需的元標籤::
LICENSES/preferred/MIT
包含MIT許可證文本和所需的元標記
_`元標記`:
許可證文件中必須包含以下元標記:
- Valid-License-Identifier:
  一行或多行, 聲明那些許可標識符在項目內有效, 以引用此特定許可的文本。通
常這是一個有效的標識符,但是例如對於帶有'或更高'選項的許可證,兩個標識
符都有效。
- SPDX-URL:
SPDX頁面的URL,其中包含與許可證相關的其他信息.
- Usage-Guidance:
使用建議的自由格式文本。該文本必須包含SPDX許可證標識符的正確示例,因爲
它們應根據 `許可標識符語法`_ 指南放入源文件中。
- License-Text:
此標記之後的所有文本都被視爲原始許可文本
文件格式示例::
Valid-License-Identifier: GPL-2.0
Valid-License-Identifier: GPL-2.0+
SPDX-URL: https://spdx.org/licenses/GPL-2.0.html
Usage-Guide:
To use this license in source code, put one of the following SPDX
tag/value pairs into a comment according to the placement
guidelines in the licensing rules documentation.
For 'GNU General Public License (GPL) version 2 only' use:
SPDX-License-Identifier: GPL-2.0
For 'GNU General Public License (GPL) version 2 or any later version' use:
SPDX-License-Identifier: GPL-2.0+
License-Text:
Full license text
::
SPDX-License-Identifier: MIT
SPDX-URL: https://spdx.org/licenses/MIT.html
Usage-Guide:
To use this license in source code, put the following SPDX
tag/value pair into a comment according to the placement
guidelines in the licensing rules documentation.
SPDX-License-Identifier: MIT
License-Text:
Full license text
|
2. 不推薦的許可證:
這些許可證只應用於現有代碼或從其他項目導入代碼。這些許可證在內核目錄::
LICENSES/other/
此目錄中的文件包含完整的許可證文本和 `元標記`_ 。文件名與SPDX許可證標識
符相同,後者應用於源文件中的許可證。
例如::
LICENSES/other/ISC
包含國際系統聯合許可文本和所需的元標籤::
LICENSES/other/ZLib
包含ZLIB許可文本和所需的元標籤.
元標籤:
「其他」許可證的元標籤要求與 `優先許可`_ 的要求相同。
文件格式示例::
Valid-License-Identifier: ISC
SPDX-URL: https://spdx.org/licenses/ISC.html
Usage-Guide:
Usage of this license in the kernel for new code is discouraged
and it should solely be used for importing code from an already
existing project.
To use this license in source code, put the following SPDX
tag/value pair into a comment according to the placement
guidelines in the licensing rules documentation.
SPDX-License-Identifier: ISC
License-Text:
Full license text
|
3. _`例外`:
某些許可證可以修改,並允許原始許可證不具有的某些例外權利。這些例外在
內核目錄::
LICENSES/exceptions/
此目錄中的文件包含完整的例外文本和所需的 `例外元標記`_ 。
例如::
LICENSES/exceptions/Linux-syscall-note
包含Linux內核的COPYING文件中記錄的Linux系統調用例外,該文件用於UAPI
頭文件。例如::
LICENSES/exceptions/GCC-exception-2.0
包含GCC'連結例外',它允許獨立於其許可證的任何二進位文件與標記有此例外的
文件的編譯版本連結。這是從GPL不兼容原始碼創建可運行的可執行文件所必需的。
_`例外元標記`:
以下元標記必須在例外文件中可用:
- SPDX-Exception-Identifier:
  一個可與SPDX許可證標識符一起使用的例外標識符。
- SPDX-URL:
SPDX頁面的URL,其中包含與例外相關的其他信息。
- SPDX-Licenses:
  以逗號分隔的例外可用的SPDX許可證標識符列表。
- Usage-Guidance:
使用建議的自由格式文本。必須在文本後面加上SPDX許可證標識符的正確示例,
因爲它們應根據 `許可標識符語法`_ 指南放入源文件中。
- Exception-Text:
此標記之後的所有文本都被視爲原始異常文本
文件格式示例::
SPDX-Exception-Identifier: Linux-syscall-note
SPDX-URL: https://spdx.org/licenses/Linux-syscall-note.html
SPDX-Licenses: GPL-2.0, GPL-2.0+, GPL-1.0+, LGPL-2.0, LGPL-2.0+, LGPL-2.1, LGPL-2.1+
Usage-Guidance:
This exception is used together with one of the above SPDX-Licenses
to mark user-space API (uapi) header files so they can be included
into non GPL compliant user-space application code.
To use this exception add it with the keyword WITH to one of the
identifiers in the SPDX-Licenses tag:
SPDX-License-Identifier: <SPDX-License> WITH Linux-syscall-note
Exception-Text:
Full exception text
::
SPDX-Exception-Identifier: GCC-exception-2.0
SPDX-URL: https://spdx.org/licenses/GCC-exception-2.0.html
SPDX-Licenses: GPL-2.0, GPL-2.0+
Usage-Guidance:
The "GCC Runtime Library exception 2.0" is used together with one
of the above SPDX-Licenses for code imported from the GCC runtime
library.
To use this exception add it with the keyword WITH to one of the
identifiers in the SPDX-Licenses tag:
SPDX-License-Identifier: <SPDX-License> WITH GCC-exception-2.0
Exception-Text:
Full exception text
所有SPDX許可證標識符和例外都必須在LICENSES子目錄中具有相應的文件。這是允許
工具驗證(例如checkpatch.pl)以及準備好從源讀取和提取許可證所必需的, 這是
各種FOSS組織推薦的,例如 `FSFE REUSE initiative <https://reuse.software/>`_.
_`模塊許可`
-----------------
可加載內核模塊還需要MODULE_LICENSE()標記。此標記既不替代正確的原始碼
許可證信息(SPDX-License-Identifier),也不以任何方式表示或確定提供模塊
原始碼的確切許可證。
此標記的唯一目的是提供足夠的信息,該模塊是否是自由軟體或者是內核模塊加
載器和用戶空間工具的專有模塊。
MODULE_LICENSE()的有效許可證字符串是:
============================= =============================================
"GPL" 模塊是根據GPL版本2許可的。這並不表示僅限於
GPL-2.0或GPL-2.0或更高版本之間的任何區別。
最正確許可證信息只能通過相應源文件中的許可證
信息來確定
"GPL v2" 和"GPL"相同,它的存在是因爲歷史原因。
"GPL and additional rights" 表示模塊源在GPL v2變體和MIT許可下雙重許可的
歷史變體。請不要在新代碼中使用。
"Dual MIT/GPL" 表達該模塊在GPL v2變體或MIT許可證選擇下雙重
許可的正確方式。
"Dual BSD/GPL" 該模塊根據GPL v2變體或BSD許可證選擇進行雙重
許可。 BSD許可證的確切變體只能通過相應源文件
中的許可證信息來確定。
"Dual MPL/GPL" 該模塊根據GPL v2變體或Mozilla Public License
(MPL)選項進行雙重許可。 MPL許可證的確切變體
只能通過相應的源文件中的許可證信息來確定。
"Proprietary" 該模塊屬於專有許可。此字符串僅用於專有的第三
方模塊,不能用於在內核樹中具有原始碼的模塊。
以這種方式標記的模塊在加載時會使用'P'標記汙
染內核,並且內核模塊加載器拒絕將這些模塊連結
到使用EXPORT_SYMBOL_GPL()導出的符號。
============================= =============================================
.. SPDX-License-Identifier: GPL-2.0
.. _tw_magicnumbers:
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/magic-number.rst <magicnumbers>`
如果想評論或更新本文的內容,請直接發信到LKML。如果你使用英文交流有困難的話,也可
以向中文版維護者求助。如果本翻譯更新不及時或者翻譯存在問題,請聯繫中文版維護者::
中文版維護者: 賈威威 Jia Wei Wei <harryxiyou@gmail.com>
中文版翻譯者: 賈威威 Jia Wei Wei <harryxiyou@gmail.com>
中文版校譯者: 賈威威 Jia Wei Wei <harryxiyou@gmail.com>
胡皓文 Hu Haowen <src.res@email.cn>
Linux 魔術數
============
這個文件是有關當前使用的魔術值註冊表。當你給一個結構添加了一個魔術值,你也應該把這個魔術值添加到這個文件,因爲我們最好把用於各種結構的魔術值統一起來。
使用魔術值來保護內核數據結構是一個非常好的主意。這就允許你在運行期檢查(a)一個結構是否已經被攻擊,或者(b)你已經給一個例行程序通過了一個錯誤的結構。後一種情況特別地有用---特別是當你通過一個空指針指向結構體的時候。tty源碼,例如,經常通過特定驅動使用這種方法並且反覆地排列特定方面的結構。
使用魔術值的方法是在結構的開始處聲明的,如下::
struct tty_ldisc {
int magic;
...
};
當你以後給內核添加增強功能的時候,請遵守這條規則!這樣就會節省數不清的調試時間,特別是一些古怪的情況,例如,數組超出範圍並且重新寫了超出部分。遵守這個規則,‪這些情況可以被快速地,安全地避免。
Theodore Ts'o
31 Mar 94
給當前的Linux 2.1.55添加魔術表。
Michael Chastain
<mailto:mec@shout.net>
22 Sep 1997
現在應該最新的Linux 2.1.112.因爲在特性凍結期間,不能在2.2.x前改變任何東西。這些條目被數域所排序。
Krzysztof G.Baranowski
<mailto: kgb@knm.org.pl>
29 Jul 1998
更新魔術表到Linux 2.5.45。剛好越過特性凍結,但是有可能還會有一些新的魔術值在2.6.x之前融入到內核中。
Petr Baudis
<pasky@ucw.cz>
03 Nov 2002
更新魔術表到Linux 2.5.74。
Fabian Frederick
<ffrederick@users.sourceforge.net>
09 Jul 2003
===================== ================ ======================== ==========================================
魔術數名 數字 結構 文件
===================== ================ ======================== ==========================================
PG_MAGIC 'P' pg_{read,write}_hdr ``include/linux/pg.h``
CMAGIC 0x0111 user ``include/linux/a.out.h``
MKISS_DRIVER_MAGIC 0x04bf mkiss_channel ``drivers/net/mkiss.h``
HDLC_MAGIC 0x239e n_hdlc ``drivers/char/n_hdlc.c``
APM_BIOS_MAGIC 0x4101 apm_user ``arch/x86/kernel/apm_32.c``
DB_MAGIC 0x4442 fc_info ``drivers/net/iph5526_novram.c``
DL_MAGIC 0x444d fc_info ``drivers/net/iph5526_novram.c``
FASYNC_MAGIC 0x4601 fasync_struct ``include/linux/fs.h``
FF_MAGIC 0x4646 fc_info ``drivers/net/iph5526_novram.c``
PTY_MAGIC 0x5001 ``drivers/char/pty.c``
PPP_MAGIC 0x5002 ppp ``include/linux/if_pppvar.h``
SSTATE_MAGIC 0x5302 serial_state ``include/linux/serial.h``
SLIP_MAGIC 0x5302 slip ``drivers/net/slip.h``
STRIP_MAGIC 0x5303 strip ``drivers/net/strip.c``
SIXPACK_MAGIC 0x5304 sixpack ``drivers/net/hamradio/6pack.h``
AX25_MAGIC 0x5316 ax_disp ``drivers/net/mkiss.h``
TTY_MAGIC 0x5401 tty_struct ``include/linux/tty.h``
MGSL_MAGIC 0x5401 mgsl_info ``drivers/char/synclink.c``
TTY_DRIVER_MAGIC 0x5402 tty_driver ``include/linux/tty_driver.h``
MGSLPC_MAGIC 0x5402 mgslpc_info ``drivers/char/pcmcia/synclink_cs.c``
USB_SERIAL_MAGIC 0x6702 usb_serial ``drivers/usb/serial/usb-serial.h``
FULL_DUPLEX_MAGIC 0x6969 ``drivers/net/ethernet/dec/tulip/de2104x.c``
USB_BLUETOOTH_MAGIC 0x6d02 usb_bluetooth ``drivers/usb/class/bluetty.c``
RFCOMM_TTY_MAGIC 0x6d02 ``net/bluetooth/rfcomm/tty.c``
USB_SERIAL_PORT_MAGIC 0x7301 usb_serial_port ``drivers/usb/serial/usb-serial.h``
CG_MAGIC 0x00090255 ufs_cylinder_group ``include/linux/ufs_fs.h``
LSEMAGIC 0x05091998 lse ``drivers/fc4/fc.c``
GDTIOCTL_MAGIC 0x06030f07 gdth_iowr_str ``drivers/scsi/gdth_ioctl.h``
RIEBL_MAGIC 0x09051990 ``drivers/net/atarilance.c``
NBD_REQUEST_MAGIC 0x12560953 nbd_request ``include/linux/nbd.h``
RED_MAGIC2 0x170fc2a5 (any) ``mm/slab.c``
BAYCOM_MAGIC 0x19730510 baycom_state ``drivers/net/baycom_epp.c``
ISDN_X25IFACE_MAGIC 0x1e75a2b9 isdn_x25iface_proto_data ``drivers/isdn/isdn_x25iface.h``
ECP_MAGIC 0x21504345 cdkecpsig ``include/linux/cdk.h``
LSOMAGIC 0x27091997 lso ``drivers/fc4/fc.c``
LSMAGIC 0x2a3b4d2a ls ``drivers/fc4/fc.c``
WANPIPE_MAGIC 0x414C4453 sdla_{dump,exec} ``include/linux/wanpipe.h``
CS_CARD_MAGIC 0x43525553 cs_card ``sound/oss/cs46xx.c``
LABELCL_MAGIC 0x4857434c labelcl_info_s ``include/asm/ia64/sn/labelcl.h``
ISDN_ASYNC_MAGIC 0x49344C01 modem_info ``include/linux/isdn.h``
CTC_ASYNC_MAGIC 0x49344C01 ctc_tty_info ``drivers/s390/net/ctctty.c``
ISDN_NET_MAGIC 0x49344C02 isdn_net_local_s ``drivers/isdn/i4l/isdn_net_lib.h``
SAVEKMSG_MAGIC2 0x4B4D5347 savekmsg ``arch/*/amiga/config.c``
CS_STATE_MAGIC 0x4c4f4749 cs_state ``sound/oss/cs46xx.c``
SLAB_C_MAGIC 0x4f17a36d kmem_cache ``mm/slab.c``
COW_MAGIC 0x4f4f4f4d cow_header_v1 ``arch/um/drivers/ubd_user.c``
I810_CARD_MAGIC 0x5072696E i810_card ``sound/oss/i810_audio.c``
TRIDENT_CARD_MAGIC 0x5072696E trident_card ``sound/oss/trident.c``
ROUTER_MAGIC 0x524d4157 wan_device [in ``wanrouter.h`` pre 3.9]
SAVEKMSG_MAGIC1 0x53415645 savekmsg ``arch/*/amiga/config.c``
GDA_MAGIC 0x58464552 gda ``arch/mips/include/asm/sn/gda.h``
RED_MAGIC1 0x5a2cf071 (any) ``mm/slab.c``
EEPROM_MAGIC_VALUE 0x5ab478d2 lanai_dev ``drivers/atm/lanai.c``
HDLCDRV_MAGIC 0x5ac6e778 hdlcdrv_state ``include/linux/hdlcdrv.h``
PCXX_MAGIC 0x5c6df104 channel ``drivers/char/pcxx.h``
KV_MAGIC 0x5f4b565f kernel_vars_s ``arch/mips/include/asm/sn/klkernvars.h``
I810_STATE_MAGIC 0x63657373 i810_state ``sound/oss/i810_audio.c``
TRIDENT_STATE_MAGIC 0x63657373 trient_state ``sound/oss/trident.c``
M3_CARD_MAGIC 0x646e6f50 m3_card ``sound/oss/maestro3.c``
FW_HEADER_MAGIC 0x65726F66 fw_header ``drivers/atm/fore200e.h``
SLOT_MAGIC 0x67267321 slot ``drivers/hotplug/cpqphp.h``
SLOT_MAGIC 0x67267322 slot ``drivers/hotplug/acpiphp.h``
LO_MAGIC 0x68797548 nbd_device ``include/linux/nbd.h``
M3_STATE_MAGIC 0x734d724d m3_state ``sound/oss/maestro3.c``
VMALLOC_MAGIC 0x87654320 snd_alloc_track ``sound/core/memory.c``
KMALLOC_MAGIC 0x87654321 snd_alloc_track ``sound/core/memory.c``
PWC_MAGIC 0x89DC10AB pwc_device ``drivers/usb/media/pwc.h``
NBD_REPLY_MAGIC 0x96744668 nbd_reply ``include/linux/nbd.h``
ENI155_MAGIC 0xa54b872d midway_eprom ``drivers/atm/eni.h``
CODA_MAGIC 0xC0DAC0DA coda_file_info ``fs/coda/coda_fs_i.h``
DPMEM_MAGIC 0xc0ffee11 gdt_pci_sram ``drivers/scsi/gdth.h``
YAM_MAGIC 0xF10A7654 yam_port ``drivers/net/hamradio/yam.c``
CCB_MAGIC 0xf2691ad2 ccb ``drivers/scsi/ncr53c8xx.c``
QUEUE_MAGIC_FREE 0xf7e1c9a3 queue_entry ``drivers/scsi/arm/queue.c``
QUEUE_MAGIC_USED 0xf7e1cc33 queue_entry ``drivers/scsi/arm/queue.c``
HTB_CMAGIC 0xFEFAFEF1 htb_class ``net/sched/sch_htb.c``
NMI_MAGIC 0x48414d4d455201 nmi_s ``arch/mips/include/asm/sn/nmi.h``
===================== ================ ======================== ==========================================
請注意,在聲音記憶管理中仍然有一些特殊的爲每個驅動定義的魔術值。查看include/sound/sndmagic.h來獲取他們完整的列表信息。很多OSS聲音驅動擁有自己從音效卡PCI ID構建的魔術值-他們也沒有被列在這裡。
IrDA子系統也使用了大量的自己的魔術值,查看include/net/irda/irda.h來獲取他們完整的信息。
HFS是另外一個比較大的使用魔術值的文件系統-你可以在fs/hfs/hfs.h中找到他們。
.. SPDX-License-Identifier: GPL-2.0
.. include:: ../disclaimer-zh_TW.rst
:Original: :ref:`Documentation/process/management-style.rst <managementstyle>`
:Translator: Alex Shi <alex.shi@linux.alibaba.com>
Hu Haowen <src.res@email.cn>
.. _tw_managementstyle:
Linux內核管理風格
=================
這是一個簡短的文檔,描述了Linux內核首選的(或胡編的,取決於您問誰)管理風格。
它的目的是在某種程度上參照 :ref:`process/coding-style.rst <codingstyle>`
主要是爲了避免反覆回答 [#cnf1]_ 相同(或類似)的問題。
管理風格是非常個人化的,比簡單的編碼風格規則更難以量化,因此本文檔可能與實
際情況有關,也可能與實際情況無關。起初它是一個玩笑,但這並不意味著它可能不
是真的。你得自己決定。
順便說一句,在談到「核心管理者」時,主要是技術負責人,而不是在公司內部進行傳
統管理的人。如果你簽署了採購訂單或者對你的團隊的預算有任何了解,你幾乎肯定
不是一個核心管理者。這些建議可能適用於您,也可能不適用於您。
首先,我建議你購買「高效人的七個習慣」,而不是閱讀它。燒了它,這是一個偉大的
象徵性姿態。
.. [#cnf1] 本文件並不是通過回答問題,而是通過讓提問者痛苦地明白,我們不知道
答案是什麼。
不管怎樣,這裡是:
.. _tw_decisions:
1)決策
-------
每個人都認爲管理者做決定,而且決策很重要。決定越大越痛苦,管理者就必須越高級。
這很明顯,但事實並非如此。
遊戲的名字是 **避免** 做出決定。尤其是,如果有人告訴你「選擇(a)或(b),
我們真的需要你來做決定」,你就是陷入麻煩的管理者。你管理的人比你更了解細節,
所以如果他們來找你做技術決策,你完蛋了。你顯然沒有能力爲他們做這個決定。
(推論:如果你管理的人不比你更了解細節,你也會被搞砸,儘管原因完全不同。
也就是說,你的工作是錯的,他們應該管理你的才智)
所以遊戲的名字是 **避免** 做出決定,至少是那些大而痛苦的決定。做一些小的
和非結果性的決定是很好的,並且使您看起來好像知道自己在做什麼,所以內核管理者
需要做的是將那些大的和痛苦的決定變成那些沒有人真正關心的小事情。
這有助於認識到一個大的決定和一個小的決定之間的關鍵區別是你是否可以在事後修正
你的決定。任何決定都可以通過始終確保如果你錯了(而且你一定會錯),你以後總是
可以通過回溯來彌補損失。突然間,你就要做兩個無關緊要的決定,一個是錯誤的,另
一個是正確的。
人們甚至會認爲這是真正的領導能力(咳,胡說,咳)。
因此,避免重大決策的關鍵在於避免做那些無法挽回的事情。不要被引導到一個你無法
逃離的角落。走投無路的老鼠可能很危險——走投無路的管理者真可憐。
事實證明,由於沒有人會愚蠢到讓內核管理者承擔巨大的財政責任,所以通常很容易
回溯。既然你不可能浪費掉你無法償還的巨額資金,你唯一可以回溯的就是技術決策,
而回溯很容易:只要告訴大家你是個不稱職的傻瓜,說對不起,然後撤銷你去年讓別
人所做的毫無價值的工作。突然間,你一年前做的決定不在是一個重大的決定,因爲
它很容易被推翻。
事實證明,有些人對接受這種方法有困難,原因有兩個:
- 承認你是個白癡比看起來更難。我們都喜歡保持形象,在公共場合說你錯了有時
確實很難。
- 如果有人告訴你,你去年所做的工作終究是不值得的,那麼對那些可憐的低級工
程師來說也是很困難的,雖然實際的 **工作** 很容易刪除,但你可能已經不可
挽回地失去了工程師的信任。記住:「不可撤銷」是我們一開始就試圖避免的,
而你的決定終究是一個重大的決定。
令人欣慰的是,這兩個原因都可以通過預先承認你沒有任何線索,提前告訴人們你的
決定完全是初步的,而且可能是錯誤的事情來有效地緩解。你應該始終保留改變主意
的權利,並讓人們 **意識** 到這一點。當你 **還沒有** 做過真正愚蠢的事情的時
候,承認自己是愚蠢的要容易得多。
然後,當它真的被證明是愚蠢的時候,人們就轉動他們的眼珠說「哎呀,下次不要了」。
這種對不稱職的先發制人的承認,也可能使真正做這項工作的人也會三思是否值得做。
畢竟,如果他們不確定這是否是一個好主意,你肯定不應該通過向他們保證他們所做
的工作將會進入(內核)鼓勵他們。在他們開始一項巨大的努力之前,至少讓他們三
思而後行。
記住:他們最好比你更了解細節,而且他們通常認爲他們對每件事都有答案。作爲一
個管理者,你能做的最好的事情不是灌輸自信,而是對他們所做的事情進行健康的批
判性思考。
順便說一句,另一種避免做出決定的方法是看起來很可憐的抱怨 「我們不能兩者兼
得嗎?」 相信我,它是有效的。如果不清楚哪種方法更好,他們最終會弄清楚的。
最終的答案可能是兩個團隊都會因爲這種情況而感到沮喪,以至於他們放棄了。
這聽起來像是一個失敗,但這通常是一個跡象,表明兩個項目都有問題,而參與其中
的人不能做決定的原因是他們都是錯誤的。你最終會聞到玫瑰的味道,你避免了另一
個你本可以搞砸的決定。
2)人
-----
大多數人都是白癡,做一名管理者意味著你必須處理好這件事,也許更重要的是,
**他們** 必須處理好你。
事實證明,雖然很容易糾正技術錯誤,但不容易糾正人格障礙。你只能和他們的和
你的(人格障礙)共處。
但是,爲了做好作爲內核管理者的準備,最好記住不要燒掉任何橋樑,不要轟炸任何
無辜的村民,也不要疏遠太多的內核開發人員。事實證明,疏遠人是相當容易的,而
親近一個疏遠的人是很難的。因此,「疏遠」立即屬於「不可逆」的範疇,並根據
:ref:`tw_decisions` 成爲絕不可以做的事情。
這裡只有幾個簡單的規則:
(1) 不要叫人笨蛋(至少不要在公共場合)
(2) 學習如何在忘記規則(1)時道歉
問題在於 #1 很容易去做,因爲你可以用數百萬種不同的方式說「你是一個笨蛋」 [#cnf2]_
有時甚至沒有意識到,而且幾乎總是帶著一種白熱化的信念,認爲你是對的。
你越確信自己是對的(讓我們面對現實吧,你可以把幾乎所有人都稱爲壞人,而且你
經常是對的),事後道歉就越難。
要解決此問題,您實際上只有兩個選項:
- 非常擅長道歉
- 把「愛」均勻地散開,沒有人會真正感覺到自己被不公平地瞄準了。讓它有足夠的
創造性,他們甚至可能會覺得好笑。
選擇永遠保持禮貌是不存在的。沒有人會相信一個如此明顯地隱藏了他們真實性格的人。
.. [#cnf2] 保羅·西蒙演唱了「離開愛人的50種方法」,因爲坦率地說,「告訴開發者
他們是D*CKHEAD" 的100萬種方法都無法確認。但我確信他已經這麼想了。
3)人2 - 好人
-------------
雖然大多數人都是白癡,但不幸的是,據此推論你也是白癡,儘管我們都自我感覺良
好,我們比普通人更好(讓我們面對現實吧,沒有人相信他們是普通人或低於普通人),
我們也應該承認我們不是最鋒利的刀,而且會有其他人比你更不像白癡。
有些人對聰明人反應不好。其他人利用它們。
作爲內核維護人員,確保您在第二組中。接受他們,因爲他們會讓你的工作更容易。
特別是,他們能夠爲你做決定,這就是遊戲的全部內容。
所以當你發現一個比你聰明的人時,就順其自然吧。你的管理職責在很大程度上變成
了「聽起來像是個好主意——去嘗試吧」,或者「聽起來不錯,但是XXX呢?」「。第二個版
本尤其是一個很好的方法,要麼學習一些關於「XXX」的新東西,要麼通過指出一些聰明
人沒有想到的東西來顯得更具管理性。無論哪種情況,你都會贏。
要注意的一件事是認識到一個領域的偉大不一定會轉化爲其他領域。所以你可能會向
特定的方向刺激人們,但讓我們面對現實吧,他們可能擅長他們所做的事情,而且對
其他事情都很差勁。好消息是,人們往往會自然而然地重拾他們擅長的東西,所以當
你向某個方向刺激他們時,你並不是在做不可逆轉的事情,只是不要用力推。
4)責備
-------
事情會出問題的,人們希望去責備人。貼標籤,你就是受責備的人。
事實上,接受責備並不難,尤其是當人們意識到這不 **全是** 你的過錯時。這讓我
們找到了承擔責任的最佳方式:爲別人承擔這件事。你會感覺很好,他們會感覺很好,
沒有受到指責. 那誰,失去了他們的全部36GB色情收藏的人,因爲你的無能將勉強承
認,你至少沒有試圖逃避責任。
然後讓真正搞砸了的開發人員(如果你能找到他們)私下知道他們搞砸了。不僅是爲
了將來可以避免,而且爲了讓他們知道他們欠你一個人情。而且,也許更重要的是,
他們也可能是能夠解決問題的人。因爲,讓我們面對現實吧,肯定不是你。
承擔責任也是你首先成爲管理者的原因。這是讓人們信任你,讓你獲得潛在的榮耀的
一部分,因爲你就是那個會說「我搞砸了」的人。如果你已經遵循了以前的規則,你現
在已經很擅長說了。
5)應避免的事情
---------------
有一件事人們甚至比被稱爲「笨蛋」更討厭,那就是在一個神聖的聲音中被稱爲「笨蛋」。
第一個你可以道歉,第二個你不會真正得到機會。即使你做得很好,他們也可能不再
傾聽。
我們都認爲自己比別人強,這意味著當別人裝腔作勢時,這會讓我們很惱火。你也許
在道德和智力上比你周圍的每個人都優越,但不要試圖太明顯,除非你真的打算激怒
某人 [#cnf3]_
同樣,不要對事情太客氣或太微妙。禮貌很容易落得落花流水,把問題隱藏起來,
正如他們所說,「在網際網路上,沒人能聽到你的含蓄。」用一個鈍器把這一點錘進去,
因爲你不能真的依靠別人來獲得你的觀點。
一些幽默可以幫助緩和直率和道德化。過度到荒謬的地步,可以灌輸一個觀點,而不
會讓接受者感到痛苦,他們只是認爲你是愚蠢的。因此,它可以幫助我們擺脫對批評
的個人心理障礙。
.. [#cnf3] 提示:與你的工作沒有直接關係的網絡新聞組是消除你對他人不滿的好
方法。偶爾寫些侮辱性的帖子,打個噴嚏,讓你的情緒得到淨化。別把牢騷帶回家
6)爲什麼是我?
---------------
既然你的主要責任似乎是爲別人的錯誤承擔責任,並且讓別人痛苦地明白你是不稱職
的,那麼顯而易見的問題之一就變成了爲什麼首先要這樣做。
首先,雖然你可能會或可能不會聽到十幾歲女孩(或男孩,讓我們不要在這裡評判或
性別歧視)敲你的更衣室門,你會得到一個巨大的個人成就感爲「負責」。別介意你真
的在領導別人,你要跟上別人,儘可能快地追趕他們。每個人都會認爲你是負責人。
如果你可以做到這個, 這是個偉大的工作!
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册