Gitiles
Code Review Sign In
review.blissroms.org / Documentation-release / 5ae1c6c4441786cd3ad5bd1773c831ba13cd86bc / . / BlissRoms / build-tips / index.html
blob: 9aec3c0f012d8ca88ab10b933edffe17ff164fba [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
39 <title>Build Tips - Team Bliss</title>
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
78 <a href="#build-tips" tabindex="1" class="md-skip">
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
104 Build Tips
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 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]302 <a href="../build-guide/" title="Build Guide" class="md-nav__link">
303 Build Guide
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]304 </a>
305 </li>
306
307
308
309
310
311
312
313
314
315 <li class="md-nav__item md-nav__item--active">
316
317 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
318
319
320
321
322 <label class="md-nav__link md-nav__link--active" for="__toc">
323 Build Tips
324 </label>
325
326 <a href="./" title="Build Tips" class="md-nav__link md-nav__link--active">
327 Build Tips
328 </a>
329
330
331<nav class="md-nav md-nav--secondary">
332
333
334
335
336
337 <label class="md-nav__title" for="__toc">Table of contents</label>
338 <ul class="md-nav__list" data-md-scrollfix>
339
340 <li class="md-nav__item">
341 <a href="#repo-optimization-tips" title="repo optimization tips" class="md-nav__link">
342 repo optimization tips
343 </a>
344
345 <nav class="md-nav">
346 <ul class="md-nav__list">
347
348 <li class="md-nav__item">
349 <a href="#threads" title="Threads" class="md-nav__link">
350 Threads
351 </a>
352
353</li>
354
355 <li class="md-nav__item">
356 <a href="#current-history-only" title="Current history only" class="md-nav__link">
357 Current history only
358 </a>
359
360</li>
361
362 <li class="md-nav__item">
363 <a href="#force" title="Force" class="md-nav__link">
364 Force
365 </a>
366
367</li>
368
369 <li class="md-nav__item">
370 <a href="#minimal-fetch" title="Minimal fetch" class="md-nav__link">
371 Minimal fetch
372 </a>
373
374</li>
375
376 <li class="md-nav__item">
377 <a href="#putting-it-all-together" title="Putting it all together" class="md-nav__link">
378 Putting it all together
379 </a>
380
381</li>
382
383 </ul>
384 </nav>
385
386</li>
387
388 <li class="md-nav__item">
389 <a href="#reset-tree" title="Reset tree" class="md-nav__link">
390 Reset tree
391 </a>
392
393</li>
394
395 <li class="md-nav__item">
396 <a href="#github-cherry-pick" title="GitHub cherry-pick" class="md-nav__link">
397 GitHub cherry-pick
398 </a>
399
400</li>
401
402 <li class="md-nav__item">
403 <a href="#make-and-go-inside" title="Make and go inside" class="md-nav__link">
404 Make and go inside
405 </a>
406
407</li>
408
409
410
411
412
413 </ul>
414
415</nav>
416
417 </li>
418
419
420 </ul>
421 </nav>
422 </li>
423
424
425
426
427
428
429
430 <li class="md-nav__item md-nav__item--nested">
431
432 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
433
434 <label class="md-nav__link" for="nav-4">
435 Common
436 </label>
437 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
438 <label class="md-nav__title" for="nav-4">
439 Common
440 </label>
441 <ul class="md-nav__list" data-md-scrollfix>
442
443
444
445
446
447
448
449 <li class="md-nav__item">
450 <a href="../../common/" title="Index" class="md-nav__link">
451 Index
452 </a>
453 </li>
454
455
456
457
458
459
460
461 <li class="md-nav__item">
462 <a href="../../common/git-started/" title="Git Started" class="md-nav__link">
463 Git Started
464 </a>
465 </li>
466
467
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]468
469
470
471
472
473 <li class="md-nav__item">
474 <a href="../../common/using-dippy-bird/" title="Using `dippy-bird`" class="md-nav__link">
475 Using `dippy-bird`
476 </a>
477 </li>
478
479
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]480 </ul>
481 </nav>
482 </li>
483
484
485
486
487
488
489
490 <li class="md-nav__item md-nav__item--nested">
491
492 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
493
494 <label class="md-nav__link" for="nav-5">
495 Infrastructure
496 </label>
497 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
498 <label class="md-nav__title" for="nav-5">
499 Infrastructure
500 </label>
501 <ul class="md-nav__list" data-md-scrollfix>
502
503
504
505
506
507
508
509 <li class="md-nav__item">
510 <a href="../../infrastructure/" title="Index" class="md-nav__link">
511 Index
512 </a>
513 </li>
514
515
516 </ul>
517 </nav>
518 </li>
519
520
521 </ul>
522</nav>
523 </div>
524 </div>
525 </div>
526
527
528 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
529 <div class="md-sidebar__scrollwrap">
530 <div class="md-sidebar__inner">
531
532<nav class="md-nav md-nav--secondary">
533
534
535
536
537
538 <label class="md-nav__title" for="__toc">Table of contents</label>
539 <ul class="md-nav__list" data-md-scrollfix>
540
541 <li class="md-nav__item">
542 <a href="#repo-optimization-tips" title="repo optimization tips" class="md-nav__link">
543 repo optimization tips
544 </a>
545
546 <nav class="md-nav">
547 <ul class="md-nav__list">
548
549 <li class="md-nav__item">
550 <a href="#threads" title="Threads" class="md-nav__link">
551 Threads
552 </a>
553
554</li>
555
556 <li class="md-nav__item">
557 <a href="#current-history-only" title="Current history only" class="md-nav__link">
558 Current history only
559 </a>
560
561</li>
562
563 <li class="md-nav__item">
564 <a href="#force" title="Force" class="md-nav__link">
565 Force
566 </a>
567
568</li>
569
570 <li class="md-nav__item">
571 <a href="#minimal-fetch" title="Minimal fetch" class="md-nav__link">
572 Minimal fetch
573 </a>
574
575</li>
576
577 <li class="md-nav__item">
578 <a href="#putting-it-all-together" title="Putting it all together" class="md-nav__link">
579 Putting it all together
580 </a>
581
582</li>
583
584 </ul>
585 </nav>
586
587</li>
588
589 <li class="md-nav__item">
590 <a href="#reset-tree" title="Reset tree" class="md-nav__link">
591 Reset tree
592 </a>
593
594</li>
595
596 <li class="md-nav__item">
597 <a href="#github-cherry-pick" title="GitHub cherry-pick" class="md-nav__link">
598 GitHub cherry-pick
599 </a>
600
601</li>
602
603 <li class="md-nav__item">
604 <a href="#make-and-go-inside" title="Make and go inside" class="md-nav__link">
605 Make and go inside
606 </a>
607
608</li>
609
610
611
612
613
614 </ul>
615
616</nav>
617 </div>
618 </div>
619 </div>
620
621
622 <div class="md-content">
623 <article class="md-content__inner md-typeset">
624
625
626
627 <h1 id="build-tips">Build Tips</h1>
628<p>Here's a collective list of things you can try to improve your builds. Have fun!</p>
629<h2 id="repo-optimization-tips"><code>repo</code> optimization tips</h2>
630<h3 id="threads">Threads</h3>
631<p>By default, <code>repo</code> only utilizes four threads (or whatever the ROM manifest declares.) If you have a stronger machine with more threads, you can increase this number. So, for example, if you have 24 threads, you would type:</p>
632<pre><code>repo sync -j24
633</code></pre>
634<h3 id="current-history-only">Current history only</h3>
635<p>This should be set by default in your ROM manifest, but just in case, you can tell <code>repo</code> to only fetch recent changes. This allows for smaller downloads, which makes the sync quicker. Add the flag:</p>
636<pre><code>repo sync -c
637</code></pre>
638<h3 id="force">Force</h3>
639<p><strong>Warning! Dangerous option. Read before proceeding!</strong> Sometimes, your local history may go out of sync with remote repositories. This wouldn't be a problem if <code>repo</code> can handle it gracefully, but it doesn't and gives off a sync error. If you do not commit much, it may be worthwhile to add the force flags. Be warned though, <strong>any changes you make to the repositories WILL BE DELETED.</strong> Later down the line, if you commit a lot, you may want to remove this flag. To force sync, add the flag:</p>
640<pre><code>repo sync -f --force-sync
641</code></pre>
642<h3 id="minimal-fetch">Minimal fetch</h3>
643<p>To disable syncing clone bundles and tags, use:</p>
644<pre><code>repo sync --no-clone-bundle --no-tags
645</code></pre>
646<p>More documentation on this required, but for most developers these flags will be OK to use. This makes the sync faster as there is less information to sync over.</p>
647<h3 id="putting-it-all-together">Putting it all together</h3>
648<pre><code>repo sync -c -f -j24 --force-sync --no-clone-bundle --no-tags
649</code></pre>
650<p>That's quite long! How about we add this to our <code>.bashrc</code> as a alias? That way, we only have to type one phrase for <code>bash</code> to automatically type that out for us.</p>
651<p>Open up <code>~/.bashrc</code> and add these lines:</p>
652<pre><code># Alias to sync
653alias reposync='repo sync -c -f -j24 --force-sync --no-clone-bundle --no-tags'
654</code></pre>
655<p>This way, next time you want to sync, just type <code>reposync</code> and <code>bash</code> will substitute the command for you. Easy! Just don't forget to <code>source ~/.bashrc</code> otherwise <code>bash</code> will not know of this new alias.</p>
656<h2 id="reset-tree">Reset tree</h2>
657<p><strong>Warning! Very destructive tip. Do not use if you don't know what you are doing!</strong></p>
658<p>While messing around with device specific folders, you may break something and the build process might not work. Or, you may have multiple devices synced and you want to delete it all and start over. However, you might have limited bandwidth, and might not want to download the source over again.</p>
659<p>Add this function to your <code>~/.bashrc</code>:</p>
660<pre><code># Script to clean the source
661function resettree() {
662 rm -rf device kernel vendor out .repo/local_manifests
663 reposync
664}
665</code></pre>
666<p>Let's go over what this does, word by word:</p>
667<ul>
668<li><code>rm -rf</code>: Destructive command to erase all of the following:</li>
669<li><code>device</code> folder: Holds all device-related files</li>
670<li><code>kernel</code> folder: Holds all kernel-related files for devices</li>
671<li><code>vendor</code> folder: Holds all vendor-related files for devices AND ROM-specific vendor customizations</li>
672<li><code>out</code> folder: Stores artifacts of builds</li>
673<li><code>.repo/local_manifests</code> folder: Stores "manifest" information of devices to sync.</li>
674<li><code>reposync</code>: Executes the <code>repo sync</code> alias we made earlier.</li>
675</ul>
676<p>The last line is important, because by deleting the <code>vendor</code> folder, we also delete some crucial files for building Bliss. To fix that, we rerun a sync. Note that because we did not delete any other folders, syncing and updating files only take a fraction of a time compared to starting from scratch.</p>
677<p>To use this, after copying, don't forget to <code>source ~/.bashrc</code>. Then, run <code>resettree</code> at the base folder of the source code. Once you're done, don't forget to initialize a new device using <code>breakfast &lt;devicename&gt;</code>.</p>
678<h2 id="github-cherry-pick">GitHub cherry-pick</h2>
679<p>Thanks to @blueyes for providing the script!</p>
680<p>Copy the following into your <code>~/.bashrc</code>:</p>
681<pre><code>function gcp() {
682 COMMIT=`echo "$1" | cut -d/ -f6`
683 GH=`echo "$1" | cut -d/ -f1-3`
684 if [ "$COMMIT" != "commit" ]; then
685 echo -e "Please use a commit URL."
686 elif [ "$GH" != "https://github.com" ]; then
687 echo -e "Please use an https://github.com/ URL."
688 else
689 PROJECT=`echo "$1" | cut -d/ -f1-5`
690 git fetch $PROJECT
691 CP=`echo "$1" | cut -d/ -f7`
692 git cherry-pick $CP
693 fi
694}
695</code></pre>
696<p>To use this, <code>source ~/.bashrc</code> and then run <code>gcp &lt;GitHub commit URL here&gt;</code>.</p>
697<h2 id="make-and-go-inside">Make and go inside</h2>
698<p>This is a quick way to create and go inside a folder. Once again, copy this to your <code>~/.bashrc</code>:</p>
699<pre><code>function mkcdir ()
700{
701 mkdir -p -- "$1" &amp;&amp;
702 cd -P -- "$1"
703}
704</code></pre>
705<p>Don't forget to <code>source</code>, and run <code>mkcdir &lt;directory name&gt;</code>.</p>
706
707
708
709
710
711
712
713
714
715 </article>
716 </div>
717 </div>
718 </main>
719
720
721<footer class="md-footer">
722
723 <div class="md-footer-nav">
724 <nav class="md-footer-nav__inner md-grid">
725
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]726 <a href="../build-guide/" title="Build Guide" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]727 <div class="md-flex__cell md-flex__cell--shrink">
728 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
729 </div>
730 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
731 <span class="md-flex__ellipsis">
732 <span class="md-footer-nav__direction">
733 Previous
734 </span>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]735 Build Guide
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]736 </span>
737 </div>
738 </a>
739
740
741 <a href="../../common/" title="Index" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
742 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
743 <span class="md-flex__ellipsis">
744 <span class="md-footer-nav__direction">
745 Next
746 </span>
747 Index
748 </span>
749 </div>
750 <div class="md-flex__cell md-flex__cell--shrink">
751 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
752 </div>
753 </a>
754
755 </nav>
756 </div>
757
758 <div class="md-footer-meta md-typeset">
759 <div class="md-footer-meta__inner md-grid">
760 <div class="md-footer-copyright">
761
762 powered by
763 <a href="https://www.mkdocs.org">MkDocs</a>
764 and
765 <a href="https://squidfunk.github.io/mkdocs-material/">
766 Material for MkDocs</a>
767 </div>
768
769 </div>
770 </div>
771</footer>
772
773 </div>
774
775 <script src="../../assets/javascripts/application.245445c6.js"></script>
776
777 <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
778
779
780 </body>
781</html>