Project

General

Profile

DeveloperGuide » History » Version 59

Wolfgang Wiedmeyer, 05/01/2017 01:39 PM
link to tasks page

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 52 Wolfgang Wiedmeyer
* Git skills (basically, how to commit changes, send them to our repos, dealing with branches without making a mess, etc)
11 53 Wolfgang Wiedmeyer
  You can find some documentation about Git at: https://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 59 Wolfgang Wiedmeyer
The [[Index#Replicant-porting-guides|porting guides]] provide instructions for porting a new device to Replicant.
20
21
Have a look at the [[Tasks]] page and feel free to [[Index#Contact|ask around]] for help to get started.
22 50 Wolfgang Wiedmeyer
23 40 Wolfgang Wiedmeyer
h2. Code hosting and submitting patches
24
25 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.
26 40 Wolfgang Wiedmeyer
27 53 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":/projects/replicant/issues and attach the patches to the issue. Replicant developers will then review your changes.
28 40 Wolfgang Wiedmeyer
29
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.
30 3 Paul Kocialkowski
31 1 Paul Kocialkowski
h2. Repositories
32
33
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.
34
It is better to create separate branches (that are not used by the official manifest branches) when your work is still in progress.
35
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.
36
37
h3. When creating a repository
38
39
In order to keep repo naming consistent, please name repositories by their name on the tree, replacing the @/@ by @_@.
40 43 Wolfgang Wiedmeyer
For instance, when forking the LineageOS repo: @android_device_samsung_crespo@, rename it to @device_samsung_crespo@ on the Replicant repos.
41 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 @_@.
42
43
h3. When creating a branch
44
45 43 Wolfgang Wiedmeyer
Official Replicant branches are named the following way:
46 1 Paul Kocialkowski
* The @replicant-@ prefix
47
* The Replicant version
48
49
Such as: @replicant-2.3@ This should be used on the projects repositories as well as the manifest repository.
50
Any other branch should be considered as Work In Progress (WIP) and thus not be part of any official branch of the manifest.
51
52
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.
53 2 Paul Kocialkowski
54
h2. Upstreaming work
55
56
It is generally a good idea to send some changes back to upstream, assuming that they will benefit from it as well.
57
58
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.
59
Contact the interested developers on the upstream projects before attempting to send your replacement.
60
61 39 Wolfgang Wiedmeyer
h3. LineageOS
62 2 Paul Kocialkowski
63 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
64 3 Paul Kocialkowski
65 39 Wolfgang Wiedmeyer
You can also push directly using git using the following scheme (untested):
66 11 Paul Kocialkowski
<pre>
67 39 Wolfgang Wiedmeyer
git push ssh://<sshusername>@review.lineageos.org:29418/LineageOS/<projectname> HEAD:refs/for/<branchname>
68 11 Paul Kocialkowski
</pre>
69
70 25 Paul Kocialkowski
h3. AOSP
71
72 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
73 25 Paul Kocialkowski
74
You can push to AOSP's review using:
75
<pre>
76
git push https://android-review.googlesource.com/platform/system/core HEAD:refs/for/master
77
</pre>
78
79 3 Paul Kocialkowski
h2. Writing free software replacements
80
81
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):
82 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.
83 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!*)
84 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.
85
* Run the program in @strace@ and analyze the trace to understand what the program does.
86 1 Paul Kocialkowski
* Add verbose debug prints in the concerned kernel driver (with @printk@ and show them via the @dmesg@ tool).
87 6 Paul Kocialkowski
* Read the corresponding kernel driver: you can sometimes learn a lot by reading comments or headers.
88 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).
89
* 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.
90 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!
91 4 Paul Kocialkowski
92 14 Paul Kocialkowski
h2. Wiki guidelines
93
94 34 Paul Kocialkowski
In order the keep the wiki simple and consistent, a few guidelines must be followed when editing.
95 1 Paul Kocialkowski
96 34 Paul Kocialkowski
Regarding the content:
97
* 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.
98
* The content on each page should *only* be relevant to the latest Replicant version: make sure to update the content with newer Replicant versions.
99
* Substantial changes must be discussed before modifying the wiki.
100 49 Wolfgang Wiedmeyer
* A comment should be added in the comment field at the bottom that shortly describes the change.
101 53 Wolfgang Wiedmeyer
* Make use of the wiki formatting possibilities: "quick reference":/help/wiki_syntax.html and "detailed syntax overview":/help/wiki_syntax_detailed.html
102 49 Wolfgang Wiedmeyer
  By using @[[Index]]@, it's possible to link to the start page of the wiki.
103 34 Paul Kocialkowski
104
Regarding the writing style:
105
* Every page in the wiki has to be written in correct English, we do not aim to provide information in any other language.
106 49 Wolfgang Wiedmeyer
* Addressing readers directly should be avoided when possible: Instead, what is described should always be the subject of sentences.
107 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]]).
108 34 Paul Kocialkowski
109
Regarding the naming of pages:
110
* Pages must be named in a consistent manner ([[NexusSI902xFirmwares]] is not to be called [[FirmwaresOnTheI902xNexusS]]).
111
* Common prefixes and suffixes should be used for naming new pages ([[BuildDependenciesInstallation]] is not to be called [[InstallationOfBuildDependencies]]).
112 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]]).
113 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]]).
114
* 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.
115 34 Paul Kocialkowski
116
Regarding the naming of devices:
117
* Devices should be named after their model number and codename, without mention of the manufacturer.
118
* 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@).
119 14 Paul Kocialkowski
120 16 Paul Kocialkowski
h2. Commonly-used terminology
121
122
In order to keep everything clear and consistent, we use the following terms with a precise meaning in mind:
123
* *Driver*: Software that is part of the *kernel* (builtin or as a module) and deals with communicating with the hardware
124
* *Hardware Abstraction Layer (HAL)*: Software that runs in *user-space* and deals with communicating with the hardware (usually through a kernel driver)
125
* *module*: Android HALs are also often called modules, so we may referrer to e.g. the @audio HAL@ as the @audio module@
126
* *blob*: Proprietary HAL
127 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)
128 16 Paul Kocialkowski
129 33 Paul Kocialkowski
h2. New images release
130 1 Paul Kocialkowski
131 33 Paul Kocialkowski
# Modify the changelog in the vendor files:
132
<pre>
133 54 Wolfgang Wiedmeyer
cd path/to/replicant-6.0/vendor/replicant
134 33 Paul Kocialkowski
edit CHANGELOG.mkdn
135
git add CHANGELOG.mkdn
136 54 Wolfgang Wiedmeyer
git commit -sS -m "Replicant 6.0 0001 images release"
137
git push git@git.replicant.us:replicant/vendor_replicant.git replicant-6.0
138 33 Paul Kocialkowski
</pre>
139 58 Wolfgang Wiedmeyer
# Increment the release in the "release scripts":https://git.replicant.us/replicant/release-scripts (and the AOSP release tag if necessary):
140 33 Paul Kocialkowski
<pre>
141
cd path/to/release-scripts
142 58 Wolfgang Wiedmeyer
edit releasevars.sh
143
git add releasevars.sh
144 1 Paul Kocialkowski
git commit -sS -m "Replicant 6.0 0001 images release"
145
git push git@git.replicant.us:replicant/release-scripts.git replicant-6.0
146 58 Wolfgang Wiedmeyer
</pre>
147
# In the manifest repo, merge the replicant-6.0-dev branch into the replicant-6.0 branch and increment the release in the manifest:
148
<pre>
149
cd path/to/manifest
150
git checkout replicant-6.0
151
git merge replicant-6.0-dev
152
edit default.xml
153
git add default.xml
154
git commit -sS -m "Replicant 6.0 0001 images release"
155
git push git@git.replicant.us:replicant/manifest.git replicant-6.0
156 33 Paul Kocialkowski
</pre>
157
# Tag all the repositories with the release tag script:
158
<pre>
159 54 Wolfgang Wiedmeyer
path/to/release-scripts/releasetag.sh path/to/replicant-6.0
160 33 Paul Kocialkowski
</pre>
161
# Tag the manifest:
162
<pre>
163
cd path/to/manifest
164 54 Wolfgang Wiedmeyer
git tag -u 16D1FEEE4A80EB23 -s replicant-6.0-0001 -m "Replicant 6.0 0001 images release"
165 33 Paul Kocialkowski
git push git@git.replicant.us:replicant/manifest.git replicant-6.0-0001
166 1 Paul Kocialkowski
</pre>
167 56 Wolfgang Wiedmeyer
# Update prebuilts and start the build (in a newly opened shell with the Replicant keys and certificates installed):
168
<pre>
169
path/to/release-scripts/releasebuild.sh path/to/replicant-6.0
170
</pre>
171 33 Paul Kocialkowski
# Release the images with the release script:
172
<pre>
173 55 Wolfgang Wiedmeyer
rm -rf path/to/images/replicant-6.0/0001
174 54 Wolfgang Wiedmeyer
mkdir -p path/to/images/replicant-6.0/0001
175
path/to/release-scripts/release.sh path/to/replicant-6.0 path/to/images/replicant-6.0/0001
176 1 Paul Kocialkowski
</pre>
177 33 Paul Kocialkowski
# Sign the binaries with the release script:
178
<pre>
179 54 Wolfgang Wiedmeyer
path/to/release-scripts/release.sh path/to/replicant-6.0 path/to/images/replicant-6.0/0001 signatures
180 1 Paul Kocialkowski
</pre>
181 33 Paul Kocialkowski
# Compress the release files
182
<pre>
183 54 Wolfgang Wiedmeyer
cd path/to/images/replicant-6.0
184
tar -cjf 0001.tar.bz2 0001
185 1 Paul Kocialkowski
</pre>
186 33 Paul Kocialkowski
# Upload the release to OSUOSL:
187
<pre>
188 54 Wolfgang Wiedmeyer
scp 0001.tar.bz2 replicant@ftp-osl.osuosl.org:/home/replicant/data/images/replicant-6.0/
189 1 Paul Kocialkowski
</pre>
190 33 Paul Kocialkowski
# Unpack the release on OSUOSL, ensure permissions are correct
191
# Update [[ReplicantImages]] with the release
192
# Update each device's page with the release
193
# Update [[ReplicantStatus]] with the latest status
194
# Announce the release on the blog
195
# Update the release on the website and IRC topic
196 5 Paul Kocialkowski
197 33 Paul Kocialkowski
h2. New device documentation
198 22 Paul Kocialkowski
199 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]])
200 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]])
201 5 Paul Kocialkowski
3. Link the sub-pages to the main page in the index
202
4. Update the [[ReplicantStatus]] page of the wiki with the current status of the device
203 47 Wolfgang Wiedmeyer
5. Modify the [[Index]] page of the wiki and add the new device in the following sections:
204
* [[Index#Replicant-status|Replicant status]]
205
* [[Index#Replicant-installation|Replicant installation]]
206
* [[Index#Replicant-build|Replicant build]]
207
* [[Index#Supported-devices|Supported devices]]
208 24 Paul Kocialkowski
209 43 Wolfgang Wiedmeyer
6. Add new issues categories to the Replicant project Redmine