[Toaster] Changes to the Toaster manual

[Barros Pena, Belen]

On 20/10/2015 20:06, "Scott Rifenbark" <srifenbark at gmail.com> wrote:

>Hi, 
>
>
>I got the chapter 3 changes roughed in.  Can't get to the small chapter 2
>change until later.  Here is the link to review the chapter 3 stuff -
>
>http://www.yoctoproject.org/docs/2.0/toaster-manual/toaster-manual.html#to
>aster-manual-setup-and-use
><http://www.yoctoproject.org/docs/2.0/toaster-manual/toaster-manual.html#t
>oaster-manual-setup-and-use>.

Thanks for this, Scott. Just a few omments:

* "(e.g. "Build Mode")," > this is not an example, it is one of the
operational modes explained in 1.1. Toaster Operational Modes. We don't
have an anchor to the build mode within that 1.1. Section, but if we could
split it and create one, that 'build mode' string should be a link to the
explanation of the build mode in the operational modes section.

* "to the root of your Toaster source directory:" > I don't think it
should say the 'Toaster source directory'. People didn't clone Toaster:
they cloned / downloaded the 2.0 Yocto Project release. That's the source
directory they need to navigate to. Maybe we should just use "navigate to
the root of your source directory", which you use further down.

* "If you would rather configure and start your builds using the command
line" > maybe we should add here "analysis mode" and link it to the
corresponding explanation in the toaster operational modes section

* Section 3.3 > I think I am missing something. I don't understand what
"execute path_to_poky/bitbake/bin/toaster" is supposed to mean. Maybe
Brian can explain (he wrote that bit). Also, I think the path is wrong.
The _toaster_clones directory is created inside poky
(poky/_toaster_clones) not inside
poky/bitbake/bin/toaster/_toaster_clones. It also says "if you used the
following command to start Toaster", but then no command is shown. Are we
missing the path_to_poky/bitbake/bin/toaster command here?

* Section 3.4 > all the above also applies to this section. The build
directory is inside poky (poky/build) not poky/bitbake/bin/toaster/build.
We are also missing the command you need to execute:
path_to_poky/bitbake/bin/toaster

* You can use the Django administration interface to set Toaster
configuration parameters such as the build directory, layer sources,
default variable values, and BitBake versions. > we need to test this. It
used to be the case, but I am not sure what's happening now after the set
up changes made by Brian

* to set up Toaster in Build Mode > this should again link to the
explanation of the build mode in the operational modes section

* Section 3.6.1 > the commands shown for Ubuntu and Fedora make sure you
comply with the apache, mod-wsgi and mysql requirements state above, but
that is not explicit from the layout.

* # change for any release name required > Only jethro and fido will
support this kind of set up, I think, so maybe we should remove that
sentence

* Make sure you make this edit further down in the file from where
BUILD_MODE is set based on the TOASTER_MANAGED environment variable > I am
not sure I understand this sentence. Does it mean that I have to add
BUILD_MODE after TOASTER_MANAGED in the file?

* Get Toaster to create the database schema, default data, and gather the
statically-served files: > should we break down the steps here to explain
what each line does? Those are not obvious for people outside
toaster-land. 

* Here are the commands: > I am not sure what those commands are for. Can
we explain?

>
>
>Note that I left the section in on using the web interface.  I am
>assuming that stuff stays.

Yes, although I'd like to list one more video if possible, about building
custom layers with Toaster. The video is here:

https://www.youtube.com/watch?v=QJzaE_XjX5c


Thanks!

Belén

>
>
>Let me know of any changes by using this email thread.
>
>
>Thanks, 
>
>Scott
>
>
>On Mon, Oct 19, 2015 at 4:09 AM, Barros Pena, Belen
><belen.barros.pena at intel.com> wrote:
>
>I have gone through the list of changes we put together for the Toaster
>manual, and most of them are already there. There is only one thing
>pending: changing Chapter 3, the one about setting up and using Toaster.
>
>The team has put together some new content for that section as a starting
>point. It's here
>
>http://piratepad.nl/YzSI38RuYd
>
>Note that it includes also some changes for section 2.1 (at the very top).
>
>There are 2 gaps in this new content:
>
>1. How to change the default location of the layers checkout directory
>2. How to change the default location of the build directory
>
>Brian: do you think you could add the above missing information to the
>pad, so that Scott can make the changes to the manual (if he has time)?
>
>Thanks!
>
>Belén
>
>
>
>
>
>