Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
| docs:guide-developer:the-source-code [2017/03/05 19:24] – move submission guidelines to its own page bobafetthotmail | docs:guide-developer:source-code:start [2021/08/01 19:14] (current) – formatting vgaetera | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== The LEDE Source Code ====== | + | ====== The OpenWrt source code ====== |
| + | See also: [[docs: | ||
| - | The LEDE project source | + | The OpenWrt |
| All repositories can be browsed online through: | All repositories can be browsed online through: | ||
| + | - [[https:// | ||
| + | - [[https:// | ||
| - | - [[https:// | + | ===== OpenWrt source code repositories ===== |
| - | - [[https:// | + | Any OpenWrt development happens in the main Git repository |
| - | + | < | |
| - | ===== LEDE Source Code Repositories ===== | + | git clone https:// |
| - | + | ||
| - | Any //LEDE// development happens in the main '' | + | |
| - | + | ||
| - | < | + | |
| - | git clone https:// | + | |
| </ | </ | ||
| - | You can find a mirror of the repository on Github: | + | You can find a mirror of the repository on GitHub: |
| - | < | + | < |
| - | git clone https:// | + | git clone https:// |
| </ | </ | ||
| ==== General source structure ==== | ==== General source structure ==== | ||
| - | |||
| These are the folders you can find in the project’s git: | These are the folders you can find in the project’s git: | ||
| - | |||
| * **/config** : configuration files for menuconfig | * **/config** : configuration files for menuconfig | ||
| * **/ | * **/ | ||
| Line 36: | Line 32: | ||
| ===== Releases ===== | ===== Releases ===== | ||
| - | + | Generating | |
| - | Generating | + | The remaining parts of the process need to also be automated before the first LEDE release. |
| + | We will introduce a TESTERS file that is formatted similarly to the MAINTAINERS file of the kernel. | ||
| + | Community members can list themselves as testers for a target/ | ||
| + | Once a release has been generated testers should receive an email informing them of the requirement for images to be tested. | ||
| + | It needs to be decided if only tested images should be included in the binary release. | ||
| Releases should: | Releases should: | ||
| - | |||
| - Happen at least once a year | - Happen at least once a year | ||
| - Have at least one maintenance update | - Have at least one maintenance update | ||
| Line 50: | Line 49: | ||
| See the TODO page for more info. | See the TODO page for more info. | ||
| - | ===== Staging | + | ===== Staging |
| + | To create yourself a staging tree on git.openwrt.org (does not apply to regular users): | ||
| - | To create yourself a staging tree on git.lede-project.org: | + | < |
| - | + | ssh git@git.openwrt.org " | |
| - | < | + | ssh git@git.openwrt.org " |
| - | ssh <git@git.lede-project.org> " | + | |
| - | ssh <git@git.lede-project.org> " | + | |
| </ | </ | ||
| - | To get your staging tree visible at https:// | + | To get your staging tree visible at https:// |
| - | < | + | < |
| - | ssh <git@git.lede-project.org> " | + | ssh git@git.openwrt.org " |
| </ | </ | ||
| To get your staging tree read accessible to everyone: | To get your staging tree read accessible to everyone: | ||
| - | < | + | < |
| - | ssh <git@git.lede-project.org> " | + | ssh git@git.openwrt.org " |
| </ | </ | ||
| ==== Kernel updates ==== | ==== Kernel updates ==== | ||
| - | + | It has proven impractical and a waste of time to always be on the very latest kernel within 2 days of its release. | |
| - | It has proven impractical and a time killer | + | It has caused |
| - diversification of kernel versions | - diversification of kernel versions | ||
| - pressure on maintainers to constantly upgrade rather than stabilize | - pressure on maintainers to constantly upgrade rather than stabilize | ||
| Line 81: | Line 78: | ||
| - Upgrade to kernels that might not be fully tested | - Upgrade to kernels that might not be fully tested | ||
| - | This is obviously not an invite to sit on ancient and dusty kernels. A sane path in between should be taken that give the community recent kernels without causing unnecessary workload and stability issues. | + | Obviously, this doesn' |
| + | A balanced | ||
| - | There should be a max of three concurrent kernel | + | There should be a max of three concurrent kernel |
| - | + | Having only two concurrent versions is better than three. | |
| - | In Short - stability should be valued higher than bleeding edge, although bleeding edge is also important, but not as a trade-off to stability. | + | |
| - | + | ||
| - | ===== Reporting Bugs ===== | + | |
| - | Please note: reporting a bug is important as it raises awareness of an issue, but it does not constitute a claim that anyone has to work on fixing it. | + | |
| - | + | ||
| - | Please report your bugs using our [[https:// | + | |
| - | When reporting bugs please make sure to: | + | |
| - | + | ||
| - | * Name the tree/ | + | |
| - | * Name the affected device | + | |
| - | * What does it do that it should not do / what does it not do that it should do | + | |
| - | * Steps to reproduce | + | |
| - | * What you have already done to fix the problem | + | |
| - | * Any additional info you thinks is important | + | |
| - | + | ||
| - | Remember, the better is your bug report, the more likely it is that it will be worked on. | + | |
| - | + | ||
| - | ===== Adding a New Device ===== | + | |
| - | + | ||
| - | **[[docs: | + | |
| - | + | ||
| - | ===== OpenWrt Source Code ===== | + | |
| - | + | ||
| - | We keep the original OpenWrt source code up to [[https:// | + | |
| - | + | ||
| - | The original OpenWrt Subversion repository has been split up into several Git repositories mapping the various SVN directories and tags to proper Git branches. | + | |
| - | + | ||
| - | < | + | |
| - | git clone https:// | + | |
| - | git clone https:// | + | |
| - | git clone https:// | + | |
| - | git clone https:// | + | |
| - | </ | + | |
| + | In short, stability should be valued higher than bleeding edge. | ||
| + | Bleeding edge is important, but not as a trade-off to stability. | ||