Gitiles
Code Review Sign In
review.blissroms.org / Documentation-release / d09b00ec1eb7b950785adae7b1f90f8628b275c0 / . / BlissRoms / build-tips / index.html
blob: 564e2390bad6a384d588fa307716951ebd3fe9b7 [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
39 <title>Build Tips - Team Bliss</title>
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
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
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 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]326 <a href="../build-guide/" title="Build Guide" class="md-nav__link">
327 Build Guide
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]328 </a>
329 </li>
330
331
332
333
334
335
336
337
338
339 <li class="md-nav__item md-nav__item--active">
340
341 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
342
343
344
345
346 <label class="md-nav__link md-nav__link--active" for="__toc">
347 Build Tips
348 </label>
349
350 <a href="./" title="Build Tips" class="md-nav__link md-nav__link--active">
351 Build Tips
352 </a>
353
354
355<nav class="md-nav md-nav--secondary">
356
357
358
359
360
361 <label class="md-nav__title" for="__toc">Table of contents</label>
362 <ul class="md-nav__list" data-md-scrollfix>
363
364 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]365 <a href="#repo-optimization-tips" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]366 repo optimization tips
367 </a>
368
369 <nav class="md-nav">
370 <ul class="md-nav__list">
371
372 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]373 <a href="#threads" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]374 Threads
375 </a>
376
377</li>
378
379 <li class="md-nav__item">
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]380 <a href="#current-branch-only" class="md-nav__link">
381 Current branch only
382 </a>
383
384</li>
385
386 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]387 <a href="#current-history-only" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]388 Current history only
389 </a>
390
391</li>
392
393 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]394 <a href="#minimal-fetch" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]395 Minimal fetch
396 </a>
397
398</li>
399
400 <li class="md-nav__item">
Eric Parkf7befcf2020-01-17 07:17:51 +0800[diff] [blame]401 <a href="#force-sync" class="md-nav__link">
402 Force sync
403 </a>
404
405 <nav class="md-nav">
406 <ul class="md-nav__list">
407
408 <li class="md-nav__item">
409 <a href="#why-not-use-f-as-well" class="md-nav__link">
410 Why not use -f as well?
411 </a>
412
413</li>
414
415 </ul>
416 </nav>
417
418</li>
419
420 <li class="md-nav__item">
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]421 <a href="#reposync-alias" class="md-nav__link">
422 reposync alias
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]423 </a>
424
425</li>
426
427 </ul>
428 </nav>
429
430</li>
431
432 <li class="md-nav__item">
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]433 <a href="#delete-all-device-trees-and-local-manifests" class="md-nav__link">
434 Delete all device trees and local manifests
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]435 </a>
436
437</li>
438
439 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]440 <a href="#github-cherry-pick" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]441 GitHub cherry-pick
442 </a>
443
444</li>
445
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]446
447
448
449
450 </ul>
451
452</nav>
453
454 </li>
455
456
457 </ul>
458 </nav>
459 </li>
460
461
462
463
464
465
466
467 <li class="md-nav__item md-nav__item--nested">
468
469 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
470
471 <label class="md-nav__link" for="nav-4">
472 Common
473 </label>
474 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
475 <label class="md-nav__title" for="nav-4">
476 Common
477 </label>
478 <ul class="md-nav__list" data-md-scrollfix>
479
480
481
482
483
484
485
486 <li class="md-nav__item">
487 <a href="../../common/" title="Index" class="md-nav__link">
488 Index
489 </a>
490 </li>
491
492
493
494
495
496
497
498 <li class="md-nav__item">
499 <a href="../../common/git-started/" title="Git Started" class="md-nav__link">
500 Git Started
501 </a>
502 </li>
503
504
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]505
506
507
508
509
510 <li class="md-nav__item">
Eric Park8584eda2019-09-02 09:45:55 +0800[diff] [blame]511 <a href="../../common/maintaining-proper-authorship/" title="Maintaining proper authorship" class="md-nav__link">
512 Maintaining proper authorship
513 </a>
514 </li>
515
516
517
518
519
520
521
522 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]523 <a href="../../common/using-dippy-bird/" title="Using `dippy-bird`" class="md-nav__link">
524 Using `dippy-bird`
525 </a>
526 </li>
527
528
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]529 </ul>
530 </nav>
531 </li>
532
533
534
535
536
537
538
539 <li class="md-nav__item md-nav__item--nested">
540
541 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
542
543 <label class="md-nav__link" for="nav-5">
544 Infrastructure
545 </label>
546 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
547 <label class="md-nav__title" for="nav-5">
548 Infrastructure
549 </label>
550 <ul class="md-nav__list" data-md-scrollfix>
551
552
553
554
555
556
557
558 <li class="md-nav__item">
559 <a href="../../infrastructure/" title="Index" class="md-nav__link">
560 Index
561 </a>
562 </li>
563
564
565 </ul>
566 </nav>
567 </li>
568
569
570 </ul>
571</nav>
572 </div>
573 </div>
574 </div>
575
576
577 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
578 <div class="md-sidebar__scrollwrap">
579 <div class="md-sidebar__inner">
580
581<nav class="md-nav md-nav--secondary">
582
583
584
585
586
587 <label class="md-nav__title" for="__toc">Table of contents</label>
588 <ul class="md-nav__list" data-md-scrollfix>
589
590 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]591 <a href="#repo-optimization-tips" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]592 repo optimization tips
593 </a>
594
595 <nav class="md-nav">
596 <ul class="md-nav__list">
597
598 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]599 <a href="#threads" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]600 Threads
601 </a>
602
603</li>
604
605 <li class="md-nav__item">
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]606 <a href="#current-branch-only" class="md-nav__link">
607 Current branch only
608 </a>
609
610</li>
611
612 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]613 <a href="#current-history-only" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]614 Current history only
615 </a>
616
617</li>
618
619 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]620 <a href="#minimal-fetch" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]621 Minimal fetch
622 </a>
623
624</li>
625
626 <li class="md-nav__item">
Eric Parkf7befcf2020-01-17 07:17:51 +0800[diff] [blame]627 <a href="#force-sync" class="md-nav__link">
628 Force sync
629 </a>
630
631 <nav class="md-nav">
632 <ul class="md-nav__list">
633
634 <li class="md-nav__item">
635 <a href="#why-not-use-f-as-well" class="md-nav__link">
636 Why not use -f as well?
637 </a>
638
639</li>
640
641 </ul>
642 </nav>
643
644</li>
645
646 <li class="md-nav__item">
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]647 <a href="#reposync-alias" class="md-nav__link">
648 reposync alias
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]649 </a>
650
651</li>
652
653 </ul>
654 </nav>
655
656</li>
657
658 <li class="md-nav__item">
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]659 <a href="#delete-all-device-trees-and-local-manifests" class="md-nav__link">
660 Delete all device trees and local manifests
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]661 </a>
662
663</li>
664
665 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]666 <a href="#github-cherry-pick" class="md-nav__link">
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]667 GitHub cherry-pick
668 </a>
669
670</li>
671
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]672
673
674
675
676 </ul>
677
678</nav>
679 </div>
680 </div>
681 </div>
682
683
684 <div class="md-content">
685 <article class="md-content__inner md-typeset">
686
687
688
689 <h1 id="build-tips">Build Tips</h1>
690<p>Here's a collective list of things you can try to improve your builds. Have fun!</p>
691<h2 id="repo-optimization-tips"><code>repo</code> optimization tips</h2>
692<h3 id="threads">Threads</h3>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]693<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. For example, to use 8 threads:</p>
694<pre><code>repo sync -j8
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]695</code></pre>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]696<p>To use all of the threads on your machine, use:</p>
697<pre><code>repo sync -j$(nproc --all)
698</code></pre>
699<h3 id="current-branch-only">Current branch only</h3>
700<p>This is usually set by default in your ROM manifest, but just in case, you can tell <code>repo</code> to only fetch the branch you want to work on:</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]701<pre><code>repo sync -c
702</code></pre>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]703<h3 id="current-history-only">Current history only</h3>
704<p>To only download the most recent changes, use this flag:</p>
705<pre><code>repo sync --depth=1
706</code></pre>
707<p>This will make <code>repo</code> fetch the most recent changes.</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]708<h3 id="minimal-fetch">Minimal fetch</h3>
709<p>To disable syncing clone bundles and tags, use:</p>
710<pre><code>repo sync --no-clone-bundle --no-tags
711</code></pre>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]712<p><code>repo</code> uses <code>git</code> bundles over HTTP to download repositories. To disable this behavior, we use the <code>--no-clone-bundle</code> flag. We also don't need all of the <code>git</code> tags in each repository, so we disable that too with <code>--no-tags</code>.</p>
Eric Parkf7befcf2020-01-17 07:17:51 +0800[diff] [blame]713<h3 id="force-sync">Force sync</h3>
714<p>Sometimes, bad Internet conditions may cause your <code>.repo</code> directory to become corrupt and not sync. <code>repo</code> keeps two copies of a repository - one under <code>.repo</code>, and one in the root of your source directory. If the repository in <code>.repo</code> is corrupted, it will not sync over to the source directory.</p>
715<p>To resolve this problem, you need to sometimes tell <code>repo</code> to forcefully sync the repository in <code>.repo</code> again with the remote repository so that changes can be synced over to the main source tree. Use the <code>--force-sync</code> flag to achieve this:</p>
716<pre><code>repo sync --force-sync
717</code></pre>
718<h4 id="why-not-use-f-as-well">Why not use <code>-f</code> as well?</h4>
719<p>Starting from <code>repo</code> 1.26, the use of the flags <code>-f</code> and <code>--force-sync</code> together has been deprecated. <code>repo</code> will warn you of this change if you try and use those two flags together. To make sure your scripts do not break in future <code>repo</code> versions, it is recommended to not use the <code>-f</code> flag at all.</p>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]720<h3 id="reposync-alias"><code>reposync</code> alias</h3>
721<pre><code>repo sync -c -j$(nproc --all) --no-clone-bundle --no-tags
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]722</code></pre>
723<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>
724<p>Open up <code>~/.bashrc</code> and add these lines:</p>
725<pre><code># Alias to sync
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]726alias reposync='repo sync -c -j$(nproc --all) --no-clone-bundle --no-tags'
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]727</code></pre>
728<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>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]729<h2 id="delete-all-device-trees-and-local-manifests">Delete all device trees and local manifests</h2>
730<p><strong>WARNING</strong>: If you have any changes in your device trees, commit them and push them to a remote repository. This tip will permanently delete your local changes, so back them up!</p>
731<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. This tip/command will let you delete only the device trees.</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]732<p>Add this function to your <code>~/.bashrc</code>:</p>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]733<pre><code># Remove all device trees/local manifests
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]734function resettree() {
735 rm -rf device kernel vendor out .repo/local_manifests
736 reposync
737}
738</code></pre>
739<p>Let's go over what this does, word by word:</p>
740<ul>
741<li><code>rm -rf</code>: Destructive command to erase all of the following:</li>
742<li><code>device</code> folder: Holds all device-related files</li>
743<li><code>kernel</code> folder: Holds all kernel-related files for devices</li>
744<li><code>vendor</code> folder: Holds all vendor-related files for devices AND ROM-specific vendor customizations</li>
745<li><code>out</code> folder: Stores artifacts of builds</li>
746<li><code>.repo/local_manifests</code> folder: Stores "manifest" information of devices to sync.</li>
747<li><code>reposync</code>: Executes the <code>repo sync</code> alias we made earlier.</li>
748</ul>
749<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>
Eric Parkf1180122019-12-28 17:11:20 +0900[diff] [blame]750<p>After running <code>resettree</code>, make sure to initialize a new tree by running <code>breakfast &lt;devicename&gt;</code>.</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]751<h2 id="github-cherry-pick">GitHub cherry-pick</h2>
752<p>Thanks to @blueyes for providing the script!</p>
753<p>Copy the following into your <code>~/.bashrc</code>:</p>
754<pre><code>function gcp() {
755 COMMIT=`echo "$1" | cut -d/ -f6`
756 GH=`echo "$1" | cut -d/ -f1-3`
757 if [ "$COMMIT" != "commit" ]; then
758 echo -e "Please use a commit URL."
759 elif [ "$GH" != "https://github.com" ]; then
760 echo -e "Please use an https://github.com/ URL."
761 else
762 PROJECT=`echo "$1" | cut -d/ -f1-5`
763 git fetch $PROJECT
764 CP=`echo "$1" | cut -d/ -f7`
765 git cherry-pick $CP
766 fi
767}
768</code></pre>
769<p>To use this, <code>source ~/.bashrc</code> and then run <code>gcp &lt;GitHub commit URL here&gt;</code>.</p>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]770
771
772
773
774
775
776
777
778
779 </article>
780 </div>
781 </div>
782 </main>
783
784
785<footer class="md-footer">
786
787 <div class="md-footer-nav">
788 <nav class="md-footer-nav__inner md-grid">
789
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]790 <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]791 <div class="md-flex__cell md-flex__cell--shrink">
792 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
793 </div>
794 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
795 <span class="md-flex__ellipsis">
796 <span class="md-footer-nav__direction">
797 Previous
798 </span>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]799 Build Guide
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]800 </span>
801 </div>
802 </a>
803
804
805 <a href="../../common/" title="Index" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
806 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
807 <span class="md-flex__ellipsis">
808 <span class="md-footer-nav__direction">
809 Next
810 </span>
811 Index
812 </span>
813 </div>
814 <div class="md-flex__cell md-flex__cell--shrink">
815 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
816 </div>
817 </a>
818
819 </nav>
820 </div>
821
822 <div class="md-footer-meta md-typeset">
823 <div class="md-footer-meta__inner md-grid">
824 <div class="md-footer-copyright">
825
826 powered by
827 <a href="https://www.mkdocs.org">MkDocs</a>
828 and
829 <a href="https://squidfunk.github.io/mkdocs-material/">
830 Material for MkDocs</a>
831 </div>
832
833 </div>
834 </div>
835</footer>
836
837 </div>
838
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]839 <script src="../../assets/javascripts/application.ac79c3b0.js"></script>
Eric Parkc9931992019-07-29 13:10:53 +0900[diff] [blame]840
841 <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
842
843
844 </body>
845</html>