Linux Kernel Patch Submission Tips

Aug 5, 20174 likes824 views

Newcomers to the Linux Kernel community are often unfamiliar with the patch submission process and how to interact with maintainers. This talk aims to improve the experience of first time patch submissions. This talk is in Chinese.

Linux Kernel Patch
Submission Tips
蔡鎮宇 Tsai, Chen-Yu (wens) / 2017-08-06
www.puffinbrowser.com

#你誰啊亂公告給Talk
? Systems Engineer / SRE @
CloudMosa, Inc. (maker of Puffin Browser)
? 批踢踢系統總監
? Linux Kernel Allwinner SoC Co-maintainer
2

今天不提…
? Git
? C
? 怎麼找東西寫 patch
? 工具怎麼用
? Live Demo
3

切 commit
? 每個 commit 要獨立
? 每個 commit 做一件事
? 每個 commit 都要可以編
? 檢查 coding style
5

Commit Message
phy: sun4i-usb: Support A83T USB PHYs
The A83T has 3 USB PHYs, 1 for OTG, 1 for standard
USB, 1 for USB HSIC. The phy initialization
procedure is very different from other SoCs, but
the PMU bits are the same, with additional bits
for HSIC.
Signed-off-by: Chen-Yu Tsai <wens@csie.org>
6

Commit 標題
phy: sun4i-usb: Support A83T USB PHYs
The A83T has 3 USB PHYs, 1 for OTG, 1 for standard
USB, 1 for USB HSIC. The phy initialization
procedure is very different from other SoCs, but
the PMU bits are the same, with additional bits
for HSIC.
Signed-off-by: Chen-Yu Tsai <wens@csie.org>
7
一行80字元內簡述更動內容

Signed-off-by
phy: sun4i-usb: Support A83T USB PHYs
The A83T has 3 USB PHYs, 1 for OTG, 1 for standard
…
Signed-off-by: Chen-Yu Tsai <wens@csie.org>
9
畫押：認證更動是自己寫的，
或是自己有權利貢獻的。

Signed-off-by
? Developer's Certificate of Origin
? 請見
Documentation/process/submitting-
patches.rst
? 需要用真名
10

準則
? 送信時不要更動到內容
? 複製貼上很容易出錯
? 多個 patch 請寫 cover letter
? 不要一次送太多
12

Cover Letter
? 解釋一系列的 patch 在做什麼
? 如有需要，簡述每個 patch 的內容
? 預期 maintainer 怎麼處理
13

工具
? scripts/checkpatch.pl
? 自動化檢查 coding style (跟拼字)
? scipts/get_maintainer.pl
? 找出相關的 maintainer 跟 mailing list
14

工具
? git format-patch
? 生出 patch 的 email
? git send-email
? 自動送出去
15

石沉大海
? Maintainer 度假去了
? 歐洲人常會放暑假
? 美國人放感恩節、聖誕節連續假期
? 寄錯人了…
17

Checkpatch errors
? 你沒跑 checkpatch 對不對？
? 改好重送
18

Does not apply
? 你的修改是基於哪個版本？哪個 repository?
? 通常要基於 maintainer 的 -next 或 -fixes
? 偷懶可用 linux-next
? 也可能是別人的 patch 捷足先登
19

NACK
? Reviewer 不同意變更的方向
? 思考有沒有其他的解法
20

Looks good, but…
? Reviewer 認為有改進空間
? 討論，改進，送出新的版本 v(N+1)
21

Build error w/ xxxconfig
? Kconfig 相依性不對？
? 一定需要某個選項有開或沒開？
? 不能編成模組？
? 平台限定？
23

Applied!
? 沒事了！
? 過幾天看有沒有出現在 maintainer 的 repository 或
是 linux-next
24

回信要注意
? 回信一樣純文字
? 不要更動引用原文
? 回文回在前後文中間，不要回在最上面
? In-reply-to 標頭要有
25

送第二版
? git format-patch -v2
? 要附修改紀錄 (changelog)
? Reviewer 可能不會記得跟你說過什麼
27

Reviewer 不和善 ?
? Reviewer 通常對事不對人
? 把 review 當成學習的機會
28

