summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2015-11-04 10:19:12 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-11-18 16:44:02 +0000
commite3425d4b0d285a71b061dcea1e0b084033054e4f (patch)
tree3a504508b5712513f77afa499feffc0b3ec0aaa5
parent5752ef3892d02dc47e226bfb01eabdf7400f748b (diff)
downloadpoky-e3425d4b0d285a71b061dcea1e0b084033054e4f.tar.gz
toaster-manual: Updated to remove 'master' as the default branch
Made several changes as Toaster will not support using the 'master' branch now. (From yocto-docs rev: cc7e1273944d72388ba4202cbf7146a909d1cdac) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/toaster-manual/toaster-manual-reference.xml68
-rw-r--r--documentation/toaster-manual/toaster-manual-setup-and-use.xml21
2 files changed, 33 insertions, 56 deletions
diff --git a/documentation/toaster-manual/toaster-manual-reference.xml b/documentation/toaster-manual/toaster-manual-reference.xml
index 0c9401ff30..381e4c34a6 100644
--- a/documentation/toaster-manual/toaster-manual-reference.xml
+++ b/documentation/toaster-manual/toaster-manual-reference.xml
@@ -219,7 +219,7 @@
219 "name": "Local Yocto Project", 219 "name": "Local Yocto Project",
220 "sourcetype": "local", 220 "sourcetype": "local",
221 "apiurl": "../../", 221 "apiurl": "../../",
222 "branches": ["HEAD", "master", "fido", "dizzy"], 222 "branches": ["HEAD", "fido", "dizzy"],
223 "layers": [ 223 "layers": [
224 { 224 {
225 "name": "openembedded-core", 225 "name": "openembedded-core",
@@ -246,13 +246,13 @@
246 "name": "OpenEmbedded", 246 "name": "OpenEmbedded",
247 "sourcetype": "layerindex", 247 "sourcetype": "layerindex",
248 "apiurl": "http://layers.openembedded.org/layerindex/api/", 248 "apiurl": "http://layers.openembedded.org/layerindex/api/",
249 "branches": ["master", "fido", "dizzy"] 249 "branches": ["fido", "dizzy"]
250 }, 250 },
251 { 251 {
252 "name": "Imported layers", 252 "name": "Imported layers",
253 "sourcetype": "imported", 253 "sourcetype": "imported",
254 "apiurl": "", 254 "apiurl": "",
255 "branches": ["master", "fido", "dizzy", "HEAD"] 255 "branches": ["fido", "dizzy", "HEAD"]
256 256
257 } 257 }
258 ], 258 ],
@@ -268,8 +268,7 @@
268 indicate which branches from your layer source you want 268 indicate which branches from your layer source you want
269 to make available through Toaster. 269 to make available through Toaster.
270 For example, the OpenEmbedded layer source makes 270 For example, the OpenEmbedded layer source makes
271 available only its "master", "fido", and "dizzy" 271 available only its "fido" and "dizzy" branches.
272 branches.
273 </para> 272 </para>
274 273
275 <para> 274 <para>
@@ -387,14 +386,6 @@
387 or 386 or
388 <ulink url='http://git.openembedded.org/openembedded-core/commit/?h=fido'></ulink>. 387 <ulink url='http://git.openembedded.org/openembedded-core/commit/?h=fido'></ulink>.
389 </para></listitem> 388 </para></listitem>
390 <listitem><para><emphasis>Yocto Project "Master" or OpenEmbedded "Master":</emphasis>
391 This release causes your Toaster Projects to
392 build against the head of the master branch, which is
393 where active development takes place, at
394 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/log/'></ulink>
395 or
396 <ulink url='http://git.openembedded.org/openembedded-core/log/'></ulink>.
397 </para></listitem>
398 <listitem><para><emphasis>Local Yocto Project or Local OpenEmbedded:</emphasis> 389 <listitem><para><emphasis>Local Yocto Project or Local OpenEmbedded:</emphasis>
399 This release causes your Toaster Projects to 390 This release causes your Toaster Projects to
400 build against the head of the <filename>poky</filename> 391 build against the head of the <filename>poky</filename>
@@ -441,14 +432,14 @@
441 Git repository. 432 Git repository.
442 As an example, consider the following snippet from 433 As an example, consider the following snippet from
443 a Toaster JSON configuration file. 434 a Toaster JSON configuration file.
444 This BitBake version uses the master branch from the 435 This BitBake version uses the fido branch from the
445 OpenEmbedded repository: 436 OpenEmbedded repository:
446 <literallayout class='monospaced'> 437 <literallayout class='monospaced'>
447 "bitbake" : [ 438 "bitbake" : [
448 { 439 {
449 "name": "master", 440 "name": "fido",
450 "giturl": "git://git.openembedded.org/bitbake", 441 "giturl": "git://git.openembedded.org/bitbake",
451 "branch": "master", 442 "branch": "1.26",
452 "dirpath": "" 443 "dirpath": ""
453 } 444 }
454 ] 445 ]
@@ -489,7 +480,7 @@
489 The branch for the layer source 480 The branch for the layer source
490 (<filename>branch</filename>) used with the release. 481 (<filename>branch</filename>) used with the release.
491 For example, for the OpenEmbedded layer source, the 482 For example, for the OpenEmbedded layer source, the
492 "master", "fido", and "dizzy" branches are available. 483 "fido" and "dizzy" branches are available.
493 </para></listitem> 484 </para></listitem>
494 <listitem><para><emphasis>Default Layers:</emphasis> 485 <listitem><para><emphasis>Default Layers:</emphasis>
495 The set of default layers 486 The set of default layers
@@ -522,8 +513,8 @@
522 <para> 513 <para>
523 To summarize what comprises a release, consider the following 514 To summarize what comprises a release, consider the following
524 example from a Toaster JSON file. 515 example from a Toaster JSON file.
525 The configuration names the release "master" and uses the 516 The configuration names the release "fido" and uses the
526 "master" branch provided by the layer source of type 517 "fido" branch provided by the layer source of type
527 "layerindex", which is called "OpenEmbedded", and sets 518 "layerindex", which is called "OpenEmbedded", and sets
528 the <filename>openembedded-core</filename> layer as the one 519 the <filename>openembedded-core</filename> layer as the one
529 to be added by default to any projects created in Toaster. 520 to be added by default to any projects created in Toaster.
@@ -532,13 +523,13 @@
532 <literallayout class='monospaced'> 523 <literallayout class='monospaced'>
533 "releases": [ 524 "releases": [
534 { 525 {
535 "name": "master", 526 "name": "fido",
536 "description": "OpenEmbedded master", 527 "description": "OpenEmbedded fido",
537 "bitbake": "master", 528 "bitbake": "fido",
538 "branch": "master", 529 "branch": "fido",
539 "defaultlayers": [ "openembedded-core" ], 530 "defaultlayers": [ "openembedded-core" ],
540 "layersourcepriority": { "Imported layers": 99, "Local OpenEmbedded" : 10, "OpenEmbedded" : 0 }, 531 "layersourcepriority": { "Imported layers": 99, "Local OpenEmbedded" : 10, "OpenEmbedded" : 0 },
541 "helptext": "Toaster will run your builds using the OpenEmbedded master branch, where active development takes place. This is not a stable branch, so your builds might not work as expected." 532 "helptext": "Toaster will run your builds using the OpenEmbedded fido branch."
542 } 533 }
543 ] 534 ]
544 </literallayout> 535 </literallayout>
@@ -715,7 +706,7 @@
715 "name": "Local Yocto Project", 706 "name": "Local Yocto Project",
716 "sourcetype": "local", 707 "sourcetype": "local",
717 "apiurl": "../../", 708 "apiurl": "../../",
718 "branches": ["HEAD", "master", "fido", "dizzy"], 709 "branches": ["HEAD", "fido", "dizzy"],
719 "layers": [ 710 "layers": [
720 { 711 {
721 "name": "openembedded-core", 712 "name": "openembedded-core",
@@ -742,13 +733,13 @@
742 "name": "OpenEmbedded", 733 "name": "OpenEmbedded",
743 "sourcetype": "layerindex", 734 "sourcetype": "layerindex",
744 "apiurl": "http://layers.openembedded.org/layerindex/api/", 735 "apiurl": "http://layers.openembedded.org/layerindex/api/",
745 "branches": ["master", "fido", "dizzy"] 736 "branches": ["fido", "dizzy"]
746 }, 737 },
747 { 738 {
748 "name": "Imported layers", 739 "name": "Imported layers",
749 "sourcetype": "imported", 740 "sourcetype": "imported",
750 "apiurl": "", 741 "apiurl": "",
751 "branches": ["master", "fido", "dizzy", "HEAD"] 742 "branches": ["fido", "dizzy", "HEAD"]
752 743
753 } 744 }
754 ], 745 ],
@@ -762,8 +753,8 @@
762 <para> 753 <para>
763 This area of the JSON file defines the version of 754 This area of the JSON file defines the version of
764 BitBake Toaster uses. 755 BitBake Toaster uses.
765 As shipped, Toaster is configured to recognize four 756 As shipped, Toaster is configured to recognize three
766 versions of BitBake: master, fido, dizzy, and HEAD. 757 versions of BitBake: fido, dizzy, and HEAD.
767 <note> 758 <note>
768 HEAD is a special option that builds whatever is 759 HEAD is a special option that builds whatever is
769 available on disk, without checking out any remote 760 available on disk, without checking out any remote
@@ -776,12 +767,6 @@
776 <literallayout class='monospaced'> 767 <literallayout class='monospaced'>
777 "bitbake" : [ 768 "bitbake" : [
778 { 769 {
779 "name": "master",
780 "giturl": "remote:origin",
781 "branch": "master",
782 "dirpath": "bitbake"
783 },
784 {
785 "name": "fido", 770 "name": "fido",
786 "giturl": "remote:origin", 771 "giturl": "remote:origin",
787 "branch": "fido", 772 "branch": "fido",
@@ -810,14 +795,14 @@
810 <para> 795 <para>
811 This area of the JSON file establishes a default 796 This area of the JSON file establishes a default
812 release used by Toaster. 797 release used by Toaster.
813 As shipped, Toaster uses the "master" release. 798 As shipped, Toaster uses the "fido" release.
814 </para> 799 </para>
815 800
816 <para> 801 <para>
817 Here is the statement in the JSON file that establishes 802 Here is the statement in the JSON file that establishes
818 the default release: 803 the default release:
819 <literallayout class='monospaced'> 804 <literallayout class='monospaced'>
820 "defaultrelease": "master", 805 "defaultrelease": "fido",
821 </literallayout> 806 </literallayout>
822 </para> 807 </para>
823 </section> 808 </section>
@@ -839,15 +824,6 @@
839 <literallayout class='monospaced'> 824 <literallayout class='monospaced'>
840 "releases": [ 825 "releases": [
841 { 826 {
842 "name": "master",
843 "description": "Yocto Project master",
844 "bitbake": "master",
845 "branch": "master",
846 "defaultlayers": [ "openembedded-core", "meta-yocto", "meta-yocto-bsp"],
847 "layersourcepriority": { "Imported layers": 99, "Local Yocto Project" : 10, "OpenEmbedded" : 0 },
848 "helptext": "Toaster will run your builds using the tip of the &lt;a href=\"http://git.yoctoproject.org/cgit/cgit.cgi/poky/log/\"&gt;Yocto Project master branch&lt;/a&gt;, where active development takes place. This is not a stable branch, so your builds might not work as expected."
849 },
850 {
851 "name": "fido", 827 "name": "fido",
852 "description": "Yocto Project 1.8 Fido", 828 "description": "Yocto Project 1.8 Fido",
853 "bitbake": "fido", 829 "bitbake": "fido",
diff --git a/documentation/toaster-manual/toaster-manual-setup-and-use.xml b/documentation/toaster-manual/toaster-manual-setup-and-use.xml
index a1546858d9..e66ebdd757 100644
--- a/documentation/toaster-manual/toaster-manual-setup-and-use.xml
+++ b/documentation/toaster-manual/toaster-manual-setup-and-use.xml
@@ -506,7 +506,7 @@
506 MANAGED="True" 506 MANAGED="True"
507 </literallayout> 507 </literallayout>
508 </para></listitem> 508 </para></listitem>
509 <listitem><para><emphasis>Set Up Toaster for Normal Usage:</emphasis> 509<!-- <listitem><para><emphasis>Set Up Toaster for Normal Usage:</emphasis>
510 You need to configure each build environment, layer 510 You need to configure each build environment, layer
511 sources, and BitBake versions.</para> 511 sources, and BitBake versions.</para>
512 <para>Verify that your releases have been loaded correctly by 512 <para>Verify that your releases have been loaded correctly by
@@ -539,9 +539,9 @@
539 539
540 # Go to Home, Bitbake Versions, Add bitbake version; 540 # Go to Home, Bitbake Versions, Add bitbake version;
541 # Take version information from: http://git.openembedded.org/bitbake/refs/heads, 541 # Take version information from: http://git.openembedded.org/bitbake/refs/heads,
542 # This example assumes "master" version. 542 # This example assumes "fido" version.
543 # set Name: master, Giturl git://git.openembedded.org/bitbake 543 # set Name: fido, Giturl git://git.openembedded.org/bitbake
544 # branch master, dirpath / 544 # branch fido, dirpath /
545 # Save your changes and exit 545 # Save your changes and exit
546 </literallayout> 546 </literallayout>
547 You also need to configure the project releases, the 547 You also need to configure the project releases, the
@@ -550,19 +550,19 @@
550 Continuing with the example: 550 Continuing with the example:
551 <literallayout class='monospaced'> 551 <literallayout class='monospaced'>
552 # Go to Home, Releases, Add release 552 # Go to Home, Releases, Add release
553 # set Name: master, Description: Current master release, select Bitbake Version, 553 # set Name: fido, Description: Current fido release, select Bitbake Version,
554 # and Branch: master 554 # and Branch: fido
555 # Save your changes and exit 555 # Save your changes and exit
556 556
557 # Go to Home, Toaster Settings, select the Setting for DEFAULT_RELEASE 557 # Go to Home, Toaster Settings, select the Setting for DEFAULT_RELEASE
558 # set Helptext: This selects the default release., Value: master 558 # set Helptext: This selects the default release., Value: fido
559 # Save your changes and exit 559 # Save your changes and exit
560 560
561 # Go to Home, Bitbake Versions, Add bitbake version; 561 # Go to Home, Bitbake Versions, Add bitbake version;
562 # take version information from : http://git.openembedded.org/bitbake/refs/heads, 562 # take version information from : http://git.openembedded.org/bitbake/refs/heads,
563 # this manual assumes the master version 563 # this manual assumes the fido version
564 # set Name: master, Giturl git://git.openembedded.org/bitbake 564 # set Name: fido, Giturl git://git.openembedded.org/bitbake
565 # branch master, dirpath / 565 # branch fido, dirpath /
566 # Save your changes and exit 566 # Save your changes and exit
567 567
568 # Update the information 568 # Update the information
@@ -573,6 +573,7 @@
573 "<link linkend='toaster-useful-commands'>Useful Commands</link>" 573 "<link linkend='toaster-useful-commands'>Useful Commands</link>"
574 section. 574 section.
575 </para></listitem> 575 </para></listitem>
576-->
576 <listitem><para><emphasis>Install and Set up the Database Server:</emphasis> 577 <listitem><para><emphasis>Install and Set up the Database Server:</emphasis>
577 You can use any SQL server out of the box. 578 You can use any SQL server out of the box.
578 It is recommended that you use 579 It is recommended that you use