summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual
diff options
context:
space:
mode:
authorKristi Rifenbark <kristi.rifenbark@gmail.com>2017-10-12 16:29:54 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-10-16 23:46:53 +0100
commit4940360961525485a68a4fb8b19ef31886860cdb (patch)
treec6b9b8bd2397f2e094f47b83a6070fbbddf1100b /documentation/toaster-manual
parent4185ee35155f50c64ce8d905200ed272c9663a5b (diff)
downloadopenembedded-core-contrib-4940360961525485a68a4fb8b19ef31886860cdb.tar.gz
toaster-manual: Removed section "What Makes up a Release"
The content was obsolete. The new information is covered in the new chapter "Configuring Toaster". (From yocto-docs rev: 680273cb8fecea84297c3102c0b19fff5bcd9d88) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/toaster-manual')
-rw-r--r--documentation/toaster-manual/toaster-manual-reference.xml140
1 files changed, 0 insertions, 140 deletions
diff --git a/documentation/toaster-manual/toaster-manual-reference.xml b/documentation/toaster-manual/toaster-manual-reference.xml
index 94ece4e16d..9aeb1fe576 100644
--- a/documentation/toaster-manual/toaster-manual-reference.xml
+++ b/documentation/toaster-manual/toaster-manual-reference.xml
@@ -252,146 +252,6 @@
</itemizedlist>
</para>
</section>
-
- <section id='toaster-releases-comprised-of'>
- <title>What Makes Up a Release?</title>
-
- <para>
- A release consists of the following:
- <itemizedlist>
- <listitem><para><emphasis>Name:</emphasis>
- The name of the release (<filename>name</filename>).
- This release name never appears in the the Toaster
- web interface.
- Consequently, a user never sees the release name.
- </para></listitem>
- <listitem><para><emphasis>Description:</emphasis>
- The textual description of the release
- (<filename>description</filename>).
- This description is what users encounter when creating
- projects with the Toaster web interface.
- When you configure your release, be sure to use
- a description that sufficiently describes and is
- understandable.
- If Toaster has more than one release configured, the
- release descriptions appear listed in a drop down menu
- when a user creates a new project.
- If Toaster has only one release configured, all
- projects created using the web interface take that
- release and the drop down menu does not display in the
- Toaster web interface.
- </para></listitem>
- <listitem><para><emphasis>BitBake:</emphasis>
- The Bitbake version (<filename>bitbake</filename>)
- used to build layers set in the current release.
- This version is described by a name, a Git URL, a
- branch in the Git URL, and a directory path in the
- Git repository.
- As an example, consider the following snippet from
- a Toaster JSON configuration file.
- This BitBake version uses the master branch from the
- OpenEmbedded repository:
- <literallayout class='monospaced'>
- "bitbake" : [
- {
- "name": "master",
- "giturl": "git://git.openembedded.org/bitbake",
- "branch": "master",
- "dirpath": ""
- }
- ]
- </literallayout>
- Here is more detail on each of the items that comprise
- the BitBake version:
- <itemizedlist>
- <listitem><para><emphasis>Name:</emphasis>
- A string
- (<filename>name</filename>) used to refer to
- the version of BitBake you are using with
- Toaster.
- This name is never exposed through Toaster.
- </para></listitem>
- <listitem><para><emphasis>Git URL:</emphasis>
- The URL (<filename>giturl</filename>)
- for the BitBake Git repository cloned
- for Toaster projects.
- </para></listitem>
- <listitem><para><emphasis>Branch:</emphasis>
- The Git branch, or revision,
- (<filename>branch</filename>) of the BitBake
- repository used with Toaster.
- </para></listitem>
- <listitem><para><emphasis>Directory Path:</emphasis>
- The sub-directory of the BitBake repository
- (<filename>dirpath</filename>).
- If the Git URL includes more than one
- repository, you need to set this directory.
- If the URL does not include more than a single
- repository, you can set
- <filename>dirpath</filename> to a null string
- (i.e. "").
- </para></listitem>
- </itemizedlist>
- </para></listitem>
- <listitem><para><emphasis>Branch:</emphasis>
- The branch for the layer source
- (<filename>branch</filename>) used with the release.
- For example, for the OpenEmbedded layer source, the
- "master", "fido", and "jethro" branches are available.
- </para></listitem>
- <listitem><para><emphasis>Default Layers:</emphasis>
- The set of default layers
- (<filename>defaultlayers</filename>) automatically
- added to the project configuration when a project is
- created.
- </para></listitem>
- <listitem><para><emphasis>Layer Source Priorities</emphasis>
- A specification of
- <link linkend='layer-source'>layer source</link>
- priorities (<filename>layersourcepriority</filename>).
- In order for Toaster to work as intended, the
- "Imported layers" layer source should have the highest
- priority, which means that layers manually imported by
- users with the "Import layer" functionality will
- always be visible and available for selection.
- </para></listitem>
- <listitem><para><emphasis>Help Text:</emphasis>
- Help text (<filename>helptext</filename>) that explains
- what the release does when selected.
- This help text appears below the release drop-down
- menu when you create a Toaster project.
- The help text should assist users in making the correct
- decision regarding the release to use for a given
- project.
- </para></listitem>
- </itemizedlist>
- </para>
-
- <para>
- To summarize what comprises a release, consider the following
- example from a Toaster JSON file.
- The configuration names the release "master" and uses the
- "master" branch provided by the layer source of type
- "layerindex", which is called "OpenEmbedded", and sets
- the <filename>openembedded-core</filename> layer as the one
- to be added by default to any projects created in Toaster.
- The BitBake version used would be defined as shown earlier
- in the previous list:
- <literallayout class='monospaced'>
- "releases": [
- {
- "name": "master",
- "description": "OpenEmbedded master",
- "bitbake": "master",
- "branch": "master",
- "defaultlayers": [ "openembedded-core" ],
- "layersourcepriority": { "Imported layers": 99, "Local OpenEmbedded" : 10, "OpenEmbedded" : 0 },
- "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."
- }
- ]
- </literallayout>
- </para>
- </section>
</section>
<section id='toaster-json-files'>