Maintainer 很辛苦
? 多數是無給薪志願者利用自己閒暇時間
? 一天的信件量很可觀
? Maintainer 也是人
29

Maintainer 的各種毛
? 回應周期
? 各式偏好
? 各平台或子系統的不成文規定
30

參考資料
? Write and Submit your first Linux kernel Patch
? https://youtu.be/LLBrBBImJt4
? https://kernelnewbies.org/FirstKernelPatch
32

Mirror from https://speakerdeck.com/chusiang/continuous-delivery-with-ansible-x-gitlab-ci-2e # DevOps 人一定要知道的 Ansible & GitLab CI 持續交付技巧 (2/e) Ansible 是個與 Puppet, Salt, Chef 並列的 Infrastructure as Code 組態設定工具，其簡單易用的特性更讓人愛不釋手；GitLab 是業界很常見的 Git 私有版本控制服務，搭配其 GitLab CI 將能快速建立屬於自己的 CI/CD Pipeline 與自動化部署。本次凍仁將會藉由 Ansible 和 GitLab 帶領大家一探持續部署的世界和 DevOps 的威力！ #DevOpsTaiwan #DevOpsTW #Agile #Meetup > https://devops.kktix.cc/events/meetup-kaohsiung-1

20121111 linux introChang Mt

該怎麼樣（認真的）部署你的 Python Web 應用程式?Andy Dai

初心者 Git 上手攻略Lucien Lee

嵌入式平台移植技巧概说Joseph Lu

Linux File systemKenny (netman)

U boot 程式碼打掃計畫Macpaul Lin

20121213 foundation of software development 2 2-ktchuangnetdbncku

使用 Pytest 進行單元測試 (PyCon TW 2021)Max Lai

Raspberry pi 基本操作艾鍗科技

[3]投影片 futurewad樹莓派研習會 141204CAVEDU Education

软体组装心得分享Wen Liao

Docker tutorialazole Lai

Docker tutorial. 基本的介紹：run, pull, commit, Dockerfile, build, port, link, volume. 在用 docker 的時候，會一直提醒自己，關鍵在 a process in a box，一個 process，在一個箱子裡。很簡單的一句話，但我覺得是很關鍵的一個概念。另外一個我覺得很重要的是 writable layer + readonly image 這個做法，很喜歡這個設計，所以每次的 commit 都應該只是小小的變化，解耦以便於共用、更新、抽換。其他的反而簡單，指令 ps，commit/pull/push 這些，不是跟原本 linux 的指令概念類似，就是仿照 git，有稍微在用 linux 與 git 的人，應該非常好懂，我反覺得這部分不需多加解釋，學的人自己去玩過一次便是了。（一定要自己動手玩過才有感覺的！）這份投影片沒有提到的部分是 exec/attach, save/load, export/import，與更進階一點的網路。希望下次能有機會整理出來，也能再多看、多想一些使用案例，工具好用，但自己也要用得好才能發揮。 http://imazole.wordpress.com/2014/12/24/docker-tutorial/

42qu thrift1Zoom Quiet

Python 于 webgame 的应用勇浩赖

Continuous Delivery with Ansible x GitLab CIChu-Siang Lai

Mirror from https://speakerdeck.com/chusiang/continuous-delivery-with-ansible-x-gitlab-ci . # DevOps 人一定要知道的 Ansible & GitLab CI 持續交付技巧 Ansible 是個與 Puppet, Salt, Chef 並列的 Infrastructure as Code 組態設定工具，其簡單易用的特性更讓人愛不釋手；GitLab 是業界很常見的 Git 私有版本控制服務，搭配其 GitLab CI 將能快速建立屬於自己的 CI/CD Pipeline 與自動化部署。本次凍仁將會藉由 Ansible 和 GitLab 帶領大家一探持續部署的世界和 DevOps 的威力！ #DevOpsTaiwan #DevOpsTW #COSCUP #COSCUP2017 > http://coscup.org/2017/#/schedule/day1/3071450

141118 Raspberry Pi 電鈴工作坊@松山文創園區CAVEDU Education

[1]投影片 futurewad樹莓派研習會 141120CAVEDU Education

Learning to Use Git | WeiYuanWei-Yuan Chang

