Gitiles
Code Review Sign In
review.blissroms.org / Documentation-release / f118012fabafbec05fe6333caed1e5bfd6c96e53 / . / BlissRoms / build-guide / index.html
blob: fe9ccaee00a6095cb97f755ce166cba23c02ad4f [file] [log] [blame]
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]1
2
3
4
5<!doctype html>
6<html lang="en" class="no-js">
7 <head>
8
9 <meta charset="utf-8">
10 <meta name="viewport" content="width=device-width,initial-scale=1">
11 <meta http-equiv="x-ua-compatible" content="ie=edge">
12
13
14
15
16 <meta name="lang:clipboard.copy" content="Copy to clipboard">
17
18 <meta name="lang:clipboard.copied" content="Copied to clipboard">
19
20 <meta name="lang:search.language" content="en">
21
22 <meta name="lang:search.pipeline.stopwords" content="True">
23
24 <meta name="lang:search.pipeline.trimmer" content="True">
25
26 <meta name="lang:search.result.none" content="No matching documents">
27
28 <meta name="lang:search.result.one" content="1 matching document">
29
30 <meta name="lang:search.result.other" content="# matching documents">
31
32 <meta name="lang:search.tokenizer" content="[\s\-]+">
33
34 <link rel="shortcut icon" href="../../assets/images/favicon.png">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]35 <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.3">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]36
37
38
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]39 <title>Build Guide - Team Bliss</title>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]40
41
42
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]43 <link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]44
45
46
47
48 <script src="../../assets/javascripts/modernizr.74668098.js"></script>
49
50
51
52 <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
53 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback">
54 <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
55
56
57 <link rel="stylesheet" href="../../assets/fonts/material-icons.css">
58
59
60
61
62
63
64 </head>
65
66 <body dir="ltr">
67
68 <svg class="md-svg">
69 <defs>
70
71
72 </defs>
73 </svg>
74 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
75 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
76 <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
77
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]78 <a href="#build-guide" tabindex="1" class="md-skip">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]79 Skip to content
80 </a>
81
82
83 <header class="md-header" data-md-component="header">
84 <nav class="md-header-nav md-grid">
85 <div class="md-flex">
86 <div class="md-flex__cell md-flex__cell--shrink">
87 <a href="../.." title="Team Bliss" class="md-header-nav__button md-logo">
88
89 <i class="md-icon"></i>
90
91 </a>
92 </div>
93 <div class="md-flex__cell md-flex__cell--shrink">
94 <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
95 </div>
96 <div class="md-flex__cell md-flex__cell--stretch">
97 <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
98
99 <span class="md-header-nav__topic">
100 Team Bliss
101 </span>
102 <span class="md-header-nav__topic">
103
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]104 Build Guide
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]105
106 </span>
107
108 </div>
109 </div>
110 <div class="md-flex__cell md-flex__cell--shrink">
111
112 <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
113
114<div class="md-search" data-md-component="search" role="dialog">
115 <label class="md-search__overlay" for="__search"></label>
116 <div class="md-search__inner" role="search">
117 <form class="md-search__form" name="search">
118 <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
119 <label class="md-icon md-search__icon" for="__search"></label>
120 <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
121 &#xE5CD;
122 </button>
123 </form>
124 <div class="md-search__output">
125 <div class="md-search__scrollwrap" data-md-scrollfix>
126 <div class="md-search-result" data-md-component="result">
127 <div class="md-search-result__meta">
128 Type to start searching
129 </div>
130 <ol class="md-search-result__list"></ol>
131 </div>
132 </div>
133 </div>
134 </div>
135</div>
136
137 </div>
138
139 </div>
140 </nav>
141</header>
142
143 <div class="md-container">
144
145
146
147
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]148 <main class="md-main" role="main">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]149 <div class="md-main__inner md-grid" data-md-component="container">
150
151
152 <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
153 <div class="md-sidebar__scrollwrap">
154 <div class="md-sidebar__inner">
155 <nav class="md-nav md-nav--primary" data-md-level="0">
156 <label class="md-nav__title md-nav__title--site" for="__drawer">
157 <a href="../.." title="Team Bliss" class="md-nav__button md-logo">
158
159 <i class="md-icon"></i>
160
161 </a>
162 Team Bliss
163 </label>
164
165 <ul class="md-nav__list" data-md-scrollfix>
166
167
168
169
170
171
172 <li class="md-nav__item">
Eric Park5e3a1012019-08-12 13:17:03 +0800[diff] [blame]173 <a href="../.." title="Home" class="md-nav__link">
174 Home
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]175 </a>
176 </li>
177
178
179
180
181
182
183
184 <li class="md-nav__item md-nav__item--nested">
185
186 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">
187
188 <label class="md-nav__link" for="nav-2">
189 Bliss OS
190 </label>
191 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
192 <label class="md-nav__title" for="nav-2">
193 Bliss OS
194 </label>
195 <ul class="md-nav__list" data-md-scrollfix>
196
197
198
199
200
201
202
203 <li class="md-nav__item">
204 <a href="../../Bliss OS/" title="Index" class="md-nav__link">
205 Index
206 </a>
207 </li>
208
209
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]210
211
212
213
214
215 <li class="md-nav__item">
Eric Park5e3a1012019-08-12 13:17:03 +0800[diff] [blame]216 <a href="../../Bliss OS/build-guide/" title="Build Guide" class="md-nav__link">
217 Build Guide
218 </a>
219 </li>
220
221
222
223
224
225
226
227 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]228 <a href="../../Bliss OS/extras/" title="Extras" class="md-nav__link">
229 Extras
230 </a>
231 </li>
232
233
234
235
236
237
238
239 <li class="md-nav__item">
240 <a href="../../Bliss OS/installation-guide/" title="Installation Guide" class="md-nav__link">
241 Installation Guide
242 </a>
243 </li>
244
245
246
247
248
249
250
251 <li class="md-nav__item">
252 <a href="../../Bliss OS/troubleshooting/" title="Troubleshooting" class="md-nav__link">
253 Troubleshooting
254 </a>
255 </li>
256
257
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]258 </ul>
259 </nav>
260 </li>
261
262
263
264
265
266
267
268
269
270 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
271
272 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked>
273
274 <label class="md-nav__link" for="nav-3">
275 BlissRoms
276 </label>
277 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
278 <label class="md-nav__title" for="nav-3">
279 BlissRoms
280 </label>
281 <ul class="md-nav__list" data-md-scrollfix>
282
283
284
285
286
287
288
289 <li class="md-nav__item">
290 <a href="../" title="Index" class="md-nav__link">
291 Index
292 </a>
293 </li>
294
295
296
297
298
299
300
301
302
303 <li class="md-nav__item md-nav__item--active">
304
305 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
306
307
308
309
310 <label class="md-nav__link md-nav__link--active" for="__toc">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]311 Build Guide
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]312 </label>
313
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]314 <a href="./" title="Build Guide" class="md-nav__link md-nav__link--active">
315 Build Guide
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]316 </a>
317
318
319<nav class="md-nav md-nav--secondary">
320
321
322
323
324
325 <label class="md-nav__title" for="__toc">Table of contents</label>
326 <ul class="md-nav__list" data-md-scrollfix>
327
328 <li class="md-nav__item">
Eric Parkd5cc44a2019-10-21 12:15:48 +0800[diff] [blame]329 <a href="#updated-for-android-10-q" class="md-nav__link">
330 Updated for Android 10 (q)
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]331 </a>
332
333 <nav class="md-nav">
334 <ul class="md-nav__list">
335
336 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]337 <a href="#introduction" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]338 Introduction
339 </a>
340
341</li>
342
343 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]344 <a href="#preparation" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]345 Preparation
346 </a>
347
348</li>
349
350 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]351 <a href="#install-the-jdk" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]352 Install the JDK
353 </a>
354
355</li>
356
357 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]358 <a href="#install-build-tools" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]359 Install build tools
360 </a>
361
362</li>
363
364 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]365 <a href="#install-source-code-tools" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]366 Install source code tools
367 </a>
368
369 <nav class="md-nav">
370 <ul class="md-nav__list">
371
372 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]373 <a href="#what-is-source" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]374 What is source?
375 </a>
376
377</li>
378
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]379 </ul>
380 </nav>
381
382</li>
383
384 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]385 <a href="#download" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]386 Download
387 </a>
388
389</li>
390
391 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]392 <a href="#build" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]393 Build
394 </a>
395
396 <nav class="md-nav">
397 <ul class="md-nav__list">
398
399 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]400 <a href="#my-device-isnt-booting-and-userdebug-wont-print-any-adb-logcats-what-gives" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]401 My device isn't booting, and userdebug won't print any adb logcats. What gives?
402 </a>
403
404</li>
405
406 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]407 <a href="#why-mka-and-not-make" class="md-nav__link">
Eric Park35d8ee32019-08-11 01:34:35 +0800[diff] [blame]408 Why mka and not make?
409 </a>
410
411</li>
412
413 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]414 <a href="#i-get-an-error-about-no-blissify-targets-to-build-against-whats-wrong" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]415 I get an error about no blissify targets to build against, what's wrong?
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]416 </a>
417
418</li>
419
420 </ul>
421 </nav>
422
423</li>
424
425 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]426 <a href="#after-building" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]427 After building
428 </a>
429
430</li>
431
432 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]433 <a href="#troubleshooting" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]434 Troubleshooting
435 </a>
436
437</li>
438
439 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]440 <a href="#conclusion" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]441 Conclusion
442 </a>
443
444</li>
445
446 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]447 <a href="#looking-for-the-next-tutorial" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]448 Looking for the next tutorial?
449 </a>
450
451</li>
452
453 </ul>
454 </nav>
455
456</li>
457
458
459
460
461
462 </ul>
463
464</nav>
465
466 </li>
467
468
469
470
471
472
473
474 <li class="md-nav__item">
475 <a href="../build-tips/" title="Build Tips" class="md-nav__link">
476 Build Tips
477 </a>
478 </li>
479
480
481 </ul>
482 </nav>
483 </li>
484
485
486
487
488
489
490
491 <li class="md-nav__item md-nav__item--nested">
492
493 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
494
495 <label class="md-nav__link" for="nav-4">
496 Common
497 </label>
498 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
499 <label class="md-nav__title" for="nav-4">
500 Common
501 </label>
502 <ul class="md-nav__list" data-md-scrollfix>
503
504
505
506
507
508
509
510 <li class="md-nav__item">
511 <a href="../../common/" title="Index" class="md-nav__link">
512 Index
513 </a>
514 </li>
515
516
517
518
519
520
521
522 <li class="md-nav__item">
523 <a href="../../common/git-started/" title="Git Started" class="md-nav__link">
524 Git Started
525 </a>
526 </li>
527
528
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]529
530
531
532
533
534 <li class="md-nav__item">
Eric Park8584eda2019-09-02 09:45:55 +0800[diff] [blame]535 <a href="../../common/maintaining-proper-authorship/" title="Maintaining proper authorship" class="md-nav__link">
536 Maintaining proper authorship
537 </a>
538 </li>
539
540
541
542
543
544
545
546 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]547 <a href="../../common/using-dippy-bird/" title="Using `dippy-bird`" class="md-nav__link">
548 Using `dippy-bird`
549 </a>
550 </li>
551
552
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]553 </ul>
554 </nav>
555 </li>
556
557
558
559
560
561
562
563 <li class="md-nav__item md-nav__item--nested">
564
565 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
566
567 <label class="md-nav__link" for="nav-5">
568 Infrastructure
569 </label>
570 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
571 <label class="md-nav__title" for="nav-5">
572 Infrastructure
573 </label>
574 <ul class="md-nav__list" data-md-scrollfix>
575
576
577
578
579
580
581
582 <li class="md-nav__item">
583 <a href="../../infrastructure/" title="Index" class="md-nav__link">
584 Index
585 </a>
586 </li>
587
588
589 </ul>
590 </nav>
591 </li>
592
593
594 </ul>
595</nav>
596 </div>
597 </div>
598 </div>
599
600
601 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
602 <div class="md-sidebar__scrollwrap">
603 <div class="md-sidebar__inner">
604
605<nav class="md-nav md-nav--secondary">
606
607
608
609
610
611 <label class="md-nav__title" for="__toc">Table of contents</label>
612 <ul class="md-nav__list" data-md-scrollfix>
613
614 <li class="md-nav__item">
Eric Parkd5cc44a2019-10-21 12:15:48 +0800[diff] [blame]615 <a href="#updated-for-android-10-q" class="md-nav__link">
616 Updated for Android 10 (q)
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]617 </a>
618
619 <nav class="md-nav">
620 <ul class="md-nav__list">
621
622 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]623 <a href="#introduction" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]624 Introduction
625 </a>
626
627</li>
628
629 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]630 <a href="#preparation" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]631 Preparation
632 </a>
633
634</li>
635
636 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]637 <a href="#install-the-jdk" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]638 Install the JDK
639 </a>
640
641</li>
642
643 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]644 <a href="#install-build-tools" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]645 Install build tools
646 </a>
647
648</li>
649
650 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]651 <a href="#install-source-code-tools" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]652 Install source code tools
653 </a>
654
655 <nav class="md-nav">
656 <ul class="md-nav__list">
657
658 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]659 <a href="#what-is-source" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]660 What is source?
661 </a>
662
663</li>
664
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]665 </ul>
666 </nav>
667
668</li>
669
670 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]671 <a href="#download" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]672 Download
673 </a>
674
675</li>
676
677 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]678 <a href="#build" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]679 Build
680 </a>
681
682 <nav class="md-nav">
683 <ul class="md-nav__list">
684
685 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]686 <a href="#my-device-isnt-booting-and-userdebug-wont-print-any-adb-logcats-what-gives" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]687 My device isn't booting, and userdebug won't print any adb logcats. What gives?
688 </a>
689
690</li>
691
692 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]693 <a href="#why-mka-and-not-make" class="md-nav__link">
Eric Park35d8ee32019-08-11 01:34:35 +0800[diff] [blame]694 Why mka and not make?
695 </a>
696
697</li>
698
699 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]700 <a href="#i-get-an-error-about-no-blissify-targets-to-build-against-whats-wrong" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]701 I get an error about no blissify targets to build against, what's wrong?
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]702 </a>
703
704</li>
705
706 </ul>
707 </nav>
708
709</li>
710
711 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]712 <a href="#after-building" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]713 After building
714 </a>
715
716</li>
717
718 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]719 <a href="#troubleshooting" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]720 Troubleshooting
721 </a>
722
723</li>
724
725 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]726 <a href="#conclusion" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]727 Conclusion
728 </a>
729
730</li>
731
732 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]733 <a href="#looking-for-the-next-tutorial" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]734 Looking for the next tutorial?
735 </a>
736
737</li>
738
739 </ul>
740 </nav>
741
742</li>
743
744
745
746
747
748 </ul>
749
750</nav>
751 </div>
752 </div>
753 </div>
754
755
756 <div class="md-content">
757 <article class="md-content__inner md-typeset">
758
759
760
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]761 <h1 id="build-guide">Build Guide</h1>
Eric Parkd5cc44a2019-10-21 12:15:48 +0800[diff] [blame]762<h2 id="updated-for-android-10-q">Updated for Android 10 (q)</h2>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]763<h3 id="introduction">Introduction</h3>
764<p>This is the official guide to build BlissRoms for your device. In this guide, we will only cover official devices with actual maintainers. We will not delve into porting devices.</p>
765<p>The golden rule to building is patience. If something breaks, wait for your maintainer to fix it, send a polite message to your maintainer, or better yet, try and fix it yourself. Then you can make a merge request and contribute!</p>
766<p>Let’s get started.</p>
767<h3 id="preparation">Preparation</h3>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]768<p>To get started, you need a computer with Ubuntu 18.04 (LTS), at least 200GB space of HDD, and at least 8GB RAM. A decent CPU (or CPUs if you have a server motherboard) is recommended. Other distros can work but is not officially supported in this guide.</p>
769<p>Underpowered machines may crash during compilation. If that happens, you may try and restart the build as most crashes are caused by lack of memory. If your storage space has run out, then you will need to build on a different hard drive.</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]770<h3 id="install-the-jdk">Install the JDK</h3>
771<p>Install OpenJDK:</p>
772<pre><code>sudo apt install openjdk-8-jdk
773</code></pre>
774<h3 id="install-build-tools">Install build tools</h3>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]775<p>To install the required build tools, run the following command:</p>
776<pre><code>sudo apt install git gnupg flex bison gperf build-essential zip curl zlib1g-dev gcc-multilib g++-multilib libc6-dev-i386 lib32ncurses5-dev x11proto-core-dev libx11-dev lib32z-dev lib32z1-dev ccache libgl1-mesa-dev libxml2 libxml2-utils xsltproc unzip squashfs-tools python python-mako libssl-dev ninja-build lunzip syslinux syslinux-utils gettext genisoimage bc xorriso liblz4-tool libncurses5-dev libsdl1.2-dev libwxgtk3.0-dev lzop maven pngcrush schedtool lib32readline-dev
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]777</code></pre>
778<h3 id="install-source-code-tools">Install source code tools</h3>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame^]779<p>Now we need to get the source code via a program named <code>repo</code>. The primary function of <code>repo</code> is to read a manifest file located in BlissRoms's GitHub organization, and find what repositories you need to actually build Android.</p>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]780<p>Create a <code>~/bin</code> directory for <code>repo</code>:</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]781<pre><code>mkdir -p ~/bin
782</code></pre>
783<p>The <code>-p</code> flag instructs <code>mkdir</code> to <em>only</em> create the directory if it does not exist in the first place. Now download the <code>repo</code> tool into <code>~/bin</code>:</p>
784<pre><code>curl https://storage.googleapis.com/git-repo-downloads/repo &gt; ~/bin/repo
785</code></pre>
786<p>Make <code>repo</code> executable:</p>
787<pre><code>chmod a+x ~/bin/repo
788</code></pre>
789<p>And add it to PATH:</p>
790<pre><code>nano .bashrc
791</code></pre>
792<p>Scroll to the end of the file and type these lines:</p>
793<pre><code># Export ~/bin
794export PATH=~/bin:$PATH
795</code></pre>
796<p>Ctrl-O and enter to save, then Ctrl-X to exit nano. Now either logout and login again (or reboot), or <code>source</code> the file:</p>
797<pre><code>source .bashrc
798</code></pre>
799<p>Which can be shortened to:</p>
800<pre><code>. .bashrc
801</code></pre>
802<h4 id="what-is-source">What is <code>source</code>?</h4>
803<p><code>source</code> is a <code>bash</code> command to read aliases, functions, and commands from the specified file. Typically, you'll supply <code>bash</code> with a configuration file such as <code>.bashrc</code> or <code>.bash_profile</code>, or an initialization file such as <code>envsetup.sh</code>. The difference is that while the configuration file lists configuration and user-defined aliases and functions, initialization files typically hold build commands such as <code>breakfast</code>, <code>brunch</code>, and <code>lunch</code>. Without those commands building would be significantly harder as you would have to memorize the long command to invoke a build manually!</p>
804<p>But why do you need to run it after modifying a file? Well, <code>bash</code> cannot automatically detect changes in our files. To solve this, we either <code>source</code> it or log out and log back in, forcing <code>bash</code> to reload configuration files. Keep this in mind, because unlike configuration files, if you forget to <code>source</code> initialization files, build commands will not function!</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]805<h3 id="download">Download</h3>
806<p>Create a directory for the source:</p>
Eric Parkd5cc44a2019-10-21 12:15:48 +0800[diff] [blame]807<pre><code>mkdir -p ~/bliss/q
808cd ~/bliss/q
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]809</code></pre>
810<p>Before we download, we need to tell <code>repo</code> and <code>git</code> who we are. Run the following commands, substituting your information:</p>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame^]811<pre><code>git config --global user.email "john.appleseed@example.com"
812git config --global user.name "John Appleseed"
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]813</code></pre>
814<p>Now, we’re ready to initialize. We need to tell <code>repo</code> which manifest to read:</p>
Eric Parkd5cc44a2019-10-21 12:15:48 +0800[diff] [blame]815<pre><code>repo init -u https://github.com/BlissRoms/platform_manifest.git -b q
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]816</code></pre>
Eric Parkd5cc44a2019-10-21 12:15:48 +0800[diff] [blame]817<p><code>-b</code> is for the branch, and we’re on <code>q</code>, Android 10. It’ll take a couple of seconds. You may need to type <code>y</code> for the color prompt.</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]818<p>Then sync the source:</p>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame^]819<pre><code>repo sync -j$(nproc --all) -c
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]820</code></pre>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame^]821<p><em>Note: For more information about the <code>repo</code> tool, visit the <a href="../build-tips/">Build Tips guide</a> to learn more about the <a href="../build-tips/#repo-optimization-tips">repo flags</a>.</em></p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]822<p><code>repo</code> will start downloading all the code. That’s going to be slow, even on a fiber network. Expect downloads to take more than a couple hours.</p>
823<h3 id="build">Build</h3>
824<p>Set up the build environment:</p>
825<pre><code>. build/envsetup.sh
826</code></pre>
827<p>This is the initialization file we talked about earlier up top. This "initializes" the environment, and imports a bunch of useful build commands required to build your device. Again, you need to remember to <code>source</code> this file every time you log out and log back in, or launch a new <code>bash</code>/Terminal instance.</p>
828<p>Define what device you’re going to build. For example, the Nexus 5X, has a codename of <code>bullhead</code>. You can check your specific device's codename on GitHub or on Google. Execute:</p>
829<pre><code>breakfast bullhead
830</code></pre>
831<p>What does this do? <code>breakfast</code> searches repositories for your device "tree", which contains all the details needed to make the build suitable for your device. CPU, kernel info, device screen size, whether the board has Bluetooth, NFC, what frequencies the build needs for Wi-Fi, and a bunch of other things. <code>breakfast</code> will automatically search in the <code>BlissRoms-Devices</code> GitHub repository, and grab your device tree for you.</p>
832<p>Okay, so we have the device tree set up. Feel free to browse around the source code to see what changed. You should see folders added to <code>device/</code>, <code>kernel/</code> and <code>vendor/</code>. A shortcut:</p>
833<pre><code>croot
834</code></pre>
835<p>will dump you back in the root of the source code tree. So if you’ve been going through folders and don’t have any idea where you are, you can use the above command. This command, however, requires you to have <code>source</code>d <code>build/envsetup.sh</code> earlier.</p>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]836<p>We're ready to build, but before we teach you the easy command to execute a build, we will first try the manual method. To set up the current terminal environment for building your particular device, execute:</p>
837<pre><code>lunch bliss_bullhead-userdebug
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]838</code></pre>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]839<p>Let's break down the command. <code>lunch</code> initializes the proper environmental variables required for the build tools to build your specific device. Things like <code>BLISS_DEVICE</code> and other variables are set in this stage, and the changed variables will be shown as output. <code>bliss_</code> is the ROM that we are building. As convention, all devices will have this prefix. <code>bullhead</code> is the specific device we are building - in this case, the Nexus 5X. Finally, <code>userdebug</code> means that we will build a user-debuggable variant. This is usually what most ROMs use for publishing their builds. Manufacturers typically use <code>user</code> which disables most of the useful Android Logcats.</p>
840<h4 id="my-device-isnt-booting-and-userdebug-wont-print-any-adb-logcats-what-gives">My device isn't booting, and <code>userdebug</code> won't print any <code>adb logcat</code>s. What gives?</h4>
841<p>There is a third build variant called <code>eng</code>, short for engineering builds. These builds will activate <code>adb logcat</code> during boot, and will show you exactly what is going wrong, where, and why. However, these builds are <strong>NOT</strong> recommended for normal usage as they are not securely hardened, have log spam that will slow down your device, and other unexpected problems like userspace utilities crashing during runtime. If you want to submit your device for mainline, do <strong>NOT</strong> submit an <code>eng</code> build!</p>
842<p>All set? Let's start the building process. Run:</p>
Eric Park35d8ee32019-08-11 01:34:35 +0800[diff] [blame]843<p><code>mka blissify</code></p>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]844<p>And the build should start. The build process will take a long time. Prepare to wait a few hours, even on a decent machine.</p>
Eric Park35d8ee32019-08-11 01:34:35 +0800[diff] [blame]845<h4 id="why-mka-and-not-make">Why <code>mka</code> and not <code>make</code>?</h4>
846<p><code>make</code> only runs with 1 thread. <code>mka</code> is properly aliased to use all of your threads by checking <code>nproc</code>.</p>
Eric Parkd5cc44a2019-10-21 12:15:48 +0800[diff] [blame]847<p>If you want to customize your thread count (maybe you're building with a fan-screaming laptop in a quiet coffee shop), use <code>make blissify -j#</code>, replacing the hash with the number of threads (example of <code>make blissify -j4</code>).</p>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]848<h4 id="i-get-an-error-about-no-blissify-targets-to-build-against-whats-wrong">I get an error about no <code>blissify</code> targets to build against, what's wrong?</h4>
849<p>If you are building other ROMs, it is usually <code>make bacon</code>. For BlissRoms, we chose the build target of <code>blissify</code>. If that doesn't work, sometimes there is a bug, or the ROM developers do not implement a <code>bacon</code> target to build against. In this case, you will need to find what name they use to initialize a full build of the ROM. Conventionally, it is supposed to be <code>bacon</code>, but some ROM developers change this name inadvertently, or actually have a bug that causes the build target to never be found. If you cannot locate the build target, ask the developers of the ROM. Alternatively, you can try poking around in <code>build/make/core/Makefile</code> to see what the build target name is. But this is out of the scope of this article as you're not supposed to be building other ROMs (that's not what this tutorial is for, sorry!)</p>
850<p>All right, but that's annoying. You had to type <strong>three</strong> commands to build it all. What about running one command?</p>
851<pre><code>blissify bullhead
852</code></pre>
853<p>But what is <code>blissify</code>? It is a compact form of these commands:</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]854<pre><code>breakfast bullhead
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]855lunch bliss_bullhead-userdebug
856make blissify
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]857</code></pre>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]858<p>Sounds great, right? Once you have run the command, jump over to the next section.</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]859<h3 id="after-building">After building</h3>
860<p>There are two outcomes to a build - either it fails and you get a red error message from <code>make</code>, or it succeeds and you see the Bliss logo in ASCII. If you encounter the former, you need to go back and fix whatever it's complaining about. Typically, 90% of the time the problem will be in your device tree. For the other 10%, submit a bug report to the ROM developers. Be sure to include the full log of your build to help diagnose the problem, and your device tree.</p>
861<p>If you face the latter, congratulations! You've successfully built BlissRoms for your device. Grab the artifacts for your device:</p>
862<pre><code>cd out/target/product/bullhead/
863</code></pre>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]864<p>In here, you’ll find a <code>.zip</code> that goes along the lines of <code>Bliss-v11.9-Stable-bullhead-UNOFFICIAL-20190531.zip</code>. Install TWRP, flash the build to your device, and enjoy!</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]865<h3 id="troubleshooting">Troubleshooting</h3>
866<p>If your build failed, there are a couple things you can try.</p>
867<ul>
868<li>Try a fresh <code>repo sync</code> to make your repository up to date. Sometimes, the Internet connection between you and GitHub can be flaky. In rare cases a commit merge might be ongoing, and you might've grabbed an incomplete merge. Mostly, this should fix the issue 70% of the time.</li>
869<li>Make sure your dependencies are installed correctly. Error messages help out a lot here! Often it will say <code>shared/linked library not found</code> or something along those lines.</li>
870<li>Make sure you sourced <code>build/envsetup.sh</code>. This is especially common and worth suspecting if none of the build commands like <code>breakfast</code> and <code>lunch</code> work. If you have <code>repo sync</code>ed do this again.</li>
871<li>Make sure you’re at the root of the build tree. Again, to quickly jump there, use <code>croot</code>.</li>
872<li>Make sure you ran <code>breakfast</code> correctly and it did not error out. Missing device files will prevent successful builds.</li>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame^]873<li>Make sure your computer meets minimum requirements to compile AOSP. Chances are, you need more memory/CPU power to complete a build.</li>
874<li>Make sure your computer isn't faulty. This is unlikely, but to check, use a stress-test program like Prime95.</li>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]875</ul>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame^]876<p>If something goes wrong and you've tried everything above, first use Google to look up your error! Most of the errors you encounter is due to misconfiguration and wrong commands entered. More often than not, Google will have the answer you are looking for. If you're still stuck and nothing fixes the problem, then ask us via <a href="https://t.me/Team_Bliss_Build_Support">our Telegram Build Support chat.</a> (Please only ask issues about BlissRoms, not other custom ROMs as we are unable to assist with those!)</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]877<h3 id="conclusion">Conclusion</h3>
878<p>Building a ROM is very hard and tedious and the results are very rewarding! If you managed to follow along, congratulations!</p>
879<p>After you finish building, you can try out the Git Started guide. Make changes, commit, and send them off to our Gerrit for review! Or better yet, download experimental commits not ready for the mainline repositories and review them! Again, ROM building is a fun project you can work with. I hope this guide was a lot of fun to run through!</p>
880<p>-- Eric Park (ideaman924)</p>
881<h3 id="looking-for-the-next-tutorial">Looking for the next tutorial?</h3>
882<p>Check out <a href="../build-tips/">some tips to optimize your build experience.</a></p>
883
884
885
886
887
888
889
890
891
892 </article>
893 </div>
894 </div>
895 </main>
896
897
898<footer class="md-footer">
899
900 <div class="md-footer-nav">
901 <nav class="md-footer-nav__inner md-grid">
902
903 <a href="../" title="Index" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
904 <div class="md-flex__cell md-flex__cell--shrink">
905 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
906 </div>
907 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
908 <span class="md-flex__ellipsis">
909 <span class="md-footer-nav__direction">
910 Previous
911 </span>
912 Index
913 </span>
914 </div>
915 </a>
916
917
918 <a href="../build-tips/" title="Build Tips" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
919 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
920 <span class="md-flex__ellipsis">
921 <span class="md-footer-nav__direction">
922 Next
923 </span>
924 Build Tips
925 </span>
926 </div>
927 <div class="md-flex__cell md-flex__cell--shrink">
928 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
929 </div>
930 </a>
931
932 </nav>
933 </div>
934
935 <div class="md-footer-meta md-typeset">
936 <div class="md-footer-meta__inner md-grid">
937 <div class="md-footer-copyright">
938
939 powered by
940 <a href="https://www.mkdocs.org">MkDocs</a>
941 and
942 <a href="https://squidfunk.github.io/mkdocs-material/">
943 Material for MkDocs</a>
944 </div>
945
946 </div>
947 </div>
948</footer>
949
950 </div>
951
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]952 <script src="../../assets/javascripts/application.ac79c3b0.js"></script>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]953
954 <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
955
956
957 </body>
958</html>