summaryrefslogtreecommitdiffstats
path: root/development.txt
blob: a13cac78330f4e3bef593f09f661a3b67f66ebe7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
---
---
Development
===========

== The Source Code

The LEDE project source code starts off with OpenWrt revision r49258. The code
is stored inside a git tree which contains all branches and releases ever made
by OpenWrt. While importing the sources the tree was normalised and some
minor tweaks were made to committer names and mail addresses.

All repositories can be browsed online through
http://git.lede-project.org/[Gitweb] as well.

=== Getting The _LEDE_ Code

Any _LEDE_ development happens in the main +source.git+ repository which is
accessible via both HTTP and HTTPS:

----
git clone http://git.lede-project.org/source.git
----

You can find a mirror of the repository on Github:

----
git clone https://github.com/lede-project/source.git
----

=== Getting the OpenWrt Code

We keep the original OpenWrt source code up to
https://git.lede-project.org/?p=openwrt/source.git;a=commit;h=ee53a240ac902dc83209008a2671e7fdcf55957a[r49258]
available, mostly as reference and for historic interest.

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 http://git.lede-project.org/openwrt/source.git
git clone http://git.lede-project.org/openwrt/packages.git
git clone http://git.lede-project.org/openwrt/feeds.git
git clone http://git.lede-project.org/openwrt/docs.git
----

=== The Web Presence

The pages you're reading are generated from text files using the
http://www.methods.co.nz/asciidoc/[AsciiDoc] suite. Any changes made to the
projects web site will be reflected in our +web.git+ repository:

----
git clone http://git.lede-project.org/web.git
----

=== Submitting Patches

The biggest difference is that we now accept pull requests. The tree that shall
be pulled from needs to be hosted publicly. Small fixes and minor patches can
also be submitted via the
http://lists.infradead.org/mailman/listinfo/lede-dev[development mailing list].
Submissions should follow these rules

. TBD

All patches need to be sent in a format that they are listed in http://patchwork.ozlabs.org/project/lede/list/[patchwork].
If the patch does not get listed in patchwork then it won't get processed.


=== Reporting Bugs

. Please report your bugs using our http://bugs.lede-project.org/[issue tracker]
. When reporting bugs please make sure to
  .. Name the tree/revision
  .. 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
. Reporting a bug means that you reported a bug. It does not constitute a claim that
  anyone has to work on fixing it.
. Pointless/vague/silly/... bugs reports will be ignored
. The better your bug report, the more likely it is that it will be worked on.


=== Patch Merging And Tree Life Cycle

We encourage committers to host their own staging trees where they aggregate patches
that they feel responsible for and/or ones that they created themselves. Once the tree
has been reviewed and tested it can be proposed for inclusion in the master branch.

. Trees will be merged into master at any time
. Bug fixes can be merged into master directly
. PRs can be sent to the patches mailing list from any source and will always be considered
  for inclusion if the quality of the tree is good and format of submission is correct
. Staging trees can be hosted as part of the projects git infrastucture, private servers, ...

=== Kernel updates

It has proven impractical and a time killer to always be on the very latest kernel within
2 days of its release. It has caused these issues.

. diversification of kernel versions
. pressure on maintainers to constantly upgrade rather than stabilise
. huge effort invested to upgrade 3-4 times between releases
. huge workload to maintain kmod-* packaging
. 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.

There should be a max of three concurrent kernel version. 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.


=== Releases

Generating Releases has already been vastly automated. 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/profile/device. 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

. Happen at least once a year
. Have at least one maintenance update
. Provide CVE/critical/... fixes for at least one year after the release
. Only include maintained targets
. Only include targets that have seen on device testing
. Be ready when they are ready

See the TODO page for more info.