summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual/toaster-manual-intro.rst
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-06-26 19:10:51 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:33 +0100
commit9bd69b1f1d71a9692189beeac75af9dfbad816cc (patch)
tree305347fca899074aed5610e0e82eaec180bf630c /documentation/toaster-manual/toaster-manual-intro.rst
parentc40a8d5904c29046f1cbbeb998e6cd7c24f9b206 (diff)
downloadpoky-9bd69b1f1d71a9692189beeac75af9dfbad816cc.tar.gz
sphinx: initial sphinx support
This commit is autogenerated pandoc to generate an inital set of reST files based on DocBook XML files. A .rst file is generated for each .xml files in all manuals with this command: cd <manual> for i in *.xml; do \ pandoc -f docbook -t rst --shift-heading-level-by=-1 \ $i -o $(basename $i .xml).rst \ done The conversion was done with: pandoc 2.9.2.1-91 (Arch Linux). Also created an initial top level index file for each document, and added all 'books' to the top leve index.rst file. The YP manuals layout is organized as: Book Chapter Section Section Section Sphinx uses section headers to create the document structure. ReStructuredText defines sections headers like that: To break longer text up into sections, you use section headers. These are a single line of text (one or more words) with adornment: an underline alone, or an underline and an overline together, in dashes "-----", equals "======", tildes "~~~~~~" or any of the non-alphanumeric characters = - ` : ' " ~ ^ _ * + # < > that you feel comfortable with. An underline-only adornment is distinct from an overline-and-underline adornment using the same character. The underline/overline must be at least as long as the title text. Be consistent, since all sections marked with the same adornment style are deemed to be at the same level: Let's define the following convention when converting from Docbook: Book => overline === (Title) Chapter => overline *** (1.) Section => ==== (1.1) Section => ---- (1.1.1) Section => ~~~~ (1.1.1.1) Section => ^^^^ (1.1.1.1.1) During the conversion with pandoc, we used --shift-heading-level=-1 to convert most of DocBook headings automatically. However with this setting, the Chapter header was removed, so I added it back manually. Without this setting all headings were off by one, which was more difficult to manually fix. At least with this change, we now have the same TOC with Sphinx and DocBook. (From yocto-docs rev: 3c73d64a476d4423ee4c6808c685fa94d88d7df8) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/toaster-manual/toaster-manual-intro.rst')
-rw-r--r--documentation/toaster-manual/toaster-manual-intro.rst97
1 files changed, 97 insertions, 0 deletions
diff --git a/documentation/toaster-manual/toaster-manual-intro.rst b/documentation/toaster-manual/toaster-manual-intro.rst
new file mode 100644
index 0000000000..92d8c94c52
--- /dev/null
+++ b/documentation/toaster-manual/toaster-manual-intro.rst
@@ -0,0 +1,97 @@
1************
2Introduction
3************
4
5Toaster is a web interface to the Yocto Project's `OpenEmbedded build
6system <&YOCTO_DOCS_REF_URL;#build-system-term>`__. The interface
7enables you to configure and run your builds. Information about builds
8is collected and stored in a database. You can use Toaster to configure
9and start builds on multiple remote build servers.
10
11.. _intro-features:
12
13Toaster Features
14================
15
16Toaster allows you to configure and run builds, and it provides
17extensive information about the build process.
18
19- *Configure and Run Builds:* You can use the Toaster web interface to
20 configure and start your builds. Builds started using the Toaster web
21 interface are organized into projects. When you create a project, you
22 are asked to select a release, or version of the build system you
23 want to use for the project builds. As shipped, Toaster supports
24 Yocto Project releases 1.8 and beyond. With the Toaster web
25 interface, you can:
26
27 - Browse layers listed in the various `layer
28 sources <#layer-source>`__ that are available in your project
29 (e.g. the OpenEmbedded Layer Index at
30 ` <http://layers.openembedded.org/layerindex/>`__).
31
32 - Browse images, recipes, and machines provided by those layers.
33
34 - Import your own layers for building.
35
36 - Add and remove layers from your configuration.
37
38 - Set configuration variables.
39
40 - Select a target or multiple targets to build.
41
42 - Start your builds.
43
44 Toaster also allows you to configure and run your builds from the
45 command line, and switch between the command line and the web
46 interface at any time. Builds started from the command line appear
47 within a special Toaster project called "Command line builds".
48
49- *Information About the Build Process:* Toaster also records extensive
50 information about your builds. Toaster collects data for builds you
51 start from the web interface and from the command line as long as
52 Toaster is running.
53
54 .. note::
55
56 You must start Toaster before the build or it will not collect
57 build data.
58
59 With Toaster you can:
60
61 - See what was built (recipes and packages) and what packages were
62 installed into your final image.
63
64 - Browse the directory structure of your image.
65
66 - See the value of all variables in your build configuration, and
67 which files set each value.
68
69 - Examine error, warning, and trace messages to aid in debugging.
70
71 - See information about the BitBake tasks executed and reused during
72 your build, including those that used shared state.
73
74 - See dependency relationships between recipes, packages, and tasks.
75
76 - See performance information such as build time, task time, CPU
77 usage, and disk I/O.
78
79For an overview of Toaster shipped with the Yocto Project DISTRO
80Release, see the "`Toaster - Yocto Project
812.2 <https://youtu.be/BlXdOYLgPxA>`__" video.
82
83.. _toaster-installation-options:
84
85Installation Options
86====================
87
88You can set Toaster up to run as a local instance or as a shared hosted
89service.
90
91When Toaster is set up as a local instance, all the components reside on
92a single build host. Fundamentally, a local instance of Toaster is
93suited for a single user developing on a single build host.
94
95Toaster as a hosted service is suited for multiple users developing
96across several build hosts. When Toaster is set up as a hosted service,
97its components can be spread across several machines: