summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual/toaster-manual-start.rst
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-11-20 20:17:33 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-01-04 10:55:00 +0000
commitfa0cb4d34b1073f215fa3c680f2316208739d53d (patch)
treeba89c1f4289fd6456af4409a6a19caf6548dfb9c /documentation/toaster-manual/toaster-manual-start.rst
parenta038e58f3cd82c56102444bdc5ac76c9f1550a0d (diff)
downloadpoky-fa0cb4d34b1073f215fa3c680f2316208739d53d.tar.gz
sphinx: import docs
The Yocto Project docs was migrated from Docbook to Sphinx in YP 3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to' the docs in 3.2, we agreed to backport sphinx docs onto 3.1. This first patch brings all changes done in 3.2 until: 7f64574f7 README: include detailed information about sphinx There are other changes after this commit, but they will be selectively backported in individual patches. This patch was generated with the following command: git cherry-pick -n \ $(git log --reverse --oneline \ ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \ | cut -f1 -d' ') The following commits were applies in the dunfell docs, but not in master, so they were first reverted (and squashed into this change). A commit will reintroduce the content from these patches in the Sphinx files in a followup patch. 069c27574 Documenation: Prepared for the 3.1.1 release bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit 17cc71a8f Documenation: Prepared for the 3.1.2 release 1a69e2c02 Documenation: Prepared for the 3.1.3 release 8910ac1c7 Documenation: Prepared for the 3.1.4 release (From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236) 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-start.rst')
-rw-r--r--documentation/toaster-manual/toaster-manual-start.rst57
1 files changed, 57 insertions, 0 deletions
diff --git a/documentation/toaster-manual/toaster-manual-start.rst b/documentation/toaster-manual/toaster-manual-start.rst
new file mode 100644
index 0000000000..2d612b8938
--- /dev/null
+++ b/documentation/toaster-manual/toaster-manual-start.rst
@@ -0,0 +1,57 @@
1.. SPDX-License-Identifier: CC-BY-2.0-UK
2.. Set default pygments highlighting to shell for this document
3.. highlight:: shell
4
5************************
6Preparing to Use Toaster
7************************
8
9This chapter describes how you need to prepare your system in order to
10use Toaster.
11
12.. _toaster-setting-up-the-basic-system-requirements:
13
14Setting Up the Basic System Requirements
15========================================
16
17Before you can use Toaster, you need to first set up your build system
18to run the Yocto Project. To do this, follow the instructions in the
19":ref:`dev-manual/dev-manual-start:preparing the build host`" section of
20the Yocto Project Development Tasks Manual. For Ubuntu/Debian, you might
21also need to do an additional install of pip3. ::
22
23 $ sudo apt-get install python3-pip
24
25.. _toaster-establishing-toaster-system-dependencies:
26
27Establishing Toaster System Dependencies
28========================================
29
30Toaster requires extra Python dependencies in order to run. A Toaster
31requirements file named ``toaster-requirements.txt`` defines the Python
32dependencies. The requirements file is located in the ``bitbake``
33directory, which is located in the root directory of the
34:term:`Source Directory` (e.g.
35``poky/bitbake/toaster-requirements.txt``). The dependencies appear in a
36``pip``, install-compatible format.
37
38.. _toaster-load-packages:
39
40Install Toaster Packages
41------------------------
42
43You need to install the packages that Toaster requires. Use this
44command::
45
46 $ pip3 install --user -r bitbake/toaster-requirements.txt
47
48The previous command installs the necessary Toaster modules into a local
49python 3 cache in your ``$HOME`` directory. The caches is actually
50located in ``$HOME/.local``. To see what packages have been installed
51into your ``$HOME`` directory, do the following::
52
53 $ pip3 list installed --local
54
55If you need to remove something, the following works::
56
57 $ pip3 uninstall PackageNameToUninstall