Docker 基礎介紹與實戰Bo-Yi Wu

A brief introduction to Vagrant – 原來 VirtualBox 可以這樣玩Wen-Tien Chang

Linux期末效能調教(kernel trnning)米米林

快速入坑 Node.js - 0613 SITCON 雲林定期聚Lorex L. Yang

向 Linux 核心上游提交更動 - Submitting Changes to Linux Kernel Upstream - COSCUP 2024Chen-Yu Tsai

Putting Taiwan on the kernel.org Keysigning MapChen-Yu Tsai

More Related Content

Similar to Linux Kernel Patch Submission Tips (20)

初心者 Git 上手攻略Lucien Lee

嵌入式平台移植技巧概说Joseph Lu

Linux File systemKenny (netman)

U boot 程式碼打掃計畫Macpaul Lin

20121213 foundation of software development 2 2-ktchuangnetdbncku

使用 Pytest 進行單元測試 (PyCon TW 2021)Max Lai

Raspberry pi 基本操作艾鍗科技

[3]投影片 futurewad樹莓派研習會 141204CAVEDU Education

软体组装心得分享Wen Liao

Docker tutorialazole Lai

42qu thrift1Zoom Quiet

Python 于 webgame 的应用勇浩赖

Continuous Delivery with Ansible x GitLab CIChu-Siang Lai

141118 Raspberry Pi 電鈴工作坊@松山文創園區CAVEDU Education

[1]投影片 futurewad樹莓派研習會 141120CAVEDU Education

Learning to Use Git | WeiYuanWei-Yuan Chang

Docker 基礎介紹與實戰Bo-Yi Wu

A brief introduction to Vagrant – 原來 VirtualBox 可以這樣玩Wen-Tien Chang

Linux期末效能調教(kernel trnning)米米林

快速入坑 Node.js - 0613 SITCON 雲林定期聚Lorex L. Yang

初心者 Git 上手攻略Lucien Lee

嵌入式平台移植技巧概说Joseph Lu

Linux File systemKenny (netman)

U boot 程式碼打掃計畫Macpaul Lin

20121213 foundation of software development 2 2-ktchuangnetdbncku

使用 Pytest 進行單元測試 (PyCon TW 2021)Max Lai

Raspberry pi 基本操作艾鍗科技

[3]投影片 futurewad樹莓派研習會 141204CAVEDU Education

软体组装心得分享Wen Liao

Docker tutorialazole Lai

42qu thrift1Zoom Quiet

Python 于 webgame 的应用勇浩赖

Continuous Delivery with Ansible x GitLab CIChu-Siang Lai

141118 Raspberry Pi 電鈴工作坊@松山文創園區CAVEDU Education

[1]投影片 futurewad樹莓派研習會 141120CAVEDU Education

Learning to Use Git | WeiYuanWei-Yuan Chang

Docker 基礎介紹與實戰Bo-Yi Wu

A brief introduction to Vagrant – 原來 VirtualBox 可以這樣玩Wen-Tien Chang

Linux期末效能調教(kernel trnning)米米林

快速入坑 Node.js - 0613 SITCON 雲林定期聚Lorex L. Yang

More from Chen-Yu Tsai (7)

向 Linux 核心上游提交更動 - Submitting Changes to Linux Kernel Upstream - COSCUP 2024Chen-Yu Tsai

Putting Taiwan on the kernel.org Keysigning MapChen-Yu Tsai

Identifying and Supporting 'X-compatible' Hardware BlocksChen-Yu Tsai

The document discusses identifying and supporting hardware blocks that are compatible with existing driver models in Linux even if they are not exact matches. It provides examples of standard interfaces like AHCI, EHCI, and OHCI that have driver libraries while the platform driver handles platform-specific details. Licensed IP cores and clones that have the same logic but different register layouts are also discussed. Methods for identifying compatible hardware include examining datasheets, vendor kernels, and experience. Driver implementations can use driver libraries along with platform drivers to manage platform-specific resources and setup. Techniques for handling register changes like offset tables, regmap, and custom I/O functions are presented. Specific examples of compatible hardware implementations for things like 8250 UART, Design

Allwinner Kernel Upstreaming ExperiencesChen-Yu Tsai

