Project

General

Profile

DeveloperGuide » History » Version 91

Denis 'GNUtoo' Carikli, 09/06/2019 04:14 PM

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 83 Denis 'GNUtoo' Carikli
* C language programming skills and the ability to understand other languages such as C++, Java and shell scripts.
9 82 Denis 'GNUtoo' Carikli
* Makefile skills (no need to know every detail about it, a general idea of how Makefiles work is enough). If you don't know how Makefiles work, Wikipedia has "an good article on make":https://en.wikipedia.org/wiki/Make_(software)#Makefile that has some examples Makefiles.
10
* Git skills (basically, how to commit changes, send them to our repos, dealing with branches without making a mess, etc). If you don't know git yet, you can find some documentation about Git at: https://git-scm.com/documentation to learn it.
11 3 Paul Kocialkowski
12
If you think you can cope with the requirements, then developing on Replicant should cause you no particular issue.
13
14 70 Wolfgang Wiedmeyer
The [[Index#Replicant-porting-guides|porting guides]] provide instructions for porting a new device to Replicant and also offer some tips for developing on Replicant.
15 3 Paul Kocialkowski
16 70 Wolfgang Wiedmeyer
Have a look at the [[Tasks]] page and feel free to [[Index#Contact|ask around]] for help to get started.
17 40 Wolfgang Wiedmeyer
18 70 Wolfgang Wiedmeyer
h3. Notes on writing free software replacements
19 59 Wolfgang Wiedmeyer
20 70 Wolfgang Wiedmeyer
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.
21 50 Wolfgang Wiedmeyer
22 88 Denis 'GNUtoo' Carikli
h2. Code hosting
23 40 Wolfgang Wiedmeyer
24 1 Paul Kocialkowski
Replicant's source code is hosted at "git.replicant.us":https://git.replicant.us/replicant. If you plan to contribute to Replicant, you are welcome to host your Replicant-related projects there under your own username there. 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. Your repos will then show up on the "contributor repos":https://git.replicant.us/contrib page.
25 88 Denis 'GNUtoo' Carikli
26 89 Denis 'GNUtoo' Carikli
h2. Requirements for submitting patches
27 1 Paul Kocialkowski
28 89 Denis 'GNUtoo' Carikli
There are two ways to get your patches included:
29
* You can either send them directly to the "mailing list":https://lists.osuosl.org/mailman/listinfo/replicant
30
* You cal also open an issue on the "issue tracker":/projects/replicant/issues and attach the patches to the issue. At some point the patch will need to be sent to the mailing list by someone.
31 1 Paul Kocialkowski
32 89 Denis 'GNUtoo' Carikli
Replicant developers will then review your changes on the mailing list.
33
34
There are many ways to send patches to the mailing list
35
* You can simply attach the patch to a mail
36
* If you like the command line, git has a tool called "@git send-email@":https://git-scm.com/docs/git-send-email to send patches directly from it . 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.
37
* If you want to send the patch from your command line to your mail client, git's "@git imap-send@":https://git-scm.com/docs/git-imap-send can do that
38 3 Paul Kocialkowski
39 90 Denis 'GNUtoo' Carikli
h2. How to make patches
40
41
Creating and sending patches can be hard the first time. 
42
43
While there is a "recording of talk on the topic":https://video.fosdem.org/2010/maintracks/kernelpatch.xvid.avi on how to do it right, for Replicant you don't need to do it right the first time.
44
45
When you have done some modification that you want to be integrated in Replicant, if you're not confident enough with git, make a copy of the repository with the changes in some safe place.
46
47
48
We will take a real example on how to do a modification. For that we will use the Replicant website git repository.
49
50
The replicant.us website source code and content is in git. It contains the following:
51
* The "main page of the https://replicant.us website":https://replicant.us
52
* The "freedom-privacy-security-issues page":https://replicant.us/freedom-privacy-security-issues.php
53
* The "supported-devices page":https://replicant.us/supported-devices.php
54
* The "about page":https://replicant.us/about.php
55
* "A page about javascript licenses used on replicant.us":https://replicant.us/javascript.php
56
* "A page with screenshots of Replicant":https://replicant.us/screenshots.php
57
58
Let's suppose that a new Replicant 6.0 release is out but that everybody forgot to send a patch to the website and that the website has the following:
59
> Latest images: Replicant 6.0 0003. Replicant supports up to 13 different devices!
60
and that instead we want to have the following:
61
> Latest images: Replicant 6.0 0004. Replicant supports up to 13 different devices!
62
63
So the first thing to do would be to verify both on the bug tracker and on the mailing list that there isn't already a patch for that. If there isn't any we can safely go on.
64
65
To do the patch, we need to get the source code. This can be done with the following command:
66
<pre>
67
git clone https://git.replicant.us/replicant/website.git
68
</pre>
69
70
We then go into the website directory that has all the source code:
71
<pre>
72
cd website
73
</pre>
74
75
We then look where the text we want to modify is:
76
<pre>
77
git grep "Replicant 6.0 0003."
78
</pre>
79
80
It can potentially return many lines, but it will have somewhere a line that looks like this one:
81
<pre>
82
index.php:      <div class="alert alert-success" role="alert">Latest images: <strong>Replicant 6.0 0003</strong>. Replicant supports up to <strong>13</strong> different devices!</div>
83
</pre>
84
85
We can open this index.php file with a text editor and change "Replicant 6.0 0003" to "Replicant 6.0 0004".
86
87
88
We can see that git know that we modified the index.php file:
89
<pre>
90
git diff
91
</pre>
92
93
It will then have something like that:
94
<pre>
95
diff --git a/index.php b/index.php
96
index 080510a..fd6a8c9 100644
97
--- a/index.php
98
+++ b/index.php
99
@@ -2,7 +2,7 @@
100
 <?php include_once("include/autoloader.php"); ?>
101
 
102
 <div class="container" role="main">
103
-       <div class="alert alert-success" role="alert">Latest images: <strong>Replicant 6.0 0003</strong>. Replicant supports up to <strong>13</strong> different devices!</div>
104
+       <div class="alert alert-success" role="alert">Latest images: <strong>Replicant 6.0 0004</strong>. Replicant supports up to <strong>13</strong> different devices!</div>
105
        <div class="row">
106
                <div class="col-md-8">
107
                        <div class="panel panel-default">
108
</pre>
109
110
However even if git know about it, we still need to make it record the modification in what is called a commit.
111
112
A commit contains a record of what has been changed, along with an explanation of why the change was necessary.
113
114
To create a commit, the 'git commit' command can be used, however since we're going to write an explanation of why the change was necessary we will first need to tell git which text editor to use for that.
115
116
To do that you can do something like that in the command line:
117
<pre>
118
export GIT_EDITOR=your-favorite-editor
119
</pre>
120
121
For instance if you like gedit, you can do something like that to make git use gedit in the current shell:
122
<pre>
123
export GIT_EDITOR=gedit
124
</pre>
125
126
We also need to give git a valid email and a name. Both will appear in the commit.
127
128
Else git will refuse to create the commit message and will output an error that looks like this one:
129
<pre>
130
*** Please tell me who you are.
131
132
Run
133
134
  git config --global user.email "you@example.com"
135
  git config --global user.name "Your Name"
136
137
to set your account's default identity.
138
Omit --global to set the identity only in this repository.
139
</pre>
140
141
So we then need to run something like that:
142
<pre>
143
  git config --global user.email "you@example.com"
144
  git config --global user.name "Your Name"
145
</pre>
146
147
Then in the same shell you can run the following command:
148
<pre>
149
git commit -s
150
</pre>
151
152
It will then open the text editor you choose and let you write text that describes why the change was necessary.
153
154
The convention is to have a first line that is not too long which summarize why that change is needed.
155
156
Then you can write longer text to describe the change details or have more in depth argumentation of why the change is needed.
157
158
Since here Replicant releases have already been made in the past, it's very likely that similar changes have already been made before.
159
160
We will take advantage of that and look what message the previous contributor wrote.
161
162
To do that, we can open a new shell, and go in the website directory and run the 'git log' command in there:
163
<pre>
164
git log
165
</pre>
166
167
This will show many commits. You can navigate with the keyboard arrows and quit by pressing the 'q' key.
168
169
Among the many commits you can see this one:
170
<pre>
171
commit 526edccd8d688544602ae3da1c4d9c5ffdc058ca
172
Author: Denis 'GNUtoo' Carikli <GNUtoo@no-log.org>
173
Date:   Thu Dec 14 12:37:21 2017 +0100
174
175
    index: Replicant 6.0 0003 images have been released
176
    
177
    Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@no-log.org>
178
</pre>
179
180
The sumarry is this line:
181
<pre>
182
index: Replicant 6.0 0003 images have been released
183
</pre>
184
185
And it doesn't contain a more in depth explanation because it was not deemed necessary.
186
187
The line with "Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@no-log.org>" has been automatically generated by git when using '-s' in the 'git commit -s' command.
188
189
It means that you certify that you have the (legal) right to publish the patch. 
190
191
For more details on it, you can see the "Developer's Certificate of Origin" in "the Linux kernel documentation on submirting patches":https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst?h=v5.3-rc7#n418
192
193
So you can write something like "index: Replicant 6.0 0004 images have been released" to tell that the change is needed because new images have been released.
194
195
After saving and closing your text editor, git has now a new commit.
196
197
You can now generate a file from it with
198
<pre>
199
git send-email -1
200
</pre>
201
202
The easiest way is then to write an email to the mailing list and attaching the patch in it.
203
204
As Replicant has many many git repository it's also good not to forget to mention for which repository is the patch. Here the patch is for the website git repository.
205
206
An email like that would be good enough for that:
207
<pre>
208
Hi,
209
210
I've here's a patch that I attached for the website repository.
211
</pre>
212
213 81 Denis 'GNUtoo' Carikli
h2. Pushing patches
214
215
If you already have the ability to push patches into the main Replicant repositories, you still need to send your patches to the mailing list if they are to be applied on a Replicant version that is currently supported, or if they apply to the Replicant website.
216
217
You will then need to wait either for:
218
* One other developer to review the patch and add "per's":https://stallman.org/articles/genderless-pronouns.html Acknowledgement.
219
* One week if no other developer did review your patches.
220
221 71 Wolfgang Wiedmeyer
h2. Writing free software replacements
222 1 Paul Kocialkowski
223 71 Wolfgang Wiedmeyer
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):
224
* Look for interested people from other projects: LineageOS people are constantly fighting with non-free blobs and are sometimes happy to help replacing one.
225 1 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.
226 85 Denis 'GNUtoo' Carikli
* You can use @string@ to try to find out the command line debug options, list of commands, etc.
227 71 Wolfgang Wiedmeyer
* Run the program in @strace@ and analyze the trace to understand what the program does.
228
* Add verbose debug prints in the concerned kernel driver (with @printk@ and show them via the @dmesg@ tool).
229
* Read the corresponding kernel driver: you can sometimes learn a lot by reading comments or headers.
230
* Collect data out of the kernel driver (via debug prints) and out of the non-free binary (via debug prints on the upper-layer).
231
* 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.
232 1 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!
233 84 Denis 'GNUtoo' Carikli
* Make sure that the methods you use are legal where you live, and that the Replicant project is able to legally redistribute your work. In doubt, you could ask the Replicant developers in the mailing list and/or at the private contact address. The Replicant project has also access to legal advise through the FSF.
234 2 Paul Kocialkowski
235
h2. Upstreaming work
236
237 1 Paul Kocialkowski
It is generally a good idea to send some changes back to upstream, assuming that they will benefit from it as well.
238 2 Paul Kocialkowski
239 1 Paul Kocialkowski
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.
240
Contact the interested developers on the upstream projects before attempting to send your replacement.
241
242
h3. LineageOS
243
244 86 Denis 'GNUtoo' Carikli
The LineageOS project has a "checklist":https://github.com/LineageOS/charter/blob/master/device-support-requirements.md of requirements for adding support for a device.
245
246
As the LineageOS developers have to make sure that the checklist requirements are met, make sure that your replacement is complete enough to either meet the checklist requirements, or that the LineageOS developers are interested in working together with you to make sure that the free software replacement meets such requirements.
247
248 1 Paul Kocialkowski
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
249 2 Paul Kocialkowski
250
You can also push directly using git using the following scheme (untested):
251
<pre>
252
git push ssh://<sshusername>@review.lineageos.org:29418/LineageOS/<projectname> HEAD:refs/for/<branchname>
253
</pre>
254 25 Paul Kocialkowski
255
h3. AOSP
256
257
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
258
259
You can push to AOSP's review using:
260 3 Paul Kocialkowski
<pre>
261
git push https://android-review.googlesource.com/platform/system/core HEAD:refs/for/master
262
</pre>
263 43 Wolfgang Wiedmeyer
264 71 Wolfgang Wiedmeyer
h2. Commonly-used terminology
265 3 Paul Kocialkowski
266 71 Wolfgang Wiedmeyer
In order to keep everything clear and consistent, we use the following terms with a precise meaning in mind:
267
* *Driver*: Software that is part of the *kernel* (builtin or as a module) and deals with communicating with the hardware
268
* *Hardware Abstraction Layer (HAL)*: Software that runs in *user-space* and deals with communicating with the hardware (usually through a kernel driver)
269
* *module*: Android HALs are also often called modules, so we may referrer to e.g. the @audio HAL@ as the @audio module@
270
* *blob*: Proprietary HAL
271
* *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)
272 1 Paul Kocialkowski
273
h2. Wiki guidelines
274
275
In order the keep the wiki simple and consistent, a few guidelines must be followed when editing.
276
277
Regarding the content:
278
* 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.
279
* The content on each page should *only* be relevant to the latest Replicant version: make sure to update the content with newer Replicant versions.
280
* Substantial changes must be discussed before modifying the wiki.
281
* A comment should be added in the comment field at the bottom that shortly describes the change.
282 72 Wolfgang Wiedmeyer
* Make use of the wiki formatting possibilities: "quick reference":/help/en/wiki_syntax_textile.html and "detailed syntax overview":/help/en/wiki_syntax_detailed_textile.html
283 1 Paul Kocialkowski
  By using @[[Index]]@, it's possible to link to the start page of the wiki.
284 6 Paul Kocialkowski
285 3 Paul Kocialkowski
Regarding the writing style:
286
* Every page in the wiki has to be written in correct English, we do not aim to provide information in any other language.
287 17 Paul Kocialkowski
* Addressing readers directly should be avoided when possible: Instead, what is described should always be the subject of sentences.
288 4 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]]).
289 14 Paul Kocialkowski
290
Regarding the naming of pages:
291 34 Paul Kocialkowski
* Pages must be named in a consistent manner ([[NexusSI902xFirmwares]] is not to be called [[FirmwaresOnTheI902xNexusS]]).
292 1 Paul Kocialkowski
* Common prefixes and suffixes should be used for naming new pages ([[BuildDependenciesInstallation]] is not to be called [[InstallationOfBuildDependencies]]).
293 34 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]]).
294
* 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]]).
295
* 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.
296
297 49 Wolfgang Wiedmeyer
Regarding the naming of devices:
298 53 Wolfgang Wiedmeyer
* Devices should be named after their model number and codename, without mention of the manufacturer.
299 49 Wolfgang Wiedmeyer
* 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@).
300 34 Paul Kocialkowski
301 71 Wolfgang Wiedmeyer
h2. Repositories
302 34 Paul Kocialkowski
303 71 Wolfgang Wiedmeyer
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.
304
It is better to create separate branches (that are not used by the official manifest branches) when your work is still in progress.
305
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.
306
307 80 Denis 'GNUtoo' Carikli
See [[SourceCodeRepositories]] for more details about how to create or mirror repositories on Replicant server.
308 71 Wolfgang Wiedmeyer
309
h3. When creating a repository
310 78 Denis 'GNUtoo' Carikli
311 71 Wolfgang Wiedmeyer
In order to keep repo naming consistent, please name repositories by their name on the tree, replacing the @/@ by @_@.
312
For instance, when forking the LineageOS repo: @android_device_samsung_crespo@, rename it to @device_samsung_crespo@ on the Replicant repos.
313
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 @_@.
314
315
h3. When creating a branch
316
317
Official Replicant branches are named the following way:
318
* The @replicant-@ prefix
319
* The Replicant version
320
321
Such as: @replicant-2.3@ This should be used on the projects repositories as well as the manifest repository.
322
Any other branch should be considered as Work In Progress (WIP) and thus not be part of any official branch of the manifest.
323
324
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.
325 16 Paul Kocialkowski
326 33 Paul Kocialkowski
h2. New images release
327 1 Paul Kocialkowski
328 33 Paul Kocialkowski
# Modify the changelog in the vendor files:
329
<pre>
330 54 Wolfgang Wiedmeyer
cd path/to/replicant-6.0/vendor/replicant
331 33 Paul Kocialkowski
edit CHANGELOG.mkdn
332
git add CHANGELOG.mkdn
333 54 Wolfgang Wiedmeyer
git commit -sS -m "Replicant 6.0 0001 images release"
334
git push git@git.replicant.us:replicant/vendor_replicant.git replicant-6.0
335 33 Paul Kocialkowski
</pre>
336 65 Wolfgang Wiedmeyer
# Increment the release in the "release scripts":https://git.replicant.us/replicant/release-scripts:
337 33 Paul Kocialkowski
<pre>
338
cd path/to/release-scripts
339 58 Wolfgang Wiedmeyer
edit releasevars.sh
340
git add releasevars.sh
341 1 Paul Kocialkowski
git commit -sS -m "Replicant 6.0 0001 images release"
342
git push git@git.replicant.us:replicant/release-scripts.git replicant-6.0
343 58 Wolfgang Wiedmeyer
</pre>
344 63 Wolfgang Wiedmeyer
# Tag all the repositories with the release tag script:
345
<pre>
346
path/to/release-scripts/releasetag.sh path/to/replicant-6.0
347
</pre>
348 58 Wolfgang Wiedmeyer
# In the manifest repo, merge the replicant-6.0-dev branch into the replicant-6.0 branch and increment the release in the manifest:
349
<pre>
350
cd path/to/manifest
351
git checkout replicant-6.0
352
git merge replicant-6.0-dev
353
edit default.xml
354
git add default.xml
355
git commit -sS -m "Replicant 6.0 0001 images release"
356
git push git@git.replicant.us:replicant/manifest.git replicant-6.0
357 33 Paul Kocialkowski
</pre>
358
# Tag the manifest:
359 61 Wolfgang Wiedmeyer
<pre>
360
git tag -u 5816A24C10757FC4 replicant-6.0-0001 -m "Replicant 6.0 0001 images release"
361
git push git@git.replicant.us:replicant/manifest.git replicant-6.0-0001
362
</pre>
363 64 Wolfgang Wiedmeyer
# Verify all tags:
364
<pre>
365
cd .repo/manifests
366
git verify-tag $(git describe)
367
cd ../..
368 68 Wolfgang Wiedmeyer
repo forall -ec ' { echo "Verifying $REPO_PROJECT" && git verify-tag $(git describe) 2>/dev/null; } || { echo "Error: verification failed!" && exit 1; } '
369 64 Wolfgang Wiedmeyer
</pre>
370 56 Wolfgang Wiedmeyer
# Update prebuilts and start the build (in a newly opened shell with the Replicant keys and certificates installed):
371
<pre>
372
path/to/release-scripts/releasebuild.sh path/to/replicant-6.0
373
</pre>
374 33 Paul Kocialkowski
# Release the images with the release script:
375
<pre>
376 55 Wolfgang Wiedmeyer
rm -rf path/to/images/replicant-6.0/0001
377 54 Wolfgang Wiedmeyer
mkdir -p path/to/images/replicant-6.0/0001
378
path/to/release-scripts/release.sh path/to/replicant-6.0 path/to/images/replicant-6.0/0001
379 1 Paul Kocialkowski
</pre>
380 33 Paul Kocialkowski
# Sign the binaries with the release script:
381
<pre>
382 54 Wolfgang Wiedmeyer
path/to/release-scripts/release.sh path/to/replicant-6.0 path/to/images/replicant-6.0/0001 signatures
383 1 Paul Kocialkowski
</pre>
384 33 Paul Kocialkowski
# Compress the release files
385
<pre>
386 54 Wolfgang Wiedmeyer
cd path/to/images/replicant-6.0
387
tar -cjf 0001.tar.bz2 0001
388 1 Paul Kocialkowski
</pre>
389 33 Paul Kocialkowski
# Upload the release to OSUOSL:
390
<pre>
391 66 Wolfgang Wiedmeyer
rsync -P -4 -ze ssh 0001.tar.bz2 replicant@ftp-osl.osuosl.org:/home/replicant/data/images/replicant-6.0/
392 54 Wolfgang Wiedmeyer
</pre>
393 67 Wolfgang Wiedmeyer
# Unpack the release on OSUOSL, ensure permissions are correct and run the @trigger-replicant@ script
394 33 Paul Kocialkowski
# Update [[ReplicantImages]] with the release
395
# Update each device's page with the release
396
# Update [[ReplicantStatus]] with the latest status
397 62 Wolfgang Wiedmeyer
# Verify if other wiki pages need to be updated due to changes introduced by the release (e.g. [[Index#Replicant-build|build pages]] or [[ToolsInstallation]])
398 33 Paul Kocialkowski
# Announce the release on the blog
399
# Update the release on the website and IRC topic
400 5 Paul Kocialkowski
401 33 Paul Kocialkowski
h2. New device documentation
402 22 Paul Kocialkowski
403 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]])
404 74 Wolfgang Wiedmeyer
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 [[GalaxyS2I9100LoadedFirmwares]])
405 5 Paul Kocialkowski
3. Link the sub-pages to the main page in the index
406
4. Update the [[ReplicantStatus]] page of the wiki with the current status of the device
407 47 Wolfgang Wiedmeyer
5. Modify the [[Index]] page of the wiki and add the new device in the following sections:
408
* [[Index#Replicant-status|Replicant status]]
409
* [[Index#Replicant-installation|Replicant installation]]
410
* [[Index#Replicant-build|Replicant build]]
411
* [[Index#Supported-devices|Supported devices]]
412 24 Paul Kocialkowski
413 43 Wolfgang Wiedmeyer
6. Add new issues categories to the Replicant project Redmine
414 73 Wolfgang Wiedmeyer
415
7. Add the device to the "Supported devices page":https://www.replicant.us/supported-devices.php on the website