Project

General

Profile

DeveloperGuide » History » Version 45

Wolfgang Wiedmeyer, 03/31/2017 05:43 PM
https link for mailing list

1 31 Paul Kocialkowski
h1. Developer guide
2 1 Paul Kocialkowski
3 15 Paul Kocialkowski
{{>toc}}
4
5 3 Paul Kocialkowski
h2. Prerequisites
6
7 8 Paul Kocialkowski
Developing on Replicant isn't much harder than developing on any other free software project as it doesn't require specific knowledge. In fact, you'll probably learn a lot along the way regarding how hardware works, how the Android system is composed, how the kernel works, etc, but you don't need to know all of this to start. However a basic set of skills is required, among which:
8 3 Paul Kocialkowski
* C language programming skills and the ability to understand other languages such as C++ and Java
9
* Makefile skills (no need to know every detail about it, a general idea of how Makefiles work is enough)
10
* git skills (basically, how to commit changes, send them to our repos, dealing with branches without making a mess, etc)
11 40 Wolfgang Wiedmeyer
  You can find some documentation about Git at: http://git-scm.com/documentation
12 3 Paul Kocialkowski
13
If you think you can cope with the requirements, then developing on Replicant should cause you no particular issue.
14
15 26 Paul Kocialkowski
h3. Notes on writing free software replacements
16 3 Paul Kocialkowski
17 1 Paul Kocialkowski
Writing free software replacements for non-free components may require more skills depending on what you're trying to achieve, though there may be people with the adequate knowledge to help you and from whom you will likely learn a lot.
18 40 Wolfgang Wiedmeyer
19
h2. Code hosting and submitting patches
20
21 44 Wolfgang Wiedmeyer
Replicant's source code is hosted at "git.replicant.us":https://git.replicant.us/replicant. If you plan to regularly contribute to Replicant and if you don't yet have a code hosting provider that satisfies your needs, you are welcome to host your Replicant-related projects there under your own username, You only need to [[People#Active-developers|contact one of Replicant's developers]] and ask for an account. Please include in your request the name, username and Email address that should be used for creating your account.
22 40 Wolfgang Wiedmeyer
23 45 Wolfgang Wiedmeyer
Replicant currently doesn't accept merge requests. There are two ways to get your patches included: You can either send them to the "mailing list":https://lists.osuosl.org/mailman/listinfo/replicant or open an issue on the "issue tracker":http://redmine.replicant.us/projects/replicant/issues and attach the patches to the issue. Replicant developers will then review your changes.
24 40 Wolfgang Wiedmeyer
25
See the Git documentation for "creating a patch":https://git-scm.com/docs/git-format-patch. Patches can be send with "@git send-email@":https://git-scm.com/docs/git-send-email. If it's too much hassle for you to set up @git send-email@, sending the patches with your favorite mail client should be fine, too.
26 3 Paul Kocialkowski
27 1 Paul Kocialkowski
h2. Repositories
28
29
When working with Replicant repos, make sure to avoid breaking things. For instance, if you push a commit introducing a compilation error, it will break the whole build process.
30
It is better to create separate branches (that are not used by the official manifest branches) when your work is still in progress.
31
Creating branches that add debug infos on a particular topic is usually a good idea since it will save you time next time you want to debug the same component.
32
33
h3. When creating a repository
34
35
In order to keep repo naming consistent, please name repositories by their name on the tree, replacing the @/@ by @_@.
36 43 Wolfgang Wiedmeyer
For instance, when forking the LineageOS repo: @android_device_samsung_crespo@, rename it to @device_samsung_crespo@ on the Replicant repos.
37 1 Paul Kocialkowski
This creates a more consistent way of naming repositories and makes it easier when pushing: just look at the location in the source tree and replace @/@ by @_@.
38
39
h3. When creating a branch
40
41 43 Wolfgang Wiedmeyer
Official Replicant branches are named the following way:
42 1 Paul Kocialkowski
* The @replicant-@ prefix
43
* The Replicant version
44
45
Such as: @replicant-2.3@ This should be used on the projects repositories as well as the manifest repository.
46
Any other branch should be considered as Work In Progress (WIP) and thus not be part of any official branch of the manifest.
47
48
There is although one exception, with the @master@ branch, that can be used by any project and be in any manifest given that the code held in the @master@ branch will work on any Replicant version.
49 2 Paul Kocialkowski
50
h2. Upstreaming work
51
52
It is generally a good idea to send some changes back to upstream, assuming that they will benefit from it as well.
53
54
When it is about the replacement of a non-free component present in the upstream systems, make sure that your replacement is reliable and complete.
55
Contact the interested developers on the upstream projects before attempting to send your replacement.
56
57 39 Wolfgang Wiedmeyer
h3. LineageOS
58 2 Paul Kocialkowski
59 39 Wolfgang Wiedmeyer
The LineageOS team uses Gerrit to manage patch submissions. The process to get your patch included in LineageOS repos is explained on their wiki: "Gerrit":http://wiki.lineageos.org/usinggerrit-howto.html#submitting-to-gerrit
60 3 Paul Kocialkowski
61 39 Wolfgang Wiedmeyer
You can also push directly using git using the following scheme (untested):
62 11 Paul Kocialkowski
<pre>
63 39 Wolfgang Wiedmeyer
git push ssh://<sshusername>@review.lineageos.org:29418/LineageOS/<projectname> HEAD:refs/for/<branchname>
64 11 Paul Kocialkowski
</pre>
65
66 25 Paul Kocialkowski
h3. AOSP
67
68 43 Wolfgang Wiedmeyer
The Android Open Source Project uses Gerrit to manage patch submissions. Some information about submitting patches to AOSP is available: https://source.android.com/source/submit-patches.html
69 25 Paul Kocialkowski
70
You can push to AOSP's review using:
71
<pre>
72
git push https://android-review.googlesource.com/platform/system/core HEAD:refs/for/master
73
</pre>
74
75 3 Paul Kocialkowski
h2. Writing free software replacements
76
77
Here are some tips that may help you achieving a free software replacement for a specific component (some may be more or less relevant regarding the nature of what the component does):
78 43 Wolfgang Wiedmeyer
* Look for interested people from other projects: LineageOS people are constantly fighting with non-free blobs and are sometimes happy to help replacing one.
79 6 Paul Kocialkowski
* Use tools such as @strings@, @objdump@ and @radare2@ against the non-free binary to have a better idea of how things work. (*Make sure this is legal where you live!*)
80 3 Paul Kocialkowski
* Try to make the non-free binary as verbose as possible by enabling all the possible debug options on the config file or such.
81
* Run the program in @strace@ and analyze the trace to understand what the program does.
82 1 Paul Kocialkowski
* Add verbose debug prints in the concerned kernel driver (with @printk@ and show them via the @dmesg@ tool).
83 6 Paul Kocialkowski
* Read the corresponding kernel driver: you can sometimes learn a lot by reading comments or headers.
84 3 Paul Kocialkowski
* Collect data out of the kernel driver (via debug prints) and out of the non-free binary (via debug prints on the upper-layer).
85
* If there is a mathematical algorithm involved, force the values returned by the kernel to the non-free binary and analyze how it reacts, for instance with spreadsheet software.
86 17 Paul Kocialkowski
* If you're directly dealing with a hardware component, try to find a datasheet for the chip, it may hold precious details. In the best case, you may also be able to find a reference software implementation!
87 4 Paul Kocialkowski
88 14 Paul Kocialkowski
h2. Wiki guidelines
89
90 34 Paul Kocialkowski
In order the keep the wiki simple and consistent, a few guidelines must be followed when editing.
91 1 Paul Kocialkowski
92 34 Paul Kocialkowski
Regarding the content:
93
* Only Replicant-specific topics should be covered by the wiki: there is no point in writing usage guides for generic Android aspects, such as the user interface.
94
* The content on each page should *only* be relevant to the latest Replicant version: make sure to update the content with newer Replicant versions.
95
* Substantial changes must be discussed before modifying the wiki.
96
97
Regarding the writing style:
98
* Every page in the wiki has to be written in correct English, we do not aim to provide information in any other language.
99 43 Wolfgang Wiedmeyer
* Readers shouldn't be addressed directly: Instead, what is described should always be the subject of sentences.
100 35 Paul Kocialkowski
* Links to pages should be incorporated in text (Instructions to [[ToolsInstallation#ADB|install ADB]] shouldn't be: Instructions to install ADB: [[ToolsInstallation#ADB]]).
101 34 Paul Kocialkowski
102
Regarding the naming of pages:
103
* Pages must be named in a consistent manner ([[NexusSI902xFirmwares]] is not to be called [[FirmwaresOnTheI902xNexusS]]).
104
* Common prefixes and suffixes should be used for naming new pages ([[BuildDependenciesInstallation]] is not to be called [[InstallationOfBuildDependencies]]).
105 37 Paul Kocialkowski
* Page and section names should always be named using nouns, not verbs, either active or not ([[DeveloperGuide]] is not to be called [[DevelopingGuide]]).
106 36 Paul Kocialkowski
* Page titles shouldn't contain space or any delimiter character (such as - or_) but use upper-case characters as word delimiters ([[BuildDependenciesInstallation]] is not to be called [[Build_dependencies_installation]]).
107
* Page titles *as shown on the page* should use lower-case when upper-case is not needed, even if the page name uses upper-case as word delimiters.
108 34 Paul Kocialkowski
109
Regarding the naming of devices:
110
* Devices should be named after their model number and codename, without mention of the manufacturer.
111
* Common device naming conventions should be followed consistently (the @Galaxy S 3 (I9300)@ is not to be called @Samsung S3 GT-I9300@ or @Galaxy S III@).
112 14 Paul Kocialkowski
113 16 Paul Kocialkowski
h2. Commonly-used terminology
114
115
In order to keep everything clear and consistent, we use the following terms with a precise meaning in mind:
116
* *Driver*: Software that is part of the *kernel* (builtin or as a module) and deals with communicating with the hardware
117
* *Hardware Abstraction Layer (HAL)*: Software that runs in *user-space* and deals with communicating with the hardware (usually through a kernel driver)
118
* *module*: Android HALs are also often called modules, so we may referrer to e.g. the @audio HAL@ as the @audio module@
119
* *blob*: Proprietary HAL
120 23 Paul Kocialkowski
* *firmware*: Software that does not run on the main processor (the CPU) but rather in a separate chip (e.g. the Wi-Fi firmwares runs on the Wi-Fi chip)
121 16 Paul Kocialkowski
122 33 Paul Kocialkowski
h2. New images release
123 1 Paul Kocialkowski
124 33 Paul Kocialkowski
# Modify the changelog in the vendor files:
125
<pre>
126
cd path/to/replicant-4.2/vendor/replicant
127
edit CHANGELOG.mkdn
128
git add CHANGELOG.mkdn
129
git commit -s -m "Replicant 4.2 0004 images release"
130
git push git@git.code.paulk.fr:replicant/vendor/replicant.git HEAD:replicant-4.2
131
</pre>
132 38 Loic Dachary
# Increment the release in the "release scripts":https://git.replicant.us/replicant/release-scripts/tree/master:
133 33 Paul Kocialkowski
<pre>
134
cd path/to/release-scripts
135
edit release.sh
136
edit releasetag.sh
137
git add release.sh releasetag.sh
138
git commit -s -m "Replicant 4.2 0004 images release"
139
git push git@git.code.paulk.fr:release-scripts.git master
140
</pre>
141
# Tag all the repositories with the release tag script:
142
<pre>
143
path/to/release-scripts/releasetag.sh path/to/replicant-4.2
144
</pre>
145
# Tag the manifest:
146
<pre>
147
cd path/to/manifest
148
git tag -s -u 4A80EB23 -m "Replicant 4.2 0004 images release" -a replicant-4.2-0004 HEAD
149
git push git@git.replicant.us:manifest.git replicant-4.2-0004
150
</pre>
151
# Update prebuilts and start the build (with the Replicant keys and certificates installed)
152
# Release the images with the release script:
153
<pre>
154
mkdir -p path/to/images/replicant-4.2/0004
155
path/to/release-scripts/release.sh path/to/replicant-4.2 path/to/images/replicant-4.2/0004
156
</pre>
157
# Sign the binaries with the release script:
158
<pre>
159
path/to/release-scripts/release.sh path/to/replicant-4.2 path/to/images/replicant-4.2/0004 signatures
160
</pre>
161
# Compress the release files
162
<pre>
163
cd path/to/images/replicant-4.2
164
tar -cjf 0004.tar.bz2 0004
165
</pre>
166
# Upload the release to OSUOSL:
167
<pre>
168
scp 0004.tar.bz2 replicant@ftp-osl.osuosl.org:/home/replicant/data/images/replicant-4.2/
169
</pre>
170
# Unpack the release on OSUOSL, ensure permissions are correct
171
# Update [[ReplicantImages]] with the release
172
# Update each device's page with the release
173
# Update [[ReplicantStatus]] with the latest status
174
# Announce the release on the blog
175
# Update the release on the website and IRC topic
176 5 Paul Kocialkowski
177 33 Paul Kocialkowski
h2. New device documentation
178 22 Paul Kocialkowski
179 19 Paul Kocialkowski
1. Create the device main page, following the naming guidelines applied to other devices (e.g. the Samsung Galaxy S II GT-I9100 is called *Galaxy S 2 (I9100)* and its page is [[GalaxyS2I9100]])
180 13 Paul Kocialkowski
2. Create all the related sub-pages (build guide, install guide and firmwares list at least), following the naming guidelines applied to other devices (e.g. [[GalaxyS2I9100Build]], [[GalaxyS2I9100Installation]] and [[GalaxyS2I9100Firmwares]])
181 5 Paul Kocialkowski
3. Link the sub-pages to the main page in the index
182
4. Update the [[ReplicantStatus]] page of the wiki with the current status of the device
183
5. Modify the [[WikiStart]] page of the wiki and add the new device in the following sections:
184 43 Wolfgang Wiedmeyer
* [[WikiStart#Replicant-Status|Replicant Status]]
185 5 Paul Kocialkowski
* [[WikiStart#Installing-Replicant|Installing Replicant]]
186
* [[WikiStart#Building-Replicant|Building Replicant]]
187 7 Paul Kocialkowski
* [[WikiStart#Technical-infos-on-the-devices|Technical infos on the devices]]
188 24 Paul Kocialkowski
189 43 Wolfgang Wiedmeyer
6. Add new issues categories to the Replicant project Redmine