This document discusses experiences with upstreaming kernel code for Allwinner SoCs. It provides an overview of the current status of various ARM SoC vendors' code in the mainline kernel, including Allwinner, Rockchip, and Mediatek. It offers tips for contributors, such as starting with small and simple code changes, reusing existing drivers when possible, and asking maintainers for feedback. It also outlines some challenges, like lack of documentation, porting outdated vendor code, and dealing with binary-only drivers and potential GPL violations.

Upstream Allwinner ARM SoC (sunxi) SupportChen-Yu Tsai

This document summarizes the status of upstreaming Allwinner SoC support. It discusses that U-boot now has mainline support for many Allwinner SoCs including A10/A13/A20/A23/A31/A33. The Linux kernel also has basic support for these SoCs, with features like USB host, SATA, and simplefb working in 4.2. Future work includes A80 and H3 support in U-boot and enabling features like audio, raw NAND, and SMP on A80 in the kernel. Mainline support for Allwinner SoCs is progressing with the help of upstream developers.

linux-sunxi - OSDC.tw 2014 Lightning TalkChen-Yu Tsai

The document discusses the linux-sunxi project which provides Linux kernel support for Allwinner sunXi system on chips (SOCs) commonly found in cheap Android devices. The linux-sunxi kernel has full functionality in the 3.4 stable kernel and is working to integrate support into the mainline kernel, having already integrated drivers for timers, clocks, interrupts, USB host, Ethernet and more in the 3.15 kernel. Efforts are ongoing to integrate support for MMC/SDIO, USB OTG, DMA, and graphics. Documentation and code are almost complete and those interested are invited to join the project community online or on Freenode IRC.

Open Standards and Open Source in Datacenter Management - OSDC.tw 2014Chen-Yu Tsai

This document discusses open standards and open source tools for monitoring, managing, and provisioning datacenter resources. It provides an overview of tools like MRTG and Munin for monitoring network traffic and system resources. For management, it discusses IPMI for out-of-band server control and SSH for secure access. Provisioning tools mentioned include DHCP, PXE, kickstart/preseed for automatic installation, and Chef/Puppet for configuration management. The goal is to enable small teams to manage thousands of nodes hands-off using these open standards and tools.

向 Linux 核心上游提交更動 - Submitting Changes to Linux Kernel Upstream - COSCUP 2024Chen-Yu Tsai

Putting Taiwan on the kernel.org Keysigning MapChen-Yu Tsai

Identifying and Supporting 'X-compatible' Hardware BlocksChen-Yu Tsai

Allwinner Kernel Upstreaming ExperiencesChen-Yu Tsai

Upstream Allwinner ARM SoC (sunxi) SupportChen-Yu Tsai

linux-sunxi - OSDC.tw 2014 Lightning TalkChen-Yu Tsai

Open Standards and Open Source in Datacenter Management - OSDC.tw 2014Chen-Yu Tsai

Linux Kernel Patch Submission Tips

1. Linux Kernel Patch Submission Tips 蔡鎮宇 Tsai, Chen-Yu (wens) / 2017-08-06 www.puffinbrowser.com

2. #你誰啊亂公告給Talk ? Systems Engineer / SRE @ CloudMosa, Inc. (maker of Puffin Browser) ? 批踢踢系統總監 ? Linux Kernel Allwinner SoC Co-maintainer 2

3. 今天不提… ? Git ? C ? 怎麼找東西寫 patch ? 工具怎麼用 ? Live Demo 3

4. 程式改好了… 4

5. 切 commit ? 每個 commit 要獨立 ? 每個 commit 做一件事 ? 每個 commit 都要可以編 ? 檢查 coding style 5

6. Commit Message phy: sun4i-usb: Support A83T USB PHYs The A83T has 3 USB PHYs, 1 for OTG, 1 for standard USB, 1 for USB HSIC. The phy initialization procedure is very different from other SoCs, but the PMU bits are the same, with additional bits for HSIC. Signed-off-by: Chen-Yu Tsai <wens@csie.org> 6

