Gitiles
Code Review Sign In
review.blissroms.org / Documentation-release / 8584edae205cb7f7b7652e72000f057281af161c / . / BlissRoms / build-guide / index.html
blob: d55eac7c9830bc6dca4bab9034d5abbac88d7ef6 [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">
35 <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.0">
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
43 <link rel="stylesheet" href="../../assets/stylesheets/application.0284f74d.css">
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
148 <main class="md-main">
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">
329 <a href="#updated-for-pie-p90" title="Updated for Pie (p9.0)" class="md-nav__link">
330 Updated for Pie (p9.0)
331 </a>
332
333 <nav class="md-nav">
334 <ul class="md-nav__list">
335
336 <li class="md-nav__item">
337 <a href="#introduction" title="Introduction" class="md-nav__link">
338 Introduction
339 </a>
340
341</li>
342
343 <li class="md-nav__item">
344 <a href="#preparation" title="Preparation" class="md-nav__link">
345 Preparation
346 </a>
347
348</li>
349
350 <li class="md-nav__item">
351 <a href="#install-the-jdk" title="Install the JDK" class="md-nav__link">
352 Install the JDK
353 </a>
354
355</li>
356
357 <li class="md-nav__item">
358 <a href="#install-build-tools" title="Install build tools" class="md-nav__link">
359 Install build tools
360 </a>
361
362</li>
363
364 <li class="md-nav__item">
365 <a href="#install-source-code-tools" title="Install source code tools" class="md-nav__link">
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">
373 <a href="#what-is-source" title="What is source?" class="md-nav__link">
374 What is source?
375 </a>
376
377</li>
378
379 <li class="md-nav__item">
380 <a href="#what-if-i-need-repo-globally" title="What if I need repo globally?" class="md-nav__link">
381 What if I need repo globally?
382 </a>
383
384</li>
385
386 </ul>
387 </nav>
388
389</li>
390
391 <li class="md-nav__item">
392 <a href="#download" title="Download" class="md-nav__link">
393 Download
394 </a>
395
Eric Park35d8ee32019-08-11 01:34:35 +0800[diff] [blame]396 <nav class="md-nav">
397 <ul class="md-nav__list">
398
399 <li class="md-nav__item">
400 <a href="#i-still-dont-know-how-much-cpu-threads-i-have-how-do-i-check" title="I still don't know how much CPU threads I have. How do I check?" class="md-nav__link">
401 I still don't know how much CPU threads I have. How do I check?
402 </a>
403
404</li>
405
406 </ul>
407 </nav>
408
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]409</li>
410
411 <li class="md-nav__item">
412 <a href="#build" title="Build" class="md-nav__link">
413 Build
414 </a>
415
416 <nav class="md-nav">
417 <ul class="md-nav__list">
418
419 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]420 <a href="#my-device-isnt-booting-and-userdebug-wont-print-any-adb-logcats-what-gives" title="My device isn't booting, and userdebug won't print any adb logcats. What gives?" class="md-nav__link">
421 My device isn't booting, and userdebug won't print any adb logcats. What gives?
422 </a>
423
424</li>
425
426 <li class="md-nav__item">
Eric Park35d8ee32019-08-11 01:34:35 +0800[diff] [blame]427 <a href="#why-mka-and-not-make" title="Why mka and not make?" class="md-nav__link">
428 Why mka and not make?
429 </a>
430
431</li>
432
433 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]434 <a href="#i-get-an-error-about-no-blissify-targets-to-build-against-whats-wrong" title="I get an error about no blissify targets to build against, what's wrong?" class="md-nav__link">
435 I get an error about no blissify targets to build against, what's wrong?
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]436 </a>
437
438</li>
439
440 </ul>
441 </nav>
442
443</li>
444
445 <li class="md-nav__item">
446 <a href="#after-building" title="After building" class="md-nav__link">
447 After building
448 </a>
449
450</li>
451
452 <li class="md-nav__item">
453 <a href="#troubleshooting" title="Troubleshooting" class="md-nav__link">
454 Troubleshooting
455 </a>
456
457</li>
458
459 <li class="md-nav__item">
460 <a href="#conclusion" title="Conclusion" class="md-nav__link">
461 Conclusion
462 </a>
463
464</li>
465
466 <li class="md-nav__item">
467 <a href="#looking-for-the-next-tutorial" title="Looking for the next tutorial?" class="md-nav__link">
468 Looking for the next tutorial?
469 </a>
470
471</li>
472
473 </ul>
474 </nav>
475
476</li>
477
478
479
480
481
482 </ul>
483
484</nav>
485
486 </li>
487
488
489
490
491
492
493
494 <li class="md-nav__item">
495 <a href="../build-tips/" title="Build Tips" class="md-nav__link">
496 Build Tips
497 </a>
498 </li>
499
500
501 </ul>
502 </nav>
503 </li>
504
505
506
507
508
509
510
511 <li class="md-nav__item md-nav__item--nested">
512
513 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
514
515 <label class="md-nav__link" for="nav-4">
516 Common
517 </label>
518 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
519 <label class="md-nav__title" for="nav-4">
520 Common
521 </label>
522 <ul class="md-nav__list" data-md-scrollfix>
523
524
525
526
527
528
529
530 <li class="md-nav__item">
531 <a href="../../common/" title="Index" class="md-nav__link">
532 Index
533 </a>
534 </li>
535
536
537
538
539
540
541
542 <li class="md-nav__item">
543 <a href="../../common/git-started/" title="Git Started" class="md-nav__link">
544 Git Started
545 </a>
546 </li>
547
548
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]549
550
551
552
553
554 <li class="md-nav__item">
Eric Park8584eda2019-09-02 09:45:55 +0800[diff] [blame^]555 <a href="../../common/maintaining-proper-authorship/" title="Maintaining proper authorship" class="md-nav__link">
556 Maintaining proper authorship
557 </a>
558 </li>
559
560
561
562
563
564
565
566 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]567 <a href="../../common/using-dippy-bird/" title="Using `dippy-bird`" class="md-nav__link">
568 Using `dippy-bird`
569 </a>
570 </li>
571
572
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]573 </ul>
574 </nav>
575 </li>
576
577
578
579
580
581
582
583 <li class="md-nav__item md-nav__item--nested">
584
585 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
586
587 <label class="md-nav__link" for="nav-5">
588 Infrastructure
589 </label>
590 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
591 <label class="md-nav__title" for="nav-5">
592 Infrastructure
593 </label>
594 <ul class="md-nav__list" data-md-scrollfix>
595
596
597
598
599
600
601
602 <li class="md-nav__item">
603 <a href="../../infrastructure/" title="Index" class="md-nav__link">
604 Index
605 </a>
606 </li>
607
608
609 </ul>
610 </nav>
611 </li>
612
613
614 </ul>
615</nav>
616 </div>
617 </div>
618 </div>
619
620
621 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
622 <div class="md-sidebar__scrollwrap">
623 <div class="md-sidebar__inner">
624
625<nav class="md-nav md-nav--secondary">
626
627
628
629
630
631 <label class="md-nav__title" for="__toc">Table of contents</label>
632 <ul class="md-nav__list" data-md-scrollfix>
633
634 <li class="md-nav__item">
635 <a href="#updated-for-pie-p90" title="Updated for Pie (p9.0)" class="md-nav__link">
636 Updated for Pie (p9.0)
637 </a>
638
639 <nav class="md-nav">
640 <ul class="md-nav__list">
641
642 <li class="md-nav__item">
643 <a href="#introduction" title="Introduction" class="md-nav__link">
644 Introduction
645 </a>
646
647</li>
648
649 <li class="md-nav__item">
650 <a href="#preparation" title="Preparation" class="md-nav__link">
651 Preparation
652 </a>
653
654</li>
655
656 <li class="md-nav__item">
657 <a href="#install-the-jdk" title="Install the JDK" class="md-nav__link">
658 Install the JDK
659 </a>
660
661</li>
662
663 <li class="md-nav__item">
664 <a href="#install-build-tools" title="Install build tools" class="md-nav__link">
665 Install build tools
666 </a>
667
668</li>
669
670 <li class="md-nav__item">
671 <a href="#install-source-code-tools" title="Install source code tools" class="md-nav__link">
672 Install source code tools
673 </a>
674
675 <nav class="md-nav">
676 <ul class="md-nav__list">
677
678 <li class="md-nav__item">
679 <a href="#what-is-source" title="What is source?" class="md-nav__link">
680 What is source?
681 </a>
682
683</li>
684
685 <li class="md-nav__item">
686 <a href="#what-if-i-need-repo-globally" title="What if I need repo globally?" class="md-nav__link">
687 What if I need repo globally?
688 </a>
689
690</li>
691
692 </ul>
693 </nav>
694
695</li>
696
697 <li class="md-nav__item">
698 <a href="#download" title="Download" class="md-nav__link">
699 Download
700 </a>
701
Eric Park35d8ee32019-08-11 01:34:35 +0800[diff] [blame]702 <nav class="md-nav">
703 <ul class="md-nav__list">
704
705 <li class="md-nav__item">
706 <a href="#i-still-dont-know-how-much-cpu-threads-i-have-how-do-i-check" title="I still don't know how much CPU threads I have. How do I check?" class="md-nav__link">
707 I still don't know how much CPU threads I have. How do I check?
708 </a>
709
710</li>
711
712 </ul>
713 </nav>
714
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]715</li>
716
717 <li class="md-nav__item">
718 <a href="#build" title="Build" class="md-nav__link">
719 Build
720 </a>
721
722 <nav class="md-nav">
723 <ul class="md-nav__list">
724
725 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]726 <a href="#my-device-isnt-booting-and-userdebug-wont-print-any-adb-logcats-what-gives" title="My device isn't booting, and userdebug won't print any adb logcats. What gives?" class="md-nav__link">
727 My device isn't booting, and userdebug won't print any adb logcats. What gives?
728 </a>
729
730</li>
731
732 <li class="md-nav__item">
Eric Park35d8ee32019-08-11 01:34:35 +0800[diff] [blame]733 <a href="#why-mka-and-not-make" title="Why mka and not make?" class="md-nav__link">
734 Why mka and not make?
735 </a>
736
737</li>
738
739 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]740 <a href="#i-get-an-error-about-no-blissify-targets-to-build-against-whats-wrong" title="I get an error about no blissify targets to build against, what's wrong?" class="md-nav__link">
741 I get an error about no blissify targets to build against, what's wrong?
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]742 </a>
743
744</li>
745
746 </ul>
747 </nav>
748
749</li>
750
751 <li class="md-nav__item">
752 <a href="#after-building" title="After building" class="md-nav__link">
753 After building
754 </a>
755
756</li>
757
758 <li class="md-nav__item">
759 <a href="#troubleshooting" title="Troubleshooting" class="md-nav__link">
760 Troubleshooting
761 </a>
762
763</li>
764
765 <li class="md-nav__item">
766 <a href="#conclusion" title="Conclusion" class="md-nav__link">
767 Conclusion
768 </a>
769
770</li>
771
772 <li class="md-nav__item">
773 <a href="#looking-for-the-next-tutorial" title="Looking for the next tutorial?" class="md-nav__link">
774 Looking for the next tutorial?
775 </a>
776
777</li>
778
779 </ul>
780 </nav>
781
782</li>
783
784
785
786
787
788 </ul>
789
790</nav>
791 </div>
792 </div>
793 </div>
794
795
796 <div class="md-content">
797 <article class="md-content__inner md-typeset">
798
799
800
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]801 <h1 id="build-guide">Build Guide</h1>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]802<h2 id="updated-for-pie-p90">Updated for Pie (p9.0)</h2>
803<h3 id="introduction">Introduction</h3>
804<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>
805<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>
806<p>Let’s get started.</p>
807<h3 id="preparation">Preparation</h3>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]808<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>
809<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]810<h3 id="install-the-jdk">Install the JDK</h3>
811<p>Install OpenJDK:</p>
812<pre><code>sudo apt install openjdk-8-jdk
813</code></pre>
814<h3 id="install-build-tools">Install build tools</h3>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]815<p>To install the required build tools, run the following command:</p>
816<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]817</code></pre>
818<h3 id="install-source-code-tools">Install source code tools</h3>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]819<p>Now we need to get the source code via a program named <code>repo</code>, made by Google. 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>
820<p>Create a <code>~/bin</code> directory for <code>repo</code>:</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]821<pre><code>mkdir -p ~/bin
822</code></pre>
823<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>
824<pre><code>curl https://storage.googleapis.com/git-repo-downloads/repo &gt; ~/bin/repo
825</code></pre>
826<p>Make <code>repo</code> executable:</p>
827<pre><code>chmod a+x ~/bin/repo
828</code></pre>
829<p>And add it to PATH:</p>
830<pre><code>nano .bashrc
831</code></pre>
832<p>Scroll to the end of the file and type these lines:</p>
833<pre><code># Export ~/bin
834export PATH=~/bin:$PATH
835</code></pre>
836<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>
837<pre><code>source .bashrc
838</code></pre>
839<p>Which can be shortened to:</p>
840<pre><code>. .bashrc
841</code></pre>
842<h4 id="what-is-source">What is <code>source</code>?</h4>
843<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>
844<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>
845<h4 id="what-if-i-need-repo-globally">What if I need <code>repo</code> globally?</h4>
846<p>If you need the <code>repo</code> tool to be available anywhere, you will need to first download <code>repo</code> to your home directory, move it with <code>sudo</code> and give it executable permissions. The exact commands are as follows:</p>
847<pre><code>curl https://storage.googleapis.com/git-repo-downloads/repo &gt; ~/repo
848sudo mv ~/repo /usr/bin/
849chmod a+x /usr/bin/repo
850</code></pre>
851<p><code>repo</code> will now work anywhere, without any <code>.bashrc</code> modifications. However, these steps aren’t recommended as <code>repo</code> might become a security risk if a vulnerability is found.</p>
852<p>Now we’re ready to download the source code.</p>
853<h3 id="download">Download</h3>
854<p>Create a directory for the source:</p>
855<pre><code>mkdir -p ~/bliss/p9.0
856cd ~/bliss/p9.0
857</code></pre>
858<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>
859<pre><code>git config --global user.email “randy.mcrandyface@hotmail.net”
860git config --global user.name “Randy McRandyface”
861</code></pre>
862<p>Now, we’re ready to initialize. We need to tell <code>repo</code> which manifest to read:</p>
863<pre><code>repo init -u https://github.com/BlissRoms/platform_manifest.git -b p9.0
864</code></pre>
865<p><code>-b</code> is for the branch, and we’re on <code>p9.0</code>, Android Pie. It’ll take a couple of seconds. You may need to type <code>y</code> for the color prompt.</p>
866<p>Then sync the source:</p>
867<pre><code>repo sync -j24 -c
868</code></pre>
869<p><code>-j</code> is for threads. Typically, your CPU core count is your thread count, unless you’re using an older Intel CPU with hyperthreading. In that case, the thread count is double the count of your CPU cores. Newer CPUs have dropped hyperthreading unless you have the i9, so check how many threads you have. If you have four threads, you would run:</p>
870<pre><code>repo sync -j4 -c
871</code></pre>
872<p><code>-c</code> is for pulling in only the current branch, instead of the entire history. This is useful if you need the downloads fast and don’t want the entire history to be downloaded. This is used by default unless specified otherwise.</p>
Eric Park35d8ee32019-08-11 01:34:35 +0800[diff] [blame]873<h4 id="i-still-dont-know-how-much-cpu-threads-i-have-how-do-i-check">I still don't know how much CPU threads I have. How do I check?</h4>
874<p>Run <code>nproc</code>. The output should be something like this:</p>
875<pre><code>rwaterspf1@test:~$ nproc
87624
877</code></pre>
878<p>This means that there are 24 threads in your machine.</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]879<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>
880<h3 id="build">Build</h3>
881<p>Set up the build environment:</p>
882<pre><code>. build/envsetup.sh
883</code></pre>
884<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>
885<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>
886<pre><code>breakfast bullhead
887</code></pre>
888<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>
889<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>
890<pre><code>croot
891</code></pre>
892<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]893<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>
894<pre><code>lunch bliss_bullhead-userdebug
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]895</code></pre>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]896<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>
897<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>
898<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>
899<p>All set? Let's start the building process. Run:</p>
Eric Park35d8ee32019-08-11 01:34:35 +0800[diff] [blame]900<p><code>mka blissify</code></p>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]901<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]902<h4 id="why-mka-and-not-make">Why <code>mka</code> and not <code>make</code>?</h4>
903<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>
904<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 -j#</code>, replacing the hash with the number of threads (example of <code>make -j4</code>).</p>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]905<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>
906<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>
907<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>
908<pre><code>blissify bullhead
909</code></pre>
910<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]911<pre><code>breakfast bullhead
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]912lunch bliss_bullhead-userdebug
913make blissify
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]914</code></pre>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]915<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]916<h3 id="after-building">After building</h3>
917<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>
918<p>If you face the latter, congratulations! You've successfully built BlissRoms for your device. Grab the artifacts for your device:</p>
919<pre><code>cd out/target/product/bullhead/
920</code></pre>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]921<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]922<h3 id="troubleshooting">Troubleshooting</h3>
923<p>If your build failed, there are a couple things you can try.</p>
924<ul>
925<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>
926<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>
927<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>
928<li>Make sure you’re at the root of the build tree. Again, to quickly jump there, use <code>croot</code>.</li>
929<li>Make sure you ran <code>breakfast</code> correctly and it did not error out. Missing device files will prevent successful builds.</li>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]930<li>Make sure your computer itself isn’t faulty. HDDs usually die first, followed by RAM. SSDs rarely die but failure is not unheard of. In extremely rare cases, your CPU may have a defect. If you're unsure, run a stress test using a program like Prime95.</li>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]931</ul>
932<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 our Telegram Build Support chat.</p>
933<h3 id="conclusion">Conclusion</h3>
934<p>Building a ROM is very hard and tedious and the results are very rewarding! If you managed to follow along, congratulations!</p>
935<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>
936<p>-- Eric Park (ideaman924)</p>
937<h3 id="looking-for-the-next-tutorial">Looking for the next tutorial?</h3>
938<p>Check out <a href="../build-tips/">some tips to optimize your build experience.</a></p>
939
940
941
942
943
944
945
946
947
948 </article>
949 </div>
950 </div>
951 </main>
952
953
954<footer class="md-footer">
955
956 <div class="md-footer-nav">
957 <nav class="md-footer-nav__inner md-grid">
958
959 <a href="../" title="Index" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
960 <div class="md-flex__cell md-flex__cell--shrink">
961 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
962 </div>
963 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
964 <span class="md-flex__ellipsis">
965 <span class="md-footer-nav__direction">
966 Previous
967 </span>
968 Index
969 </span>
970 </div>
971 </a>
972
973
974 <a href="../build-tips/" title="Build Tips" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
975 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
976 <span class="md-flex__ellipsis">
977 <span class="md-footer-nav__direction">
978 Next
979 </span>
980 Build Tips
981 </span>
982 </div>
983 <div class="md-flex__cell md-flex__cell--shrink">
984 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
985 </div>
986 </a>
987
988 </nav>
989 </div>
990
991 <div class="md-footer-meta md-typeset">
992 <div class="md-footer-meta__inner md-grid">
993 <div class="md-footer-copyright">
994
995 powered by
996 <a href="https://www.mkdocs.org">MkDocs</a>
997 and
998 <a href="https://squidfunk.github.io/mkdocs-material/">
999 Material for MkDocs</a>
1000 </div>
1001
1002 </div>
1003 </div>
1004</footer>
1005
1006 </div>
1007
1008 <script src="../../assets/javascripts/application.245445c6.js"></script>
1009
1010 <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
1011
1012
1013 </body>
1014</html>