development.txt

   1 ---
   2 ---
   3 Development
   4 ===========
   5
   6 == The Source Code
   7
   8 The LEDE project source code starts off with OpenWrt revision r49258. The code
   9 is stored inside a git tree which contains all branches and releases ever made
  10 by OpenWrt. While importing the sources the tree was normalised and some
  11 minor tweaks were made to committer names and mail addresses.
  12
  13 All repositories can be browsed online through
  14 http://git.lede-project.org/[Gitweb] as well.
  15
  16 === Getting The _LEDE_ Code
  17
  18 Any _LEDE_ development happens in the main +source.git+ repository which is
  19 accessible via both HTTP and HTTPS:
  20
  21 ----
  22 git clone http://git.lede-project.org/source.git
  23 ----
  24
  25 You can find a mirror of the repository on Github:
  26
  27 ----
  28 git clone https://github.com/lede-project/source.git
  29 ----
  30
  31 === Getting the OpenWrt Code
  32
  33 We keep the original OpenWrt source code up to
  34 https://git.lede-project.org/?p=openwrt/source.git;a=commit;h=ee53a240ac902dc83209008a2671e7fdcf55957a[r49258]
  35 available, mostly as reference and for historic interest.
  36
  37 The original OpenWrt Subversion repository has been split up into several Git
  38 repositories mapping the various SVN directories and tags to proper Git
  39 branches.
  40
  41 ----
  42 git clone http://git.lede-project.org/openwrt/source.git
  43 git clone http://git.lede-project.org/openwrt/packages.git
  44 git clone http://git.lede-project.org/openwrt/feeds.git
  45 git clone http://git.lede-project.org/openwrt/docs.git
  46 ----
  47
  48 === The Web Presence
  49
  50 The pages you're reading are generated from text files using the
  51 http://www.methods.co.nz/asciidoc/[AsciiDoc] suite. Any changes made to the
  52 projects web site will be reflected in our +web.git+ repository:
  53
  54 ----
  55 git clone http://git.lede-project.org/web.git
  56 ----
  57
  58 === Submitting Patches
  59
  60 The biggest difference is that we now accept pull requests. The tree that shall
  61 be pulled from needs to be hosted publicly. Small fixes and minor patches can
  62 also be submitted via the
  63 http://lists.infradead.org/mailman/listinfo/lede-dev[development mailing list].
  64 Submissions should follow these rules
  65
  66 . TBD
  67
  68 All patches need to be sent in a format that they are listed in http://patchwork.ozlabs.org/project/lede/list/[patchwork].
  69 If the patch does not get listed in patchwork then it won't get processed.
  70
  71
  72 === Reporting Bugs
  73
  74 . *All* bug reports need to be submitted via the
  75   http://lists.infradead.org/mailman/listinfo/lede-dev[development mailing list]
  76 . When reporting bugs please make sure to
  77   .. Name the tree/revision
  78   .. Name the affected device
  79   .. What does it do that it should not do / what does it not do that it should do
  80   .. Steps to reproduce
  81   .. What you have already done to fix the problem
  82   .. Any additional info you thinks is important
  83 . Reporting a bug means that you reported a bug. It does not constitute a claim that
  84   anyone has to work on fixing it.
  85 . Pointless/vague/silly/... bugs reports will be ignored
  86 . Feature requests are not Bugs. They will also be ignored.
  87 . The better your bug report, the more likely it is that it will be worked on.
  88
  89 All bug reports need to be sent in a format so that they are listed in the issue
  90 tracker (__LINK__). If the bug report does not get listed in the issue tracker then
  91 it won't get processed.
  92
  93
  94 === Patch Merging And Tree Life Cycle
  95
  96 We encourage committers to host their own staging trees where they aggregate patches
  97 that they feel responsible for and/or ones that they created themselves. Once the tree
  98 has been reviewed and tested it can be proposed for inclusion in the master branch.
  99
 100 . Trees will be merged into master at any time
 101 . Bug fixes can be merged into master directly
 102 . PRs can be sent to the patches mailing list from any source and will always be considered
 103   for inclusion if the quality of the tree is good and format of submission is correct
 104 . Staging trees can be hosted as part of the projects git infrastucture, private servers, ...
 105
 106 === Kernel updates
 107
 108 It has proven impractical and a time killer to always be on the very latest kernel within
 109 2 days of its release. It has caused these issues.
 110
 111 . diversification of kernel versions
 112 . pressure on maintainers to constantly upgrade rather than stabilise
 113 . huge effort invested to upgrade 3-4 times between releases
 114 . huge workload to maintain kmod-* packaging
 115 . Upgrade to kernels that might not be fully tested
 116
 117 This is obviously not an invite to sit on ancient and dusty kernels. A sane path in between
 118 should be taken that give the community recent kernels without causing unnecessary workload
 119 and stability issues.
 120
 121 There should be a max of three concurrent kernel version. Having only two concurrent versions
 122 is better than three.
 123
 124 In Short - stability should be valued higher than bleeding edge, although bleeding edge is
 125 also important, but not as a trade-off to stability.
 126
 127
 128 === Releases
 129
 130 Generating Releases has already been vastly automated. The remaining parts of the process need
 131 to also be automated before the first _LEDE_ release. We will introduce a TESTERS file that is
 132 formatted similarly to the MAINTAINERS file of the kernel. Community members can list themselves
 133 as testers for a target/profile/device. Once a release has been generated testers should receive
 134 an email informing them of the requirement for images to be tested. It needs to be decided if only
 135 tested images should be included in the binary release.
 136
 137 Releases should
 138
 139 . Happen at least once a year
 140 . Have at least one maintenance update
 141 . Provide CVE/critical/... fixes for at least one year after the release
 142 . Only include maintained targets
 143 . Only include targets that have seen on device testing
 144 . Be ready when they are ready
 145
 146 See the TODO page for more info.