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 https://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 https://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 https://git.lede-project.org/openwrt/source.git
  43 git clone https://git.lede-project.org/openwrt/packages.git
  44 git clone https://git.lede-project.org/openwrt/feeds.git
  45 git clone https://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 https://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 https://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 https://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 === Staging Trees
  73
  74 To create yourself a staging tree on git.lede-project.org:
  75 ----
  76 ssh git@git.lede-project.org "create lede/yournick/staging"
  77 ssh git@git.lede-project.org "desc lede/yournick/staging Staging tree of Your Name"
  78 ----
  79
  80
  81 === Reporting Bugs
  82
  83 . Please report your bugs using our https://bugs.lede-project.org/[issue tracker]
  84 . When reporting bugs please make sure to
  85   .. Name the tree/revision
  86   .. Name the affected device
  87   .. What does it do that it should not do / what does it not do that it should do
  88   .. Steps to reproduce
  89   .. What you have already done to fix the problem
  90   .. Any additional info you thinks is important
  91 . Reporting a bug means that you reported a bug. It does not constitute a claim that
  92   anyone has to work on fixing it.
  93 . Pointless/vague/silly/... bugs reports will be ignored
  94 . The better your bug report, the more likely it is that it will be worked on.
  95
  96
  97 === Patch Merging And Tree Life Cycle
  98
  99 We encourage committers to host their own staging trees where they aggregate patches
 100 that they feel responsible for and/or ones that they created themselves. Once the tree
 101 has been reviewed and tested it can be proposed for inclusion in the master branch.
 102
 103 . Trees will be merged into master at any time
 104 . Bug fixes can be merged into master directly
 105 . PRs can be sent to the patches mailing list from any source and will always be considered
 106   for inclusion if the quality of the tree is good and format of submission is correct
 107 . Staging trees can be hosted as part of the projects git infrastucture, private servers, ...
 108
 109 === Kernel updates
 110
 111 It has proven impractical and a time killer to always be on the very latest kernel within
 112 2 days of its release. It has caused these issues.
 113
 114 . diversification of kernel versions
 115 . pressure on maintainers to constantly upgrade rather than stabilise
 116 . huge effort invested to upgrade 3-4 times between releases
 117 . huge workload to maintain kmod-* packaging
 118 . Upgrade to kernels that might not be fully tested
 119
 120 This is obviously not an invite to sit on ancient and dusty kernels. A sane path in between
 121 should be taken that give the community recent kernels without causing unnecessary workload
 122 and stability issues.
 123
 124 There should be a max of three concurrent kernel version. Having only two concurrent versions
 125 is better than three.
 126
 127 In Short - stability should be valued higher than bleeding edge, although bleeding edge is
 128 also important, but not as a trade-off to stability.
 129
 130
 131 === Releases
 132
 133 Generating Releases has already been vastly automated. The remaining parts of the process need
 134 to also be automated before the first _LEDE_ release. We will introduce a TESTERS file that is
 135 formatted similarly to the MAINTAINERS file of the kernel. Community members can list themselves
 136 as testers for a target/profile/device. Once a release has been generated testers should receive
 137 an email informing them of the requirement for images to be tested. It needs to be decided if only
 138 tested images should be included in the binary release.
 139
 140 Releases should
 141
 142 . Happen at least once a year
 143 . Have at least one maintenance update
 144 . Provide CVE/critical/... fixes for at least one year after the release
 145 . Only include maintained targets
 146 . Only include targets that have seen on device testing
 147 . Be ready when they are ready
 148
 149 See the TODO page for more info.