This shows you the differences between two versions of the page.
Next revision | Previous revision Next revision Both sides next revision | ||
en:users:drivers:ath10k:sources [2015/01/26 09:49] 127.0.0.1 external edit |
en:users:drivers:ath10k:sources [2015/09/02 12:11] Kalle Valo Add link to Ingo Molnar's email about commit logs |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | o | ||
Go back --> [[en/users/Drivers/ath10k|ath10k]] | Go back --> [[en/users/Drivers/ath10k|ath10k]] | ||
Line 23: | Line 23: | ||
[[https://github.com/kvalo/ath/tree/master/drivers/net/wireless/ath/ath10k|https://github.com/kvalo/ath/tree/master/drivers/net/wireless/ath/ath10k]] | [[https://github.com/kvalo/ath/tree/master/drivers/net/wireless/ath/ath10k|https://github.com/kvalo/ath/tree/master/drivers/net/wireless/ath/ath10k]] | ||
- | John Linville pulls the ath tree into wireless-next tree. Then David Miller pulls it to net-next which is eventually pulled by Linus Torvalds to official kernel releases. | + | Periodically Kalle Valo pulls the ath tree into wireless-drivers-next tree. Then David Miller pulls it to net-next which is eventually pulled by Linus Torvalds to official kernel releases. As a rough estimate it takes 2-4 months for a patch to propage from ath.git to an official Linux release. |
Line 43: | Line 43: | ||
* Commit log MUST not be empty. | * Commit log MUST not be empty. | ||
* The commit log MUST answer the question "Why?": | * The commit log MUST answer the question "Why?": | ||
- | * * Describe the motivation behind the bug. | + | * Describe the motivation behind the bug. |
- | * * How does it change the functionality from user's point of view? | + | * How does it change the functionality from user's point of view? |
- | * * Does it fix a bug? If it does, please describe the bug (doesn't need to be long). Also if there's a public bug report add a link to the bug report. | + | * Does it fix a bug? If it does, please describe the bug (doesn't need to be long). Also if there's a public bug report add a link to the bug report. |
- | * * If a problem has been found during code review and doesn't fix a known issues, mention that in the commit log. | + | * If a problem has been found during code review and doesn't fix a known issues, mention that in the commit log. |
+ | * Ingo Molnar has written [[https://lkml.kernel.org/g/20150314075357.GA8319@gmail.com|a nice description]] about what maintainers are looking from a commit log. | ||
* If others have reported the issue commit log SHOULD use Reported-by: and Tested-by: tags. | * If others have reported the issue commit log SHOULD use Reported-by: and Tested-by: tags. | ||
* SHOULD be checkpatch clean: | * SHOULD be checkpatch clean: | ||
- | * * FIXME: add checkpatch example with correct arguments | + | * FIXME: add checkpatch example with correct arguments |
* Patches SHOULD be sent with git send-email tool. | * Patches SHOULD be sent with git send-email tool. | ||
* Patchsets SHOULD contain no more than 12 patches. | * Patchsets SHOULD contain no more than 12 patches. | ||
Line 57: | Line 58: | ||
The ath10k patch flow is this: | The ath10k patch flow is this: | ||
- | * - Patch gets posted to the mailing lists. | + | * Patch gets posted to the mailing lists. |
- | * - Kalle immediately applies the patch to ath-next-test for build testing. | + | * Kalle immediately applies the patch to pending branch for build testing. |
- | * - Kalle waits two business days for patch being under review (unless the patch is urgent). | + | * Kalle waits two business days for patch being under review (unless the patch is urgent). |
- | * - If no comments or warnings, Kalle applies the patch to ath-next branch and sends a "Thanks, applied" reply. | + | * If no comments or warnings, Kalle applies the patch to ath-next branch and sends a "Thanks, applied" reply. |
- | * - Kalle merges ath-next to master branch immeadiately after the patch is applies. | + | * Kalle merges ath-next to master branch immeadiately after the patch is applies. |
- | * - John Linville merges ath-next into wireless-next roughly once a week | + | * Kalle merges ath-next into wireless-drivers-next roughly every 2-3 weeks |
- | * - David Miller merges wireless-next into net-next every two weeks or so | + | * David Miller merges wireless-drivers-next into net-next every two weeks or so |
- | * - Linus Torvalds merges net-next into linux.git during [[https://www.kernel.org/doc/Documentation/development-process/2.Process|merge window]] | + | * Linus Torvalds merges net-next into linux.git during [[https://www.kernel.org/doc/Documentation/development-process/2.Process|merge window]] |
Line 71: | Line 72: | ||
ath.git contains multiple branches: | ath.git contains multiple branches: | ||
- | ; master : The default branch selected when cloning the tree. Everyone working on ath10k (or ath6kl) should use this branch. Follows John Linville's wireless-testing tree and contains the latest -rc release from Linus Torvalds + latest wireless code from John + latest ath10k/ath6kl code from ath-next branch. Usually the branch is rebased after a merge window (after -rc1 is released). Due to unclean history bisect might not work, better to use ath-next for bisecting. | + | * master : The default branch selected when cloning the tree. Everyone working on ath10k (or ath6kl) should use this branch. Follows John Linville's wireless-testing tree and contains the latest -rc release from Linus Torvalds + latest wireless code from John + latest ath10k/ath6kl code from ath-next branch. Usually the branch is rebased after a merge window (after -rc1 is released). Due to unclean history bisect might not work, better to use ath-next for bisecting. |
- | ; ath-next : Based on John's wireless-next tree and John will pull from this branch. ath6kl/ath10k patches are commited to this branch first and then merged to the master branch. For bisect runs it's better to use this branch instead of the master branch. | + | * ath-next : Based on John's wireless-next tree and John will pull from this branch. ath6kl/ath10k patches are commited to this branch first and then merged to the master branch. For bisect runs it's better to use this branch instead of the master branch. |
- | ; ath-next-test : Used for building and runtime testing patches under review. Is rebased almost daily and hence commit ids are NOT stable. Use this only if you know what you are doing. | + | * pending : Used for building and runtime testing patches under review. Is rebased almost daily and hence commit ids are NOT stable. Use this only if you know what you are doing. |