[Toaster] Changes to the Toaster manual

[Scott Rifenbark]

Belen,

These changes are in.


On Fri, Oct 23, 2015 at 2:10 AM, Barros Pena, Belen <
belen.barros.pena at intel.com> wrote:

> Hi Scott,
>
> This is looking pretty much ready to me. I am just nitpicking now :)
>
> * In sections 3.3 and 3.4, can we link 'build mode' to the explanation
> above?
>

Yes - done.


>
> * In section 3.4, where you say "In this example, Toaster creates and uses
> the poky/_toaster_clones directory to execute the builds" it should say
> "In this example, Toaster creates and uses the poky/build directory to
> execute the builds".
>

Ooops... cut and paste error.  Fixed.


>
> * In section 3.5, can we link the "Django framework" in the first
> paragraph to https://www.djangoproject.com/


Linked.

>
> * In section 3.6.2, when you say "The lsupdates command fetches the
> initial recipes and layers data from the layer index." I'd like to explain
> in a bit more detail. Something like:
>
> "The lsupdates command fetches information about machines, recipes and
> layers available as part of OpenEmbedded. The information is fetched from
> the OpenEmbedded Metadata Index. This information provides easy access to
> metadata from Toaster, and it is key for Toaster's usability. We do not
> recommend using Toaster without fetching this information."
>

Fixed with a slight modification to get the "we" stuff out.  Nicely written
by the way.


>
> "OpenEmbedded Metadata Index" should be a link to
> http://layers.openembedded.org


Link added.

>
> * In section 3.7.1, can we move the 'build custom layers' video under the
> 'build configuration' video? You should watch the build configuration
> video first, otherwise the build custom layers one might not make much
> sense.
>

Yes - moved.

>
> Thanks!
>
> Belén
>
>
> On 21/10/2015 18:57, "Scott Rifenbark" <srifenbark at gmail.com> wrote:
> >
> >
> >    * 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.
> >
> >
> >Not sure how you want this addressed.  So, I have added a note. Check it
> >out and let me know if this is okay.
>
> What about something like this, after the bullet point about MySQL:
>
> "To install all the above in an Ubuntu 14.0.x distribution, run the
> following:
>
> $ sudo apt-get install apache2 libapache2-mod-wsgi mysql-server virtualenv
> libmysqlclient-dev
>
>
> To install all the above in a Fedora 22 or a RedHat distribution, run the
> following:
>
> $ sudo dnf install httpd mod_wsgi python-virtualenv gcc mysql-devel"
>
>
> It's just about making explicit that those commands are the way to install
> the requirements listed in the section.
>
> >
> >
> >    * # 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
> >
> >
> >I replaced "jethro" in the command to use the variable &DISTRO_NAME,
> >which resolves to the "jethro" in this case.  It should never resolve to
> >anything prior to "jethro".  I took out the commented part of the command.
> >
> >
> >    * 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?
> >
> >
> >I added a note about this requirement and attempted to make it more clear.
> >
> >
> >
> >
> >
> >
> >TOASTER_MANAGED is an internal implementation detail now and does not
> >need to be mentioned.
> >
> >In section 3.6.2 step 3 the only instruction needed is "Set BUILD_MODE"
> >to True.
> >
> >
> >
> >
> >OK thanks.  I have removed that note.
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >    * 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.
> >
> >
> >I sent Belen a chat on Jabber regarding this comment.  I don't know how
> >these commands break out.  So if someone can provide some details on
> >these four commands I can wrap some context around them:
> >
> >$ ./bitbake/lib/toaster/manage.py syncdb --migrate
> >
> >
> >
> >This is a django-south command See
> >https://south.readthedocs.org/en/latest/commands.html
> ><https://south.readthedocs.org/en/latest/commands.html>
> >
> >
> >
> >I looked at the documentation for the syncdb command at this link and
> >tried to do some tracing back to get an understanding of the bigger
> >concept here.  I made a stab at trying to describe what this command does
> >at a high level.  Let me know if it is okay.
> >
> >
> >
> >
> >
> >
> >$ ./bitbake/lib/toaster/manage.py loadconf
> >./meta-yocto/conf/toasterconf.json
> >
> >
> >
> >
> http://www.yoctoproject.org/docs/2.0/toaster-manual/toaster-manual.html#to
> >aster-command-loadconf
> >
> >
> >
> >Got this one handled.
> >
> >
> >
> >
> >
> >$ ./bitbake/lib/toaster/manage.py lsupdates
> >
> >
> >
> >This fetches the initial recipes and layers data from the layer index.
> >
> >
> >
> >
> >Got this one handled.
> >
> >
> >
> >
> >
> >$ ./bitbake/lib/toaster/manage.py collectstatic
> >
> >
> >
> >This is a django framework command for collecting up all the statically
> >served files into a designated directory to be served up by the webserver
> >(Apache in the case of this documentation)
> >
> >https://docs.djangoproject.com/en/1.7/ref/contrib/staticfiles/
> >
> >
> >
> >
> >Got this covered.
> >
> >
> >
> >
> >
> >
> >    * Here are the commands: > I am not sure what those commands are
> >    for. Can
> >    we explain?
> >
> >
> >So for this area of the manual, I basically cut and pasted the stuff from
> >the file given to me.  I am clueless on what these commands do.  Can
> >someone provide some explanation around this block of commands?
> >
> >Alias /static /var/www/toaster/static_files
> ><Directory /var/www/toaster/static_files>
> >Order allow,deny
> >Allow from all
> >Require all granted
> ></Directory>
> >
> >WSGIDaemonProcess toaster_wsgi
> >python-path=/var/www/toaster/poky/bitbake/lib/toaster:/var/www/toaster/ven
> >v/lib/python2.7/site-packages
> >
> >WSGIScriptAlias /
> >"/var/www/toaster/poky/bitbake/lib/toaster/toastermain/wsgi.py"
> ><Location />
> >WSGIProcessGroup toastern_wsgi
> ></Location>
> >
> >
> >
> >
> >
> >This part isn't a command, it's a sample Apache configuration for
> >Toaster, it needs to be written and placed in the directory mentioned in
> >the instructions.
> >
> >
> >
> >
> >Ok, That makes sense.  I updated the leading text prior to the sample
> >configuration file to reflect that.  Let me know if this is okay.
> >
> >
> >
> >
> >
> >
> >Thanks,
> >
> >Michael
> >
> >
> >    >
> >    >
> >    >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
> ><https://www.youtube.com/watch?v=QJzaE_XjX5c>
> >
> >
> >Added to the list of current vids.
> >
> >
> >
> >
> >    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
> >    <mailto: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
> >    >
> >    >
> >    >
> >    >
> >    >
> >    >
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.yoctoproject.org/pipermail/toaster/attachments/20151023/dae767dc/attachment.html>