1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 10.2.1" />
<title>depot_tools_tutorial(7)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
/* Default font. */
body {
font-family: Georgia,serif;
}
/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
font-family: Arial,Helvetica,sans-serif;
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
h5 {
font-size: 1.0em;
}
div.sectionbody {
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
ul > li { color: #aaa; }
ul > li > * { color: black; }
.monospaced, code, pre {
font-family: "Courier New", Courier, monospace;
font-size: inherit;
color: navy;
padding: 0;
margin: 0;
}
pre {
white-space: pre-wrap;
}
#author {
color: #527bbd;
font-weight: bold;
font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}
#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
#footer-text {
float: left;
padding-bottom: 0.5em;
}
#footer-badges {
float: right;
padding-bottom: 0.5em;
}
#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid #dddddd;
border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid #dddddd;
border-left: 5px solid #f0f0f0;
background: #f8f8f8;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #f0f0f0;
color: #888;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; vertical-align: text-bottom; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
#footer-badges { display: none; }
}
#toc {
margin-bottom: 2.5em;
}
#toctitle {
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }
span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }
span.big { font-size: 2em; }
span.small { font-size: 0.6em; }
span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }
div.unbreakable { page-break-inside: avoid; }
/*
* xhtml11 specific
*
* */
div.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-weight: bold;
color: #527bbd;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
/*
* html5 specific
*
* */
table.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
thead, p.tableblock.header {
font-weight: bold;
color: #527bbd;
}
p.tableblock {
margin-top: 0;
}
table.tableblock {
border-width: 3px;
border-spacing: 0px;
border-style: solid;
border-color: #527bbd;
border-collapse: collapse;
}
th.tableblock, td.tableblock {
border-width: 1px;
padding: 4px;
border-style: solid;
border-color: #527bbd;
}
table.tableblock.frame-topbot {
border-left-style: hidden;
border-right-style: hidden;
}
table.tableblock.frame-sides {
border-top-style: hidden;
border-bottom-style: hidden;
}
table.tableblock.frame-none {
border-style: hidden;
}
th.tableblock.halign-left, td.tableblock.halign-left {
text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
text-align: right;
}
th.tableblock.valign-top, td.tableblock.valign-top {
vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
vertical-align: bottom;
}
/*
* manpage specific
*
* */
body.manpage h1 {
padding-top: 0.5em;
padding-bottom: 0.5em;
border-top: 2px solid silver;
border-bottom: 2px solid silver;
}
body.manpage h2 {
border-style: none;
}
body.manpage div.sectionbody {
margin-left: 3em;
}
@media print {
body.manpage div#toc { display: none; }
}
div.listingblock > div.content {
background: rgb(28, 28, 28);
}
div.listingblock > div > pre > code {
color: rgb(187, 187, 187);
}
</style>
<script type="text/javascript">
/*<+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
if (!toc) {
return;
}
// Delete existing TOC entries in case we're reloading the TOC.
var tocEntriesToRemove = [];
var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
}
for (i = 0; i < tocEntriesToRemove.length; i++) {
toc.removeChild(tocEntriesToRemove[i]);
}
// Rebuild TOC entries.
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
// Delete existing footnote entries in case we're reloading the footnodes.
var i;
var noteholder = document.getElementById("footnotes");
if (!noteholder) {
return;
}
var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
noteholder.removeChild(entriesToRemove[i]);
}
// Rebuild footnote entries.
var cont = document.getElementById("content");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
var note = spans[i].getAttribute("data-note");
if (!note) {
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
spans[i].setAttribute("data-note", note);
}
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
},
install: function(toclevels) {
var timerId;
function reinstall() {
asciidoc.footnotes();
if (toclevels) {
asciidoc.toc(toclevels);
}
}
function reinstallAndRemoveTimer() {
clearInterval(timerId);
reinstall();
}
timerId = setInterval(reinstall, 500);
if (document.addEventListener)
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
else
window.onload = reinstallAndRemoveTimer;
}
}
asciidoc.install();
/*]]>*/
</script>
</head>
<body class="manpage">
<div id="header">
<h1>
depot_tools_tutorial(7) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>depot_tools_tutorial -
A tutorial introduction to the Chromium depot_tools git extensions.
</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>The Chromium <a href="depot_tools.html">depot_tools(7)</a> suite contains many git workflow-enhancing
tools which are designed to work together to enable anyone to wrangle the
Chromium codebase expertly. This tutorial explains how to do development on
Chromium using these tools. This will cover:</p></div>
<div class="ulist"><ul>
<li>
<p>
<a href="#_setting_up">Setting up</a>
</p>
</li>
<li>
<p>
<a href="#_getting_the_code">Getting the code</a>
</p>
</li>
<li>
<p>
<a href="#_tl_dr">TL;DR</a>
</p>
</li>
<li>
<p>
<a href="#_creating_uploading_a_cl">Creating / Uploading a CL</a>
</p>
</li>
<li>
<p>
<a href="#_updating_the_code">Updating the code</a>
</p>
</li>
<li>
<p>
<a href="#_managing_multiple_cls">Managing multiple CLs</a>
</p>
</li>
<li>
<p>
<a href="#_managing_dependent_cls">Managing dependent CLs</a>
</p>
</li>
<li>
<p>
<a href="#_example_walkthrough">Example Walkthrough</a>
</p>
</li>
</ul></div>
<div class="paragraph"><p>Please refer to the manpages (or <code>--help</code> output) for details about any of the
commands mentioned in this tutorial.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">If your platform does not support manpages (or you prefer something a bit more
expressive than plain text) you can find all documentation in <em>html</em> form in the
<code>[DEPOT_TOOLS]/man/html</code> folder.</td>
</tr></table>
</div>
<div class="sect2">
<h3 id="_prerequisites">PREREQUISITES</h3>
<div class="paragraph"><p>This tutorial assumes basic familiarity with git terminology and concepts. If you
need to brush up on these, the following are very good resources:</p></div>
<div class="ulist"><ul>
<li>
<p>
<a href="http://think-like-a-git.net/">Think like (a) Git</a> - A lighthearted
overview of git. If you’re sorta-familiar with git, but not <em>comfortable</em> with
it, then give this a look.
</p>
</li>
<li>
<p>
<a href="http://gitimmersion.com/">Git Immersion Tutorial</a> - An in-depth git
tutorial.
</p>
</li>
<li>
<p>
<a href="http://pcottle.github.io/learnGitBranching">pcottle’s Visual Git
Branching</a> - An excellent interactive/graphical demo on how git handles
commits, branches, and shows the operations git performs on them.
</p>
</li>
<li>
<p>
<a href="http://git-scm.com/book">Pro Git book</a> - “The” book for learning git
from basics to advanced concepts. A bit dry, but very through.
</p>
</li>
</ul></div>
<div class="paragraph"><p>If you’ve tried these out and are still having some trouble getting started,
there are <em>many</em> other resources online which should help. If you’re <em>really</em>
<strong><em>really</em></strong> stuck, then chat up one of the Chromium infrastructure team
members for some pointers.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
Litmus Test
</dt>
<dd>
<p>
If you know what <code>git add</code>, <code>git status</code>, <code>git commit</code> do and you know
<em>essentially</em> what <code>git rebase</code> does, then you should know enough to follow
along.
</p>
</dd>
</dl></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_setting_up">SETTING UP</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_get_depot_tools">GET DEPOT TOOLS</h3>
<div class="sect3">
<h4 id="_linux_mac">LINUX / MAC</h4>
<div class="paragraph"><p>Clone the <em>depot_tools</em> repository:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git</span></strong></code></pre>
</div></div>
<div class="paragraph"><p>Add <em>depot_tools</em> to the <em>front</em> of your PATH (you will probably want to put this
in your <code>~/.bashrc</code> or <code>~/.zshrc</code>). Assuming you cloned <em>depot_tools</em> to
<code>/path/to/depot_tools</code>:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ export PATH=/path/to/depot_tools:$PATH</span></strong></code></pre>
</div></div>
</div>
<div class="sect3">
<h4 id="_windows">WINDOWS</h4>
<div class="paragraph"><p>Download and install Git for Windows from <a href="https://git-scm.com/downloads/win">https://git-scm.com/downloads/win</a>.</p></div>
<div class="paragraph"><p>From a command shell, navigate to the directory where you want to put
<em>depot_tools</em> and clone the <em>depot_tools</em> repository. For example, if you
want <em>depot_tools</em> to be cloned to <code>C:\workspace\depot_tools</code>:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ cd C:\workspace</span></strong>
<strong><span class="white">$ git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git</span></strong></code></pre>
</div></div>
<div class="paragraph"><p>Add <em>depot_tools</em> to the <em>front</em> of your PATH (must be ahead of any installs of
Python). Assuming you cloned <em>depot_tools</em> to <code>C:\workspace\depot_tools</code>:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
With Administrator access:
</dt>
<dd>
<p>
<strong>Control Panel → System and Security → System → Advanced system settings</strong>
</p>
<div class="paragraph"><p>Modify the PATH system variable to include <code>C:\workspace\depot_tools</code>.</p></div>
</dd>
<dt class="hdlist1">
Without Administrator access:
</dt>
<dd>
<p>
<strong>Control Panel → User Accounts → User Accounts → Change my environment variables</strong>
</p>
<div class="paragraph"><p>Add a PATH user variable: <code>C:\workspace\depot_tools;%PATH%</code>.</p></div>
</dd>
</dl></div>
<div class="paragraph"><p>From a <code>cmd.exe</code> shell, run the command <code>gclient</code> (without arguments). On first
run, gclient will install all the Windows-specific bits needed to work with the
code, including msysgit and python.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<div class="ulist"><ul>
<li>
<p>
If you run gclient from a non-cmd shell (e.g., cygwin, PowerShell), it
may appear to run properly, but msysgit, python, and other tools may not get
installed correctly.
</p>
</li>
<li>
<p>
If you see strange errors with the file system on the first run of gclient,
you may want to <a href="http://tortoisesvn.tigris.org/faq.html#cantmove2">disable
Windows Indexing</a>.
</p>
</li>
<li>
<p>
After running gclient open a command prompt and type <code>where python3</code> and confirm that
the depot_tools python3.bat comes ahead of any copies of python3.exe. Failing to ensure
this can lead to overbuilding when using gn - see
<a href="https://issues.chromium.org/issues/41253477">crbug.com/41253477</a>.
</p>
</li>
</ul></div>
</td>
</tr></table>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_bootstrapping_configuration">BOOTSTRAPPING CONFIGURATION</h3>
<div class="paragraph"><p>If you have never used git before, you’ll need to set some global git
configurations; substitute your name and email address in the following
commands:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ git config --global user.name "John Doe"</span></strong>
<strong><span class="white">$ git config --global user.email "jdoe@email.com"</span></strong>
<strong><span class="white">$ git config --global core.autocrlf false</span></strong>
<strong><span class="white">$ git config --global core.filemode false</span></strong>
<strong><span class="white">$</span></strong> # and for fun!
<strong><span class="white">$ git config --global color.ui true</span></strong></code></pre>
</div></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_tl_dr">TL;DR</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$</span></strong> # Set up auth in Git config:
<strong><span class="white">$ git cl creds-check --global</span></strong>
<strong><span class="white">$</span></strong> # get the code
<strong><span class="white">$</span></strong> # In an empty directory:
<strong><span class="white">$ fetch {chromium,...}</span></strong>
<strong><span class="white">$</span></strong> # Update third_party repos and run pre-compile hooks
<strong><span class="white">$ gclient sync</span></strong>
<strong><span class="white">$</span></strong> # Make a new change and upload it for review
<strong><span class="white">$ git new-branch <branch_name></span></strong>
<strong><span class="white">$</span></strong> # repeat: [edit, git add, git commit]
<strong><span class="white">$ git cl upload</span></strong>
<strong><span class="white">$</span></strong> # After change is reviewed, commit with the CQ
<strong><span class="white">$ git cl set_commit</span></strong>
<strong><span class="white">$</span></strong> # Note that the committed hash which lands will /not/ match the
<strong><span class="white">$</span></strong> # commit hashes of your local branch.</code></pre>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_getting_the_code">GETTING THE CODE</h2>
<div class="sectionbody">
<div class="paragraph"><p>Unless you plan on only fetching code anonymously, you’ll need to set
up your auth config in Git. Run this:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ git cl creds-check --global</span></strong></code></pre>
</div></div>
<div class="paragraph"><p>Pick an empty directory and run one of the following:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ fetch chromium</span></strong> # Basic checkout for desktop Chromium
<strong><span class="white">$ fetch android</span></strong> # Chromium checkout for Android platform
<strong><span class="white">$ fetch ios</span></strong> # Chromium checkout for iOS platform</code></pre>
</div></div>
<div class="paragraph"><p>When the <code>fetch</code> tool completes you should have the following in your working
directory:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">.gclient</span></strong> # A configuration file for you source checkout
<strong><span class="white">src/</span></strong> # Top-level Chromium source checkout.</code></pre>
</div></div>
<div class="paragraph"><p>If you are on linux and fetching the code for the first time, then you’ll need
to run:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ cd src && ./build/install-build-deps.sh</span></strong></code></pre>
</div></div>
<div class="paragraph"><p>And finally:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ gclient sync</span></strong></code></pre>
</div></div>
<div class="paragraph"><p>This will pull all dependencies of the Chromium src checkout. You will need
to run this any time you update the main src checkout, including when you
switch branches.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_creating_uploading_a_cl">CREATING / UPLOADING A CL</h2>
<div class="sectionbody">
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">The remainder of the tutorial assumes that your current working directory
is the <code>src/</code> folder mentioned in <a href="#_getting_the_code">Getting the code</a>.</td>
</tr></table>
</div>
<div class="paragraph"><p>Each CL corresponds exactly with a single branch in git. Any time you want to
begin a new CL:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ git new-branch <branch_name></span></strong></code></pre>
</div></div>
<div class="paragraph"><p>This will create and checkout a new branch named <code>branch_name</code> which will track
the default upstream branch (<code>origin/main</code>). See
<a href="git-new-branch.html">git-new-branch(1)</a> for more features.</p></div>
<div class="paragraph"><p>Commit as many changes as you like to this branch. When you want to upload it
for review, run:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ git cl upload</span></strong></code></pre>
</div></div>
<div class="paragraph"><p>This will take the diff of your branch against its upstream branch (in that
case origin/main), and will post it to the
<a href="https://chromium-review.googlesource.com">Chromium code review site</a>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_updating_the_code">UPDATING THE CODE</h2>
<div class="sectionbody">
<div class="paragraph"><p>Inevitably, you’ll want to pull in changes from the main Chromium repo. This is
pretty easy with <em>depot_tools</em>:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ git rebase-update</span></strong></code></pre>
</div></div>
<div class="paragraph"><p>This command will update all of your CLs to contain the latest code from their
upstreams. It will also automatically clean up CLs which have been committed and
a couple other nice things. See <a href="git-rebase-update.html">git-rebase-update(1)</a> for the full
scoop.</p></div>
<div class="paragraph"><p>One thing to look out for are <em>merge conflicts</em>. These happen for exactly the
same as they do with SVN, but the experience is a little more controllable with
git. <code>git rebase-update</code> will try to rebase all your branches for you, but if it
encounters a merge conflict in one, it will halt and leave you in a rebase
conflict state (see <a href="git-rebase.html">git-rebase(1)</a>). Resolving <code>git rebase</code> merge
conflicts is beyond the scope of this tutorial, but there are many good sources
online (see the <a href="#_prerequisites">Prerequisites</a> for some).</p></div>
<div class="paragraph"><p>Sometimes you’re pretty certain that you’ve committed a certain branch, but <code>git
rebase-update</code> isn’t able to tell that for sure. This is usually because your
branch doesn’t rebase cleanly. You could just delete the branch with <code>git branch
-D <branch></code>, but you’d like to double check the diff of your branch against its
upstream before deleting it. If this is the case you can abort the rebase
started by <code>git rebase-update</code>, and then run <a href="git-squash-branch.html">git-squash-branch(1)</a> to
flatten your branch into a single commit. When you run <code>git rebase-update</code>
again, you’ll get a (hopefully) much smaller / saner diff. If it turns out you
were wrong about your branch being fully committed, you can use
<a href="git-reflog.html">git-reflog(1)</a> to reset your branch back to where it was before. If the
diff looks inconsequential, you can use <code>git rebase --skip</code> to ignore it, and
then <code>git rebase-update</code> will clean it up for you.</p></div>
<div class="paragraph"><p>Once you’re done resolving all of the merge conflict, just run <code>git
rebase-update</code>, and it will pick up where it left off. Once the command has
finished updating all of your branches, it will return you back to the branch
you started on.</p></div>
<div class="paragraph"><p>As an alternative, or if you experience issues with multiple merge conflicts on
the same changes you can run <code>git squash-branch</code> on the conflicted branch
(either after running <code>git rebase --abort</code> or before running <code>git
rebase-update</code>). This will convert the branch to a single commit, which should
apply more cleanly, or at least result in only needing to resolve the merge
conflicts once. Running <code>git cl squash-closed</code> prior to <code>git rebase-update</code> will
perform this <code>git squash-branch</code> on all branches that gerrit thinks are closed.
These now-closed branches should have a single commit that will cleanly apply
(and then subsequently be deleted by the rebase process), and can reduce the
risk of running into merge conflicts during the rebase.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">Running <code>git rebase-update</code> will update all your branches, but it will not
automatically run <code>gclient sync</code> to update your dependencies. Use caution when
running <code>git reset</code> on branches managed by <em>depot_tools</em>. These tools track the
set of "commits contained in the branch" from a branch’s "merge point" to the
current branch value. See <code>git help mark-merge-base</code> for more discussion of the
merge base.</td>
</tr></table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_managing_multiple_cls">MANAGING MULTIPLE CLS</h2>
<div class="sectionbody">
<div class="paragraph"><p>Sometimes you want to work on more than one CL at once (say, you have a CL
posted for review and want to work on something else). For each CL that you
want to work on, just use <code>git new-branch <branch_name></code>.</p></div>
<div class="paragraph"><p>Once you start to have more than one CL at a time, it can be easy to lose your
bearings. Fortunately, <em>depot_tools</em> has two tools to help you out:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ git map</span></strong>
<span class="white blue-background">*</span>​<strong><span class="blue-background red"> 7dcfe47 </span></strong> <span class="green">(</span>​<strong><span class="aqua">frozen_changes</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-12</span> ~ FREEZE.unindexed
* <strong><span class="red">4b0c180</span></strong> <span class="yellow">2014-03-12</span> ~ modfile
* <strong><span class="red">59a7cca</span></strong> <span class="yellow">2014-03-12</span> ~ a deleted file
* <strong><span class="red">6bec695</span></strong> <span class="green">(</span>​<span class="red">origin/main</span>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Add neat feature <strong><span class="white"><(frozen_changes)</span></strong>
* <strong><span class="red">d15a38a</span></strong> <span class="yellow">2014-03-11</span> ~ Epic README update
* <strong><span class="red">d559894</span></strong> <span class="green">(</span>​<strong><span class="lime">main</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Important upstream change
<span class="red">|</span> * <strong><span class="red">9c311fd</span></strong> <span class="green">(</span>​<strong><span class="lime">cool_feature</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Respond to CL comments
<span class="red">|</span> <span class="green">|</span> * <strong><span class="red">2a1eeb2</span></strong> <span class="green">(</span>​<strong><span class="lime">subfeature</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ integrate with CoolService
<span class="red">|</span> <span class="green">|</span> * <strong><span class="red">d777af6</span></strong> <span class="yellow">2014-03-11</span> ~ slick commenting action
<span class="red">|</span> <span class="green">|/</span>
<span class="red">|</span> * <strong><span class="red">265803a</span></strong> <span class="yellow">2014-03-11</span> ~ another improvement <strong><span class="white"><(subfeature)</span></strong>
<span class="red">|</span> * <strong><span class="red">6d831ac</span></strong> <span class="green">(</span>​<strong><span class="fuchsia">spleen_tag</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Refactor spleen
<span class="red">|</span> * <strong><span class="red">82e74ab</span></strong> <span class="yellow">2014-03-11</span> ~ Add widget
<span class="red">|/</span>
* <strong><span class="red">d08c5b3</span></strong> <span class="green">(</span>​<strong><span class="lime">bogus_noparent</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Wonderful beginnings <strong><span class="white"><(cool_feature)</span></strong></code></pre>
</div></div>
<div class="paragraph"><p>Note that this example repo is in dire need of a <a href="git-rebase-update.html">git-rebase-update(1)</a>!</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ git map-branches</span></strong>
<span class="red">origin/main</span>
<span class="green">cool_feature</span>
<span class="green">subfeature</span>
<span class="aqua">frozen_changes *</span>
<span class="green">main</span></code></pre>
</div></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<a href="git-map.html">git-map(1)</a>
</dt>
<dd>
<p>
This tool shows you the history of all of your branches in a pseudo-graphical
format. In particular, it will show you which commits all of your branches
are on, which commit you currently have checked out, and more. Check out the
doc for the full details.
</p>
</dd>
<dt class="hdlist1">
<a href="git-map-branches.html">git-map-branches(1)</a>
</dt>
<dd>
<p>
This tool just shows you which branches you have in your repo, and their
upstream relationship to each other (as well as which branch you have checked
out at the moment).
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Additionally, sometimes you need to switch between branches, but you’ve got work
in progress. You could use <a href="git-stash.html">git-stash(1)</a>, but that can be tricky to
manage because you need to remember which branches you stashed what changes on.
Helpfully <em>depot_tools</em> includes two tools which can greatly assist in case:</p></div>
<div class="paragraph"><p><a href="git-freeze.html">git-freeze(1)</a> allows you to put the current branch in 'suspended
animation' by committing your changes to a specially-named commit on the top of
your current branch. When you come back to your branch later, you can just run
<a href="git-thaw.html">git-thaw(1)</a> to get your work-in-progress changes back to what they were.</p></div>
<div class="paragraph"><p>Another useful tool is <a href="git-rename-branch.html">git-rename-branch(1)</a>. Unlike <code>git branch -m <old>
<new></code>, this tool will correctly preserve the upstream relationships of your
branch compared to its downstreams.</p></div>
<div class="paragraph"><p>Finally, take a look at <a href="git-upstream-diff.html">git-upstream-diff(1)</a>. This will show you the
combined diff for all the commits on your branch against the upstream tracking
branch. This is <em>exactly</em> what <code>git cl upload</code> will push up to code review.
Additionally, consider trying the <code>--wordwise</code> argument to get a colorized
per-word diff (instead of a per-line diff).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_managing_dependent_cls">MANAGING DEPENDENT CLS</h2>
<div class="sectionbody">
<div class="paragraph"><p>Now that you know how to manage <em>independent</em> CLs, we’ll see how to manage
<em>dependent</em> CLs. Dependent CLs are useful when your second (or third or fourth
or …) CL depends on the changes in one of your other CLs (such as: CL 2 won’t
compile without CL 1, but you want to submit them as two separate reviews).</p></div>
<div class="paragraph"><p>Like all of the other CLs we’ve created, we use <a href="git-new-branch.html">git-new-branch(1)</a>, but
this time with an extra argument. First, <code>git checkout</code> the branch
you want to base the new one on (i.e. CL 1), and then run:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ git new-branch --upstream_current <branch_name></span></strong></code></pre>
</div></div>
<div class="paragraph"><p>This will make a new branch which tracks the <em>current</em> branch as its upstream
(as opposed to <em>origin/main</em>). All changes you commit to this branch will be
in addition to the previous branch, but when you <code>git cl upload</code>, you will only
upload the diff for the dependent (child) branch. You may have as many branches
nested in this fashion as you like.</p></div>
<div class="paragraph"><p><a href="git-map.html">git-map(1)</a> and <a href="git-map-branches.html">git-map-branches(1)</a> are particularly helpful when
you have dependent branches. In addition, there are two helper commands which
let you traverse your working copy up and down this tree of branches:
<a href="git-nav-upstream.html">git-nav-upstream(1)</a> and <a href="git-nav-downstream.html">git-nav-downstream(1)</a>.</p></div>
<div class="paragraph"><p>Sometimes when dealing with dependent CLs, it turns out that you accidentally
based a branch on the wrong upstream, but since then you’ve committed changes to
it, or even based <em>another</em> branch off of that one. Or you discover that you
have two independent CLs that would actually be much better off as dependent
CLs. In instances like these, you can check out the offending branch and use
<a href="git-reparent-branch.html">git-reparent-branch(1)</a> to move it to track a different parent. Note that
this can also be used to move a branch from tracking <code>origin/main</code> to <code>lkgr</code>
or vice versa.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_example_walkthrough">EXAMPLE WALKTHROUGH</h2>
<div class="sectionbody">
<div class="paragraph"><p>This section will demo what a typical workflow looks like when writing,
updating, and committing multiple CLs.</p></div>
<div class="paragraph"><p></p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ fetch chromium</span>
... truncated output ...
<span style="font-weight: bold; color: #BFBFBF">$ cd src</span>
</code></pre></div></div><p><div class="paragraph"> (only on linux)</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ ./build/install-build-deps.sh</span>
... truncated output ...
</code></pre></div></div><p><div class="paragraph"> Pull in all dependencies for HEAD</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ gclient sync</span>
... truncated output ...
</code></pre></div></div><p><div class="paragraph"> Let's fix something!</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ git new-branch fix_typo</span>
<span style="font-weight: bold; color: #BFBFBF">$ echo -e '/Banana\ns/Banana/Kuun\nwq' | ed build/whitespace_file.txt</span>
1503
It was a Domo-Banana.
It was a Domo-Kuun.
1501
<span style="font-weight: bold; color: #BFBFBF">$ git commit -am 'Fix terrible typo.'</span>
[fix_typo 615ffa7] Fix terrible typo.
1 file changed, 1 insertion(+), 1 deletion(-)
<span style="font-weight: bold; color: #BFBFBF">$ git map</span>
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">615ffa720f</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #8BE9FD"></span><span style="font-weight: bold; color: #8BE9FD">HEAD -> fix_typo</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ Fix terrible typo.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">beec6f4746</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #FF5555">origin/main</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">, </span><span style="font-weight: bold; color: #FF5555">origin/HEAD</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ Make ReflectorImpl use mailboxes
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">41290e02b7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ don't use glibc-specific execinfo.h on uclibc builds
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">a76fde7b7b</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ [fsp] Add requestUnmount() method together with the request manager.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">9de7a713b3</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ linux_aura: Use system configuration for middle clicking the titlebar.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">073b0c203a</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ ContentView->ContentViewCore in ContentViewRenderView
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">2250f532d7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ ozone: evdev: Filter devices by path
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">33a7a742b7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Always output seccomp error messages to stderr
<span style="font-weight: bold; color: #BFBFBF">$ git status</span>
On branch fix_typo
Your branch is ahead of 'origin/main' by 1 commit.
(use "git push" to publish your local commits)
nothing to commit, working tree clean
<span style="font-weight: bold; color: #BFBFBF">$ git cl upload -r domo@chromium.org --send-mail</span>
... truncated output ...
</code></pre></div></div><p><div class="paragraph"> While we wait for feedback, let's do something else.</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ git new-branch chap2</span>
<span style="font-weight: bold; color: #BFBFBF">$ git map-branches</span>
<span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">origin/main
</span><span style="font-weight: bold; color: #8BE9FD"></span><span style="font-weight: bold; color: #8BE9FD"> chap2 *
</span><span style="font-weight: bold; color: #50FA7B"></span><span style="color: #50FA7B"> fix_typo
</span>
<span style="font-weight: bold; color: #BFBFBF">$ cat >> build/whitespace_file.txt <<EOF</span>
"You recall what happened on Mulholland drive?" The ceiling fan rotated slowly
overhead, barely disturbing the thick cigarette smoke. No doubt was left about
when the fan was last cleaned.
EOF
<span style="font-weight: bold; color: #BFBFBF">$ git status</span>
On branch chap2
Your branch is up to date with 'origin/main'.
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
<span style="color: #FF5555">modified: build/whitespace_file.txt</span>
no changes added to commit (use "git add" and/or "git commit -a")
</code></pre></div></div><p><div class="paragraph"> Someone on the code review pointed out that our typo-fix has a typo :( We're still working on 'chap2' but we really want to land 'fix_typo', so let's switch over and fix it.</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ git freeze</span>
<span style="font-weight: bold; color: #BFBFBF">$ git checkout fix_typo</span>
Switched to branch 'fix_typo'
Your branch is ahead of 'origin/main' by 1 commit.
(use "git push" to publish your local commits)
<span style="font-weight: bold; color: #BFBFBF">$ echo -e '/Kuun\ns/Kuun/Kun\nwq' | ed build/whitespace_file.txt</span>
1501
It was a Domo-Kuun.
It was a Domo-Kun.
1500
<span style="font-weight: bold; color: #BFBFBF">$ git upstream-diff --wordwise</span>
<span style="font-weight: bold">diff --git a/build/whitespace_file.txt b/build/whitespace_file.txt</span>
<span style="font-weight: bold">index 3eba355..57cdcee 100644</span>
<span style="font-weight: bold">--- a/build/whitespace_file.txt</span>
<span style="font-weight: bold">+++ b/build/whitespace_file.txt</span>
<span style="color: #8BE9FD">@@ -17,7 +17,7 @@</span> swept up the streets (for it is in London that our scene lies), rattling along
the housetops, and fiercely agitating the scanty flame of the lamps that
struggled against the elements. A hooded figure emerged.
It was a Domo-<span style="color: #FF5555">Banana</span><span style="color: #50FA7B">Kun</span>.
"What took you so long?", inquired his wife.
<span style="font-weight: bold; color: #BFBFBF">$ git commit -am 'Fix typo for good!'</span>
[fix_typo 2c0ad9c] Fix typo for good!
1 file changed, 1 insertion(+), 1 deletion(-)
<span style="font-weight: bold; color: #BFBFBF">$ git cl upload</span>
... truncated output ...
</code></pre></div></div><p><div class="paragraph"> Since we got lgtm, let the CQ land it.</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ git cl set_commit</span>
<span style="font-weight: bold; color: #BFBFBF">$ git map</span>
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">0e2e52e72e</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">chap2</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ FREEZE.unindexed
<span style="color: #FF5555">|</span> * <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">2c0ad9c59b</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #8BE9FD"></span><span style="font-weight: bold; color: #8BE9FD">HEAD -> fix_typo</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ Fix typo for good!
<span style="color: #FF5555">|</span> * <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">615ffa720f</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Fix terrible typo.
<span style="color: #FF5555">|</span><span style="color: #FF5555">/</span>
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">beec6f4746</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #FF5555">origin/main</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">, </span><span style="font-weight: bold; color: #FF5555">origin/HEAD</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ Make ReflectorImpl use mailboxes <(<span style="color: #BFBFBF"></span><span style="font-weight: bold; color: #BFBFBF">chap2</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span>)
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">41290e02b7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ don't use glibc-specific execinfo.h on uclibc builds
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">a76fde7b7b</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ [fsp] Add requestUnmount() method together with the request manager.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">9de7a713b3</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ linux_aura: Use system configuration for middle clicking the titlebar.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">073b0c203a</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ ContentView->ContentViewCore in ContentViewRenderView
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">2250f532d7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ ozone: evdev: Filter devices by path
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">33a7a742b7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Always output seccomp error messages to stderr
</code></pre></div></div><p><div class="paragraph"> Switch back to where we were using the nav* commands (for fun... git checkout would work here too)</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ git map-branches</span>
<span style="color: #FF5555"></span><span style="color: #FF5555">origin/main
</span><span style="color: #50FA7B"></span><span style="color: #50FA7B"> chap2
</span><span style="color: #8BE9FD"></span><span style="font-weight: bold; color: #8BE9FD"> fix_typo *
</span>
<span style="font-weight: bold; color: #BFBFBF">$ git nav-upstream</span>
Note: switching to 'origin/main'.
You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.
If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:
git switch -c <new-branch-name>
Or undo this operation with:
git switch -
Turn off this advice by setting config variable advice.detachedHead to false
HEAD is now at beec6f4 Make ReflectorImpl use mailboxes
<span style="font-weight: bold; color: #BFBFBF">$ git nav-downstream</span>
Previous HEAD position was beec6f4 Make ReflectorImpl use mailboxes
Switched to branch 'chap2'
Your branch is ahead of 'origin/main' by 1 commit.
(use "git push" to publish your local commits)
Please select a downstream branch
0. chap2
1. fix_typo
Selection (0-1)[0]: 0
<span style="font-weight: bold; color: #BFBFBF">$ git map-branches</span>
<span style="color: #FF5555"></span><span style="color: #FF5555">origin/main
</span><span style="color: #8BE9FD"></span><span style="font-weight: bold; color: #8BE9FD"> chap2 *
</span><span style="font-weight: bold; color: #50FA7B"></span><span style="color: #50FA7B"> fix_typo
</span>
</code></pre></div></div><p><div class="paragraph"> Now we can pick up on chapter2 where we left off.</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ git thaw</span>
<span style="font-weight: bold; color: #BFBFBF">$ git diff</span>
<span style="font-weight: bold">diff --git a/build/whitespace_file.txt b/build/whitespace_file.txt</span>
<span style="font-weight: bold">index 3eba355..9d08d9d 100644</span>
<span style="font-weight: bold">--- a/build/whitespace_file.txt</span>
<span style="font-weight: bold">+++ b/build/whitespace_file.txt</span>
<span style="color: #8BE9FD">@@ -34,3 +34,7 @@</span> with his fork, watching the runny jelly spread and pool across his plate,
like the blood of a dying fawn. \"It reminds me of that time --\" he started, as
his wife cut in quickly: \"-- please. I can't bear to hear it.\". A flury of
images coming from the past flowed through his mind.
<span style="color: #50FA7B">+</span>
<span style="color: #50FA7B">+</span><span style="color: #50FA7B">"You recall what happened on Mulholland drive?" The ceiling fan rotated slowly</span>
<span style="color: #50FA7B">+</span><span style="color: #50FA7B">overhead, barely disturbing the thick cigarette smoke. No doubt was left about</span>
<span style="color: #50FA7B">+</span><span style="color: #50FA7B">when the fan was last cleaned.</span>
<span style="font-weight: bold; color: #BFBFBF">$ cat >> build/whitespace_file.txt <<EOF</span>
There was an poignant pause.
EOF
<span style="font-weight: bold; color: #BFBFBF">$ git diff</span>
<span style="font-weight: bold">diff --git a/build/whitespace_file.txt b/build/whitespace_file.txt</span>
<span style="font-weight: bold">index 3eba355..e3a55de 100644</span>
<span style="font-weight: bold">--- a/build/whitespace_file.txt</span>
<span style="font-weight: bold">+++ b/build/whitespace_file.txt</span>
<span style="color: #8BE9FD">@@ -34,3 +34,9 @@</span> with his fork, watching the runny jelly spread and pool across his plate,
like the blood of a dying fawn. \"It reminds me of that time --\" he started, as
his wife cut in quickly: \"-- please. I can't bear to hear it.\". A flury of
images coming from the past flowed through his mind.
<span style="color: #50FA7B">+</span>
<span style="color: #50FA7B">+</span><span style="color: #50FA7B">"You recall what happened on Mulholland drive?" The ceiling fan rotated slowly</span>
<span style="color: #50FA7B">+</span><span style="color: #50FA7B">overhead, barely disturbing the thick cigarette smoke. No doubt was left about</span>
<span style="color: #50FA7B">+</span><span style="color: #50FA7B">when the fan was last cleaned.</span>
<span style="color: #50FA7B">+</span>
<span style="color: #50FA7B">+</span><span style="color: #50FA7B">There was an poignant pause.</span>
<span style="font-weight: bold; color: #BFBFBF">$ git commit -am 'Finish chapter 2'</span>
[chap2 ceef712] Finish chapter 2
1 file changed, 6 insertions(+)
<span style="font-weight: bold; color: #BFBFBF">$ git map</span>
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">ceef712d7f</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #8BE9FD"></span><span style="font-weight: bold; color: #8BE9FD">HEAD -> chap2</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ Finish chapter 2
<span style="color: #FF5555">|</span> * <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">2c0ad9c59b</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">fix_typo</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ Fix typo for good!
<span style="color: #FF5555">|</span> * <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">615ffa720f</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Fix terrible typo.
<span style="color: #FF5555">|</span><span style="color: #FF5555">/</span>
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">beec6f4746</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #FF5555">origin/main</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">, </span><span style="font-weight: bold; color: #FF5555">origin/HEAD</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ Make ReflectorImpl use mailboxes <(<span style="color: #BFBFBF"></span><span style="font-weight: bold; color: #BFBFBF">fix_typo</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span>)
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">41290e02b7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ don't use glibc-specific execinfo.h on uclibc builds
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">a76fde7b7b</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ [fsp] Add requestUnmount() method together with the request manager.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">9de7a713b3</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ linux_aura: Use system configuration for middle clicking the titlebar.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">073b0c203a</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ ContentView->ContentViewCore in ContentViewRenderView
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">2250f532d7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ ozone: evdev: Filter devices by path
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">33a7a742b7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Always output seccomp error messages to stderr
<span style="font-weight: bold; color: #BFBFBF">$ git cl upload -r domo@chromium.org --send-mail</span>
... truncated output ...
</code></pre></div></div><p><div class="paragraph"> We poke a committer until they lgtm :)</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ git cl set_commit</span>
</code></pre></div></div><p><div class="paragraph"> While that runs through the CQ, let's get started on chapter 3. Since we know that chapter 3 depends on chapter 2, we'll track the current chapter2 branch.</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ git new-branch --upstream_current chap3</span>
<span style="font-weight: bold; color: #BFBFBF">$ cat >> build/whitespace_file.txt <<EOF</span>
CHAPTER 3:
Mr. Usagi felt that something wasn't right. Shortly after the Domo-Kun left he
began feeling sick.
EOF
<span style="font-weight: bold; color: #BFBFBF">$ git commit -am 'beginning of chapter 3'</span>
[chap3 7d4238a] beginning of chapter 3
1 file changed, 4 insertions(+)
<span style="font-weight: bold; color: #BFBFBF">$ git map</span>
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">7d4238a1e2</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #8BE9FD"></span><span style="font-weight: bold; color: #8BE9FD">HEAD -> chap3</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ beginning of chapter 3
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">ceef712d7f</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">chap2</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ Finish chapter 2
<span style="color: #FF5555">|</span> * <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">2c0ad9c59b</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">fix_typo</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ Fix typo for good!
<span style="color: #FF5555">|</span> * <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">615ffa720f</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Fix terrible typo.
<span style="color: #FF5555">|</span><span style="color: #FF5555">/</span>
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">beec6f4746</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #FF5555">origin/main</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">, </span><span style="font-weight: bold; color: #FF5555">origin/HEAD</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ Make ReflectorImpl use mailboxes <(<span style="color: #BFBFBF"></span><span style="font-weight: bold; color: #BFBFBF">chap2, fix_typo</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span>)
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">41290e02b7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ don't use glibc-specific execinfo.h on uclibc builds
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">a76fde7b7b</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ [fsp] Add requestUnmount() method together with the request manager.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">9de7a713b3</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ linux_aura: Use system configuration for middle clicking the titlebar.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">073b0c203a</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ ContentView->ContentViewCore in ContentViewRenderView
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">2250f532d7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ ozone: evdev: Filter devices by path
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">33a7a742b7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Always output seccomp error messages to stderr
</code></pre></div></div><p><div class="paragraph"> We haven't updated the code in a while, so let's do that now.</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ git rebase-update</span>
Fetching origin
From https://upstream
beec6f4..59cdb73 main -> origin/main
Rebasing: <span style="font-weight: bold">chap2</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span>
Rebasing: <span style="font-weight: bold">fix_typo</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span>
Failed! Attempting to squash <span style="font-weight: bold">fix_typo</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> ... Success!
Rebasing: <span style="font-weight: bold">chap3</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span>
Reparented chap3 to track origin/main (was tracking chap2)
Deleted branch fix_typo (was 5d26fec).
Deleted branch chap2 (was 5d26fec).
Running `git gc --auto` - Ctrl-C to abort is OK.
</code></pre></div></div><p><div class="paragraph"> Well look at that. The CQ landed our typo and chapter2 branches already and git rebase-update cleaned them up for us.</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ gclient sync</span>
... truncated output ...
<span style="font-weight: bold; color: #BFBFBF">$ git map</span>
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">93fe917ad1</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #8BE9FD"></span><span style="font-weight: bold; color: #8BE9FD">HEAD -> chap3</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ beginning of chapter 3
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">5d26fec369</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #FF5555">origin/main</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">, </span><span style="font-weight: bold; color: #FF5555">origin/HEAD</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ Finish chapter 2
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">df7fefbf06</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Revert 255617, due to it not tracking use of the link doctor page properly.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">4b39cda0ac</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Fix terrible typo.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">248c5b6fe3</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Temporarily CHECK(trial) in ChromeRenderProcessObserver::OnSetFieldTrialGroup.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">8171df8af9</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Remove AMD family check for the flapper crypto accelerator.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">d6a30d2e56</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Change the Pica load benchmark to listen for the polymer-ready event
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">beec6f4746</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Make ReflectorImpl use mailboxes
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">41290e02b7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ don't use glibc-specific execinfo.h on uclibc builds
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">a76fde7b7b</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ [fsp] Add requestUnmount() method together with the request manager.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">9de7a713b3</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ linux_aura: Use system configuration for middle clicking the titlebar.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">073b0c203a</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ ContentView->ContentViewCore in ContentViewRenderView
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">2250f532d7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ ozone: evdev: Filter devices by path
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">33a7a742b7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Always output seccomp error messages to stderr
</code></pre></div></div><p><div class="paragraph"> Someone on IRC mentions that they actually landed a chapter 3 already! We should pull their changes before continuing. Brace for a code conflict!</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ git rebase-update</span>
Fetching origin
From https://upstream
5d26fec..59cdb73 main -> origin/main
Rebasing: chap2
... lots of output, it's a conflict alright :(...
<span style="font-weight: bold; color: #BFBFBF">$ git diff</span>
<span style="font-weight: bold">diff --cc build/whitespace_file.txt</span>
<span style="font-weight: bold">index 1293282,f903ea2..0000000</span>
<span style="font-weight: bold">--- a/build/whitespace_file.txt</span>
<span style="font-weight: bold">+++ b/build/whitespace_file.txt</span>
<span style="color: #8BE9FD">@@@ -42,4 -42,5 +42,9 @@@</span> when the fan was last cleaned
There was an poignant pause.
CHAPTER 3:
<span style="color: #50FA7B">++<<<<<<< HEAD</span>
<span style="color: #50FA7B"> +Hilariousness! This chapter is awesome!</span>
<span style="color: #50FA7B">++=======</span>
<span style="color: #50FA7B">+ Mr. Usagi felt that something wasn't right. Shortly after the Domo-Kun left he</span>
<span style="color: #50FA7B">+ began feeling sick.</span>
<span style="color: #50FA7B">++>>>>>>> 93fe917 (beginning of chapter 3)</span>
</code></pre></div></div><p><div class="paragraph"> Oh, well, that's not too bad. In fact... that's a terrible chapter 3!</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ $EDITOR build/whitespace_file.txt</span>
... /me deletes bad chapter 3 ...
<span style="font-weight: bold; color: #BFBFBF">$ git add build/whitespace_file.txt</span>
<span style="font-weight: bold; color: #BFBFBF">$ git diff --cached</span>
<span style="font-weight: bold">diff --git a/build/whitespace_file.txt b/build/whitespace_file.txt</span>
<span style="font-weight: bold">index 1293282..f903ea2 100644</span>
<span style="font-weight: bold">--- a/build/whitespace_file.txt</span>
<span style="font-weight: bold">+++ b/build/whitespace_file.txt</span>
<span style="color: #8BE9FD">@@ -42,4 +42,5 @@</span> when the fan was last cleaned.
There was an poignant pause.
CHAPTER 3:
<span style="color: #FF5555">-Hilariousness! This chapter is awesome!</span>
<span style="color: #50FA7B">+</span><span style="color: #50FA7B">Mr. Usagi felt that something wasn't right. Shortly after the Domo-Kun left he</span>
<span style="color: #50FA7B">+</span><span style="color: #50FA7B">began feeling sick.</span>
</code></pre></div></div><p><div class="paragraph"> Much better</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #BFBFBF">$ git rebase --continue</span>
[detached HEAD 1cb4f5b] beginning of chapter 3
1 file changed, 2 insertions(+), 1 deletion(-)
<span style="font-weight: bold; color: #BFBFBF">$ git rebase-update</span>
Fetching origin
<span style="font-weight: bold">chap3</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> up-to-date
Running `git gc --auto` - Ctrl-C to abort is OK.
<span style="font-weight: bold; color: #BFBFBF">$ gclient sync</span>
... truncated output ...
<span style="font-weight: bold; color: #BFBFBF">$ git map</span>
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">1cb4f5b622</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #8BE9FD"></span><span style="font-weight: bold; color: #8BE9FD">HEAD -> chap3</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ beginning of chapter 3
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">59cdb7335b</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">(</span><span style="font-weight: bold; color: #FF5555">origin/main</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">, </span><span style="font-weight: bold; color: #FF5555">origin/HEAD</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #50FA7B"></span><span style="font-weight: bold; color: #50FA7B">) </span><span style="font-weight: bold"></span><span style="font-weight: bold"></span><span style="color: #F1FA8C">2014-04-10</span> ~ Refactor data interchange format.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">34676a3583</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Ensure FS is exited for all not-in-same-page navigations.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">7d4784e867</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Add best chapter2 ever!
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">5d26fec369</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Finish chapter 2
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">df7fefbf06</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Revert 255617, due to it not tracking use of the link doctor page properly.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">4b39cda0ac</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Fix terrible typo.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">248c5b6fe3</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Temporarily CHECK(trial) in ChromeRenderProcessObserver::OnSetFieldTrialGroup.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">8171df8af9</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Remove AMD family check for the flapper crypto accelerator.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">d6a30d2e56</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Change the Pica load benchmark to listen for the polymer-ready event
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">beec6f4746</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Make ReflectorImpl use mailboxes
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">41290e02b7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ don't use glibc-specific execinfo.h on uclibc builds
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">a76fde7b7b</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ [fsp] Add requestUnmount() method together with the request manager.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">9de7a713b3</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ linux_aura: Use system configuration for middle clicking the titlebar.
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">073b0c203a</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ ContentView->ContentViewCore in ContentViewRenderView
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">2250f532d7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ ozone: evdev: Filter devices by path
* <span style="color: #FF5555"></span><span style="font-weight: bold; color: #FF5555">33a7a742b7</span><span style="font-weight: bold"></span><span style="font-weight: bold"></span> <span style="color: #F1FA8C">2014-04-10</span> ~ Always output seccomp error messages to stderr
<span style="font-weight: bold; color: #BFBFBF">$ git cl upload</span>
... truncated output ...
</code></pre></div></div><p><div class="paragraph"></p></div>
<div class="paragraph"><p>So there you have the basic flow. Note that you don’t <em>have</em> to do chromium
development using these tools. Any git workflow is compatible, as long as
<code>git cl upload</code> is able to upload good patches.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_conclusion">CONCLUSION</h2>
<div class="sectionbody">
<div class="paragraph"><p>Hopefully that gives you a good starting overview on Chromium development using
<em>depot_tools</em>. If you have questions which weren’t answered by this tutorial or
the man pages for the tools (see the index of all tools here:
<a href="depot_tools.html">depot_tools(7)</a>), please feel free to ask.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_glossary">GLOSSARY</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
CL
</dt>
<dd>
<p>
A <em>change-list</em>. This is a diff which you would like to commit to the
codebase.
</p>
</dd>
<dt class="hdlist1">
DEPS
</dt>
<dd>
<p>
A file in the chromium checkout which <code>gclient sync</code> uses to determine what
dependencies to pull in. This file also contains <em>hooks</em>.
</p>
</dd>
<dt class="hdlist1">
LKGR
</dt>
<dd>
<p>
Last Known Good Revision. This is a <a href="git-tag.html">git-tag(1)</a> which tracks the last
version of <code>origin/main</code> which has passed the full set of testing on the
<a href="http://build.chromium.org">main Chromium waterfall</a>.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_chromium_depot_tools">CHROMIUM DEPOT_TOOLS</h2>
<div class="sectionbody">
<div class="paragraph"><p>Part of the chromium <a href="depot_tools.html">depot_tools(7)</a> suite. These tools are meant to
assist with the development of chromium and related projects. Download the tools
by checking out the <a href="https://chromium.googlesource.com/chromium/tools/depot_tools.git">git repository</a>.</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated
2025-05-07 21:15:19 UTC
</div>
</div>
</body>
</html>
|