Gitiles
Code Review Sign In
review.blissroms.org / Documentation-release / d09b00ec1eb7b950785adae7b1f90f8628b275c0 / . / BlissRoms / build-guide / index.html
blob: 505ac60d3e71bff8ba3757c95df63cb47560960f [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">
Eric Parkd09b00e2020-02-15 11:07:48 +0900[diff] [blame^]240 <a href="../../Bliss OS/installation-guide-misc/" title="Installation Guide (Misc)" class="md-nav__link">
241 Installation Guide (Misc)
242 </a>
243 </li>
244
245
246
247
248
249
250
251 <li class="md-nav__item">
252 <a href="../../Bliss OS/installation-guide-surface-devices/" title="Installation Guide (Surface devices)" class="md-nav__link">
253 Installation Guide (Surface devices)
254 </a>
255 </li>
256
257
258
259
260
261
262
263 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]264 <a href="../../Bliss OS/installation-guide/" title="Installation Guide" class="md-nav__link">
265 Installation Guide
266 </a>
267 </li>
268
269
270
271
272
273
274
275 <li class="md-nav__item">
276 <a href="../../Bliss OS/troubleshooting/" title="Troubleshooting" class="md-nav__link">
277 Troubleshooting
278 </a>
279 </li>
280
281
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]282 </ul>
283 </nav>
284 </li>
285
286
287
288
289
290
291
292
293
294 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
295
296 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked>
297
298 <label class="md-nav__link" for="nav-3">
299 BlissRoms
300 </label>
301 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
302 <label class="md-nav__title" for="nav-3">
303 BlissRoms
304 </label>
305 <ul class="md-nav__list" data-md-scrollfix>
306
307
308
309
310
311
312
313 <li class="md-nav__item">
314 <a href="../" title="Index" class="md-nav__link">
315 Index
316 </a>
317 </li>
318
319
320
321
322
323
324
325
326
327 <li class="md-nav__item md-nav__item--active">
328
329 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
330
331
332
333
334 <label class="md-nav__link md-nav__link--active" for="__toc">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]335 Build Guide
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]336 </label>
337
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]338 <a href="./" title="Build Guide" class="md-nav__link md-nav__link--active">
339 Build Guide
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]340 </a>
341
342
343<nav class="md-nav md-nav--secondary">
344
345
346
347
348
349 <label class="md-nav__title" for="__toc">Table of contents</label>
350 <ul class="md-nav__list" data-md-scrollfix>
351
352 <li class="md-nav__item">
Eric Parkd5cc44a2019-10-21 12:15:48 +0800[diff] [blame]353 <a href="#updated-for-android-10-q" class="md-nav__link">
354 Updated for Android 10 (q)
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]355 </a>
356
357 <nav class="md-nav">
358 <ul class="md-nav__list">
359
360 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]361 <a href="#introduction" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]362 Introduction
363 </a>
364
365</li>
366
367 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]368 <a href="#preparation" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]369 Preparation
370 </a>
371
372</li>
373
374 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]375 <a href="#install-the-jdk" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]376 Install the JDK
377 </a>
378
379</li>
380
381 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]382 <a href="#install-build-tools" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]383 Install build tools
384 </a>
385
386</li>
387
388 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]389 <a href="#install-source-code-tools" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]390 Install source code tools
391 </a>
392
393 <nav class="md-nav">
394 <ul class="md-nav__list">
395
396 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]397 <a href="#what-is-source" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]398 What is source?
399 </a>
400
401</li>
402
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]403 </ul>
404 </nav>
405
406</li>
407
408 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]409 <a href="#download" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]410 Download
411 </a>
412
413</li>
414
415 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]416 <a href="#build" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]417 Build
418 </a>
419
420 <nav class="md-nav">
421 <ul class="md-nav__list">
422
423 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]424 <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]425 My device isn't booting, and userdebug won't print any adb logcats. What gives?
426 </a>
427
428</li>
429
430 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]431 <a href="#why-mka-and-not-make" class="md-nav__link">
Eric Park35d8ee32019-08-11 01:34:35 +0800[diff] [blame]432 Why mka and not make?
433 </a>
434
435</li>
436
437 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]438 <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]439 I get an error about no blissify targets to build against, what's wrong?
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]440 </a>
441
442</li>
443
444 </ul>
445 </nav>
446
447</li>
448
449 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]450 <a href="#after-building" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]451 After building
452 </a>
453
454</li>
455
456 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]457 <a href="#troubleshooting" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]458 Troubleshooting
459 </a>
460
461</li>
462
463 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]464 <a href="#conclusion" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]465 Conclusion
466 </a>
467
468</li>
469
470 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]471 <a href="#looking-for-the-next-tutorial" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]472 Looking for the next tutorial?
473 </a>
474
475</li>
476
477 </ul>
478 </nav>
479
480</li>
481
482
483
484
485
486 </ul>
487
488</nav>
489
490 </li>
491
492
493
494
495
496
497
498 <li class="md-nav__item">
499 <a href="../build-tips/" title="Build Tips" class="md-nav__link">
500 Build Tips
501 </a>
502 </li>
503
504
505 </ul>
506 </nav>
507 </li>
508
509
510
511
512
513
514
515 <li class="md-nav__item md-nav__item--nested">
516
517 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
518
519 <label class="md-nav__link" for="nav-4">
520 Common
521 </label>
522 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
523 <label class="md-nav__title" for="nav-4">
524 Common
525 </label>
526 <ul class="md-nav__list" data-md-scrollfix>
527
528
529
530
531
532
533
534 <li class="md-nav__item">
535 <a href="../../common/" title="Index" class="md-nav__link">
536 Index
537 </a>
538 </li>
539
540
541
542
543
544
545
546 <li class="md-nav__item">
547 <a href="../../common/git-started/" title="Git Started" class="md-nav__link">
548 Git Started
549 </a>
550 </li>
551
552
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]553
554
555
556
557
558 <li class="md-nav__item">
Eric Park8584eda2019-09-02 09:45:55 +0800[diff] [blame]559 <a href="../../common/maintaining-proper-authorship/" title="Maintaining proper authorship" class="md-nav__link">
560 Maintaining proper authorship
561 </a>
562 </li>
563
564
565
566
567
568
569
570 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]571 <a href="../../common/using-dippy-bird/" title="Using `dippy-bird`" class="md-nav__link">
572 Using `dippy-bird`
573 </a>
574 </li>
575
576
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]577 </ul>
578 </nav>
579 </li>
580
581
582
583
584
585
586
587 <li class="md-nav__item md-nav__item--nested">
588
589 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
590
591 <label class="md-nav__link" for="nav-5">
592 Infrastructure
593 </label>
594 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
595 <label class="md-nav__title" for="nav-5">
596 Infrastructure
597 </label>
598 <ul class="md-nav__list" data-md-scrollfix>
599
600
601
602
603
604
605
606 <li class="md-nav__item">
607 <a href="../../infrastructure/" title="Index" class="md-nav__link">
608 Index
609 </a>
610 </li>
611
612
613 </ul>
614 </nav>
615 </li>
616
617
618 </ul>
619</nav>
620 </div>
621 </div>
622 </div>
623
624
625 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
626 <div class="md-sidebar__scrollwrap">
627 <div class="md-sidebar__inner">
628
629<nav class="md-nav md-nav--secondary">
630
631
632
633
634
635 <label class="md-nav__title" for="__toc">Table of contents</label>
636 <ul class="md-nav__list" data-md-scrollfix>
637
638 <li class="md-nav__item">
Eric Parkd5cc44a2019-10-21 12:15:48 +0800[diff] [blame]639 <a href="#updated-for-android-10-q" class="md-nav__link">
640 Updated for Android 10 (q)
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]641 </a>
642
643 <nav class="md-nav">
644 <ul class="md-nav__list">
645
646 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]647 <a href="#introduction" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]648 Introduction
649 </a>
650
651</li>
652
653 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]654 <a href="#preparation" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]655 Preparation
656 </a>
657
658</li>
659
660 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]661 <a href="#install-the-jdk" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]662 Install the JDK
663 </a>
664
665</li>
666
667 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]668 <a href="#install-build-tools" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]669 Install build tools
670 </a>
671
672</li>
673
674 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]675 <a href="#install-source-code-tools" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]676 Install source code tools
677 </a>
678
679 <nav class="md-nav">
680 <ul class="md-nav__list">
681
682 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]683 <a href="#what-is-source" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]684 What is source?
685 </a>
686
687</li>
688
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]689 </ul>
690 </nav>
691
692</li>
693
694 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]695 <a href="#download" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]696 Download
697 </a>
698
699</li>
700
701 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]702 <a href="#build" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]703 Build
704 </a>
705
706 <nav class="md-nav">
707 <ul class="md-nav__list">
708
709 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]710 <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]711 My device isn't booting, and userdebug won't print any adb logcats. What gives?
712 </a>
713
714</li>
715
716 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]717 <a href="#why-mka-and-not-make" class="md-nav__link">
Eric Park35d8ee32019-08-11 01:34:35 +0800[diff] [blame]718 Why mka and not make?
719 </a>
720
721</li>
722
723 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]724 <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]725 I get an error about no blissify targets to build against, what's wrong?
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]726 </a>
727
728</li>
729
730 </ul>
731 </nav>
732
733</li>
734
735 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]736 <a href="#after-building" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]737 After building
738 </a>
739
740</li>
741
742 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]743 <a href="#troubleshooting" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]744 Troubleshooting
745 </a>
746
747</li>
748
749 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]750 <a href="#conclusion" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]751 Conclusion
752 </a>
753
754</li>
755
756 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]757 <a href="#looking-for-the-next-tutorial" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]758 Looking for the next tutorial?
759 </a>
760
761</li>
762
763 </ul>
764 </nav>
765
766</li>
767
768
769
770
771
772 </ul>
773
774</nav>
775 </div>
776 </div>
777 </div>
778
779
780 <div class="md-content">
781 <article class="md-content__inner md-typeset">
782
783
784
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]785 <h1 id="build-guide">Build Guide</h1>
Eric Parkd5cc44a2019-10-21 12:15:48 +0800[diff] [blame]786<h2 id="updated-for-android-10-q">Updated for Android 10 (q)</h2>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]787<h3 id="introduction">Introduction</h3>
788<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>
789<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>
790<p>Let’s get started.</p>
791<h3 id="preparation">Preparation</h3>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]792<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>
793<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]794<h3 id="install-the-jdk">Install the JDK</h3>
795<p>Install OpenJDK:</p>
796<pre><code>sudo apt install openjdk-8-jdk
797</code></pre>
798<h3 id="install-build-tools">Install build tools</h3>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]799<p>To install the required build tools, run the following command:</p>
800<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]801</code></pre>
802<h3 id="install-source-code-tools">Install source code tools</h3>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]803<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]804<p>Create a <code>~/bin</code> directory for <code>repo</code>:</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]805<pre><code>mkdir -p ~/bin
806</code></pre>
807<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>
808<pre><code>curl https://storage.googleapis.com/git-repo-downloads/repo &gt; ~/bin/repo
809</code></pre>
810<p>Make <code>repo</code> executable:</p>
811<pre><code>chmod a+x ~/bin/repo
812</code></pre>
813<p>And add it to PATH:</p>
814<pre><code>nano .bashrc
815</code></pre>
816<p>Scroll to the end of the file and type these lines:</p>
817<pre><code># Export ~/bin
818export PATH=~/bin:$PATH
819</code></pre>
820<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>
821<pre><code>source .bashrc
822</code></pre>
823<p>Which can be shortened to:</p>
824<pre><code>. .bashrc
825</code></pre>
826<h4 id="what-is-source">What is <code>source</code>?</h4>
827<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>
828<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]829<h3 id="download">Download</h3>
830<p>Create a directory for the source:</p>
Eric Parkd5cc44a2019-10-21 12:15:48 +0800[diff] [blame]831<pre><code>mkdir -p ~/bliss/q
832cd ~/bliss/q
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]833</code></pre>
834<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]835<pre><code>git config --global user.email "john.appleseed@example.com"
836git config --global user.name "John Appleseed"
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]837</code></pre>
838<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]839<pre><code>repo init -u https://github.com/BlissRoms/platform_manifest.git -b q
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]840</code></pre>
Eric Parkd5cc44a2019-10-21 12:15:48 +0800[diff] [blame]841<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]842<p>Then sync the source:</p>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]843<pre><code>repo sync -j$(nproc --all) -c
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]844</code></pre>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]845<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]846<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>
847<h3 id="build">Build</h3>
848<p>Set up the build environment:</p>
849<pre><code>. build/envsetup.sh
850</code></pre>
851<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>
852<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>
853<pre><code>breakfast bullhead
854</code></pre>
855<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>
856<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>
857<pre><code>croot
858</code></pre>
859<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]860<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>
861<pre><code>lunch bliss_bullhead-userdebug
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]862</code></pre>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]863<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>
864<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>
865<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>
866<p>All set? Let's start the building process. Run:</p>
Eric Park35d8ee32019-08-11 01:34:35 +0800[diff] [blame]867<p><code>mka blissify</code></p>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]868<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]869<h4 id="why-mka-and-not-make">Why <code>mka</code> and not <code>make</code>?</h4>
870<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]871<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]872<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>
873<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>
874<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>
875<pre><code>blissify bullhead
876</code></pre>
877<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]878<pre><code>breakfast bullhead
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]879lunch bliss_bullhead-userdebug
880make blissify
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]881</code></pre>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]882<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]883<h3 id="after-building">After building</h3>
884<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>
885<p>If you face the latter, congratulations! You've successfully built BlissRoms for your device. Grab the artifacts for your device:</p>
886<pre><code>cd out/target/product/bullhead/
887</code></pre>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]888<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]889<h3 id="troubleshooting">Troubleshooting</h3>
890<p>If your build failed, there are a couple things you can try.</p>
891<ul>
892<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>
893<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>
894<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>
895<li>Make sure you’re at the root of the build tree. Again, to quickly jump there, use <code>croot</code>.</li>
896<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]897<li>Make sure your computer meets minimum requirements to compile AOSP. Chances are, you need more memory/CPU power to complete a build.</li>
898<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]899</ul>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]900<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]901<h3 id="conclusion">Conclusion</h3>
902<p>Building a ROM is very hard and tedious and the results are very rewarding! If you managed to follow along, congratulations!</p>
903<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>
904<p>-- Eric Park (ideaman924)</p>
905<h3 id="looking-for-the-next-tutorial">Looking for the next tutorial?</h3>
906<p>Check out <a href="../build-tips/">some tips to optimize your build experience.</a></p>
907
908
909
910
911
912
913
914
915
916 </article>
917 </div>
918 </div>
919 </main>
920
921
922<footer class="md-footer">
923
924 <div class="md-footer-nav">
925 <nav class="md-footer-nav__inner md-grid">
926
927 <a href="../" title="Index" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
928 <div class="md-flex__cell md-flex__cell--shrink">
929 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
930 </div>
931 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
932 <span class="md-flex__ellipsis">
933 <span class="md-footer-nav__direction">
934 Previous
935 </span>
936 Index
937 </span>
938 </div>
939 </a>
940
941
942 <a href="../build-tips/" title="Build Tips" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
943 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
944 <span class="md-flex__ellipsis">
945 <span class="md-footer-nav__direction">
946 Next
947 </span>
948 Build Tips
949 </span>
950 </div>
951 <div class="md-flex__cell md-flex__cell--shrink">
952 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
953 </div>
954 </a>
955
956 </nav>
957 </div>
958
959 <div class="md-footer-meta md-typeset">
960 <div class="md-footer-meta__inner md-grid">
961 <div class="md-footer-copyright">
962
963 powered by
964 <a href="https://www.mkdocs.org">MkDocs</a>
965 and
966 <a href="https://squidfunk.github.io/mkdocs-material/">
967 Material for MkDocs</a>
968 </div>
969
970 </div>
971 </div>
972</footer>
973
974 </div>
975
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]976 <script src="../../assets/javascripts/application.ac79c3b0.js"></script>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]977
978 <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
979
980
981 </body>
982</html>