7. Commit 標題 phy: sun4i-usb: Support A83T USB PHYs The A83T has 3 USB PHYs, 1 for OTG, 1 for standard USB, 1 for USB HSIC. The phy initialization procedure is very different from other SoCs, but the PMU bits are the same, with additional bits for HSIC. Signed-off-by: Chen-Yu Tsai <wens@csie.org> 7 一行80字元內簡述更動內容

8. Commit Message phy: sun4i-usb: Support A83T USB PHYs The A83T has 3 USB PHYs, 1 for OTG, 1 for standard USB, 1 for USB HSIC. The phy initialization procedure is very different from other SoCs, but the PMU bits are the same, with additional bits for HSIC. Signed-off-by: Chen-Yu Tsai <wens@csie.org> 8 解釋更動背後的動機和情境

9. Signed-off-by phy: sun4i-usb: Support A83T USB PHYs The A83T has 3 USB PHYs, 1 for OTG, 1 for standard … Signed-off-by: Chen-Yu Tsai <wens@csie.org> 9 畫押：認證更動是自己寫的，或是自己有權利貢獻的。

10. Signed-off-by ? Developer's Certificate of Origin ? 請見 Documentation/process/submitting- patches.rst ? 需要用真名 10

11. 送 patch 11

12. 準則 ? 送信時不要更動到內容 ? 複製貼上很容易出錯 ? 多個 patch 請寫 cover letter ? 不要一次送太多 12

13. Cover Letter ? 解釋一系列的 patch 在做什麼 ? 如有需要，簡述每個 patch 的內容 ? 預期 maintainer 怎麼處理 13

14. 工具 ? scripts/checkpatch.pl ? 自動化檢查 coding style (跟拼字) ? scipts/get_maintainer.pl ? 找出相關的 maintainer 跟 mailing list 14

15. 工具 ? git format-patch ? 生出 patch 的 email ? git send-email ? 自動送出去 15

16. Patch 送出去了！然後呢？

17. 石沉大海 ? Maintainer 度假去了 ? 歐洲人常會放暑假 ? 美國人放感恩節、聖誕節連續假期 ? 寄錯人了… 17

18. Checkpatch errors ? 你沒跑 checkpatch 對不對？ ? 改好重送 18

19. Does not apply ? 你的修改是基於哪個版本？哪個 repository? ? 通常要基於 maintainer 的 -next 或 -fixes ? 偷懶可用 linux-next ? 也可能是別人的 patch 捷足先登 19

20. NACK ? Reviewer 不同意變更的方向 ? 思考有沒有其他的解法 20

21. Looks good, but… ? Reviewer 認為有改進空間 ? 討論，改進，送出新的版本 v(N+1) 21

22. Build error ? 你有測試過你的程式嗎？ 22

23. Build error w/ xxxconfig ? Kconfig 相依性不對？ ? 一定需要某個選項有開或沒開？ ? 不能編成模組？ ? 平台限定？ 23

24. Applied! ? 沒事了！ ? 過幾天看有沒有出現在 maintainer 的 repository 或是 linux-next 24

25. 回信要注意 ? 回信一樣純文字 ? 不要更動引用原文 ? 回文回在前後文中間，不要回在最上面 ? In-reply-to 標頭要有 25

26. 改進完了 26

27. 送第二版 ? git format-patch -v2 ? 要附修改紀錄 (changelog) ? Reviewer 可能不會記得跟你說過什麼 27

28. Reviewer 不和善 ? ? Reviewer 通常對事不對人 ? 把 review 當成學習的機會 28

29. Maintainer 很辛苦 ? 多數是無給薪志願者利用自己閒暇時間 ? 一天的信件量很可觀 ? Maintainer 也是人 29

30. Maintainer 的各種毛 ? 回應周期 ? 各式偏好 ? 各平台或子系統的不成文規定 30

31. Q&A 31

32. 參考資料 ? Write and Submit your first Linux kernel Patch ? https://youtu.be/LLBrBBImJt4 ? https://kernelnewbies.org/FirstKernelPatch 32

33. 謝謝大家 33

狠狠撸

Linux Kernel Patch Submission Tips

Recommended

More Related Content

Similar to Linux Kernel Patch Submission Tips (20)

More from Chen-Yu Tsai (7)

Linux Kernel Patch Submission Tips