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>
author: Kristi Rifenbark <kristi.rifenbark@gmail.com> 2017-10-12 16:29:54 -0700
committer: Richard Purdie <richard.purdie@linuxfoundation.org> 2017-10-16 23:46:53 +0100
commit: 4940360961525485a68a4fb8b19ef31886860cdb (patch)
tree: c6b9b8bd2397f2e094f47b83a6070fbbddf1100b /documentation/toaster-manual
parent: 4185ee35155f50c64ce8d905200ed272c9663a5b (diff)
download: poky-4940360961525485a68a4fb8b19ef31886860cdb.tar.gz
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'>
author	Kristi Rifenbark <kristi.rifenbark@gmail.com>	2017-10-12 16:29:54 -0700
committer	Richard Purdie <richard.purdie@linuxfoundation.org>	2017-10-16 23:46:53 +0100
commit	4940360961525485a68a4fb8b19ef31886860cdb (patch)
tree	c6b9b8bd2397f2e094f47b83a6070fbbddf1100b /documentation/toaster-manual
parent	4185ee35155f50c64ce8d905200ed272c9663a5b (diff)
download	poky-4940360961525485a68a4fb8b19ef31886860cdb.tar.gz

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 @@
252	</itemizedlist>	252	</itemizedlist>
253	</para>	253	</para>
254	</section>	254	</section>
255
256	<section id='toaster-releases-comprised-of'>
257	<title>What Makes Up a Release?</title>
258
259	<para>
260	A release consists of the following:
261	<itemizedlist>
262	<listitem><para><emphasis>Name:</emphasis>
263	The name of the release (<filename>name</filename>).
264	This release name never appears in the the Toaster
265	web interface.
266	Consequently, a user never sees the release name.
267	</para></listitem>
268	<listitem><para><emphasis>Description:</emphasis>
269	The textual description of the release
270	(<filename>description</filename>).
271	This description is what users encounter when creating
272	projects with the Toaster web interface.
273	When you configure your release, be sure to use
274	a description that sufficiently describes and is
275	understandable.
276	If Toaster has more than one release configured, the
277	release descriptions appear listed in a drop down menu
278	when a user creates a new project.
279	If Toaster has only one release configured, all
280	projects created using the web interface take that
281	release and the drop down menu does not display in the
282	Toaster web interface.
283	</para></listitem>
284	<listitem><para><emphasis>BitBake:</emphasis>
285	The Bitbake version (<filename>bitbake</filename>)
286	used to build layers set in the current release.
287	This version is described by a name, a Git URL, a
288	branch in the Git URL, and a directory path in the
289	Git repository.
290	As an example, consider the following snippet from
291	a Toaster JSON configuration file.
292	This BitBake version uses the master branch from the
293	OpenEmbedded repository:
294	<literallayout class='monospaced'>
295	"bitbake" : [
296	{
297	"name": "master",
298	"giturl": "git://git.openembedded.org/bitbake",
299	"branch": "master",
300	"dirpath": ""
301	}
302	]
303	</literallayout>
304	Here is more detail on each of the items that comprise
305	the BitBake version:
306	<itemizedlist>
307	<listitem><para><emphasis>Name:</emphasis>
308	A string
309	(<filename>name</filename>) used to refer to
310	the version of BitBake you are using with
311	Toaster.
312	This name is never exposed through Toaster.
313	</para></listitem>
314	<listitem><para><emphasis>Git URL:</emphasis>
315	The URL (<filename>giturl</filename>)
316	for the BitBake Git repository cloned
317	for Toaster projects.
318	</para></listitem>
319	<listitem><para><emphasis>Branch:</emphasis>
320	The Git branch, or revision,
321	(<filename>branch</filename>) of the BitBake
322	repository used with Toaster.
323	</para></listitem>
324	<listitem><para><emphasis>Directory Path:</emphasis>
325	The sub-directory of the BitBake repository
326	(<filename>dirpath</filename>).
327	If the Git URL includes more than one
328	repository, you need to set this directory.
329	If the URL does not include more than a single
330	repository, you can set
331	<filename>dirpath</filename> to a null string
332	(i.e. "").
333	</para></listitem>
334	</itemizedlist>
335	</para></listitem>
336	<listitem><para><emphasis>Branch:</emphasis>
337	The branch for the layer source
338	(<filename>branch</filename>) used with the release.
339	For example, for the OpenEmbedded layer source, the
340	"master", "fido", and "jethro" branches are available.
341	</para></listitem>
342	<listitem><para><emphasis>Default Layers:</emphasis>
343	The set of default layers
344	(<filename>defaultlayers</filename>) automatically
345	added to the project configuration when a project is
346	created.
347	</para></listitem>
348	<listitem><para><emphasis>Layer Source Priorities</emphasis>
349	A specification of
350	<link linkend='layer-source'>layer source</link>
351	priorities (<filename>layersourcepriority</filename>).
352	In order for Toaster to work as intended, the
353	"Imported layers" layer source should have the highest
354	priority, which means that layers manually imported by
355	users with the "Import layer" functionality will
356	always be visible and available for selection.
357	</para></listitem>
358	<listitem><para><emphasis>Help Text:</emphasis>
359	Help text (<filename>helptext</filename>) that explains
360	what the release does when selected.
361	This help text appears below the release drop-down
362	menu when you create a Toaster project.
363	The help text should assist users in making the correct
364	decision regarding the release to use for a given
365	project.
366	</para></listitem>
367	</itemizedlist>
368	</para>
369
370	<para>
371	To summarize what comprises a release, consider the following
372	example from a Toaster JSON file.
373	The configuration names the release "master" and uses the
374	"master" branch provided by the layer source of type
375	"layerindex", which is called "OpenEmbedded", and sets
376	the <filename>openembedded-core</filename> layer as the one
377	to be added by default to any projects created in Toaster.
378	The BitBake version used would be defined as shown earlier
379	in the previous list:
380	<literallayout class='monospaced'>
381	"releases": [
382	{
383	"name": "master",
384	"description": "OpenEmbedded master",
385	"bitbake": "master",
386	"branch": "master",
387	"defaultlayers": [ "openembedded-core" ],
388	"layersourcepriority": { "Imported layers": 99, "Local OpenEmbedded" : 10, "OpenEmbedded" : 0 },
389	"helptext": "Toaster will run your builds using the tip of the <a href=\"http://git.yoctoproject.org/cgit/cgit.cgi/poky/log/\">Yocto Project master branch</a>, where active development takes place. This is not a stable branch, so your builds might not work as expected."
390	}
391	]
392	</literallayout>
393	</para>
394	</section>
395	</section>	255	</section>
396		256
397	<section id='toaster-json-files'>	257	<section id='toaster-json-files'>