Commit Graph

11 Commits

Author SHA1 Message Date
brian avery 64b8e17892 toaster-manual: Switch to pip3 dependency installer
Our switch to python3 requires us to dump the virtualenv approach
as long as we need python to resolve to python2 in the same shell
that python3 resolves to python3. To enable users to install
Toaster's python package dependencies locally, we are changing to
using pip3 and these doc changes explain how to do that.

(From yocto-docs rev: 06b8820bcb90d1855ccb2712b616bb89847a148f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:49 +01:00
Scott Rifenbark b73da6b457 toaster-manual: Added new Toaster functionality descriptions.
Flow and usage information has changed.  Changes here reflect
that from the Toaster Team.

(From yocto-docs rev: 9774dec014b6d13623988b0d7c050c9e6deaad6f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-27 07:28:22 +00:00
Scott Rifenbark ae0d508d81 toaster-manual: Added note for creating virtual environment
Added a note strongly suggesting that the user should set up
this virtual environment even though it is not required.

(From yocto-docs rev: 1e5f5c7e36eb8541d0d0e2c7e5d37d65c84946bf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:06:33 +01:00
Scott Rifenbark 7facee681a toaster-manual: Updated the section for setting up virtual env.
The section for setting up a Python virtual environment has
gone from "optional" to "required".  I re-worded the section
as such.

(From yocto-docs rev: 3a20244c8b0b594723c0b35c8808bb96a210d63a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:06:33 +01:00
Scott Rifenbark ab23dd967e yocto-project-qs and others: Rewrite of the QS
This was a complete re-write of the YP Quick Start in an attempt
to streamline it, remove unecessary detail, and make it flow better
with the examples.  In doing so, many manuals were affected due to
section headings being renamed, information being moved, etc.  Here
is a list of the changes by manual:

Makefile - Removed two figures from TARFILE list for the
           yocto-project-qs.

           Added building-an-image.png to the ref-manual TARFILE list.

           Added using-a-pre-build-image.png to the adt-manual TARFILE
           list.

           Repositioned 'eclipse' in the adt-manual TARFILE list.

adt-manual: Fixed a cross-reference so that it goes to the new
            'Building Images' section that is within the YP QS.

            Added new section 'Example Using Pre-Build Binaries and
            QEMU' to hold the information that was formerly in YP QS.

dev-manual: Removed a cross-reference into the YP QS that promised how
            to configure the most efficent build.

            Changed a cross-reference into the YP QS from 'The Packages'
            to 'The Build System Packages'.

            Changed a cross-reference into the YP QS from 'Building an
            Image' to 'Building Images'.

            Changed a text reference from the YP QS to the adt-manual.

            Moved the bit about getting YP files by using the YP website
            from the YP QS to the dev-manual.

            Changed a cross-reference into the YP QS from 'Using Pre-Built
            Binaries and QEMU' to 'Example Using Pre-built Binaries and
            QEMU', which was moved to the adt-manual.

ref-manual: Changed a cross-reference into the YP QS from 'What You
            Need and How You Get It' to 'Setting Up to Use the Yocto Project'.

            Moved the note about if your system has oss4-dev in the
            packages area in the YP QS to the appropriate area in the
            ref-manual.

            Moved the introduction information regarding building an image
            along with the figure from YP QS to the ref-manual's section on
            building images.

toaster-manual: Changed a cross-reference into the YP QS from 'What You
                Need and How You Get It' to 'Setting Up to Use the Yocto
                Project'.

yocto-project-qs: Complete rewrite that changed many section headings and
                  removed much detail, which was placed in other manuals.

(From yocto-docs rev: da4ed8147b04963a700caa784bda709c57b4eb6e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:32 +01:00
Scott Rifenbark 39bcabf513 toaster-manual: Removed the daemon requirement
Fixes [YOCTO #7271]

Removed all traces of the daemon requirement.

(From yocto-docs rev: 1c1da060322e7e964f860dc4b80b5411ea19b1b3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:31 +01:00
Scott Rifenbark a9d25bd676 toaster-manual: Made some updates for virtual environment section.
I moved the note that tells the user they have to initialize the
virtual environment every time before starting Toaster to the
correct location.  I had it misplaced.

(From yocto-docs rev: 65258338e1ffb92ded573ea3b447b424b5f5fa97)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 12:59:17 +01:00
Scott Rifenbark d0e413e011 toaster-manual: Added note telling user to initialize virtual env
The user must re-initialize the virtual environment (if installed)
prior to starting Toaster each time.

(From yocto-docs rev: b0daa23784f17778f758b0572f90f9293a822812)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 12:59:14 +01:00
Scott Rifenbark 85a0b9b941 toaster-manual: Draft of Manual.
Fixes [YOCTO #6901]

(From yocto-docs rev: 258b46b0f3e23045b5fb8c97d03dceb69db5ce20)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 12:59:10 +01:00
Scott Rifenbark 586992d24e toaster-manual: 2nd draft for review.
Fixes [YOCTO #6901]

This is the 2nd review draft of the manual.

(From yocto-docs rev: 9f541e4421e0e74e59e3b3da1896b6c1254daf08)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:17:03 +00:00
Scott Rifenbark 9d033d83cc toaster-manual: Added two chapter files.
Fixes [YOCTO #6901]

These are the second and third chapters of the Toaster Manual.

(From yocto-docs rev: 6ff4e3dfff391efdbb0f36dc6800bf115abcfc92)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:58 +00:00