[Toaster] Toaster documentation, 1.6 release

Mon Mar 31 13:03:58 PDT 2014

On Mon, Mar 31, 2014 at 11:01 AM, Damian, Alexandru <
alexandru.damian at intel.com> wrote:

> This version is clear and explicit for me. But I understand that this may
> be a bit confusing for some users.
>
> I have more comments below, for Scott's concerns.
>
> Thank you, guys!
> Alex
>
>
> On Thu, Mar 27, 2014 at 10:30 AM, Barros Pena, Belen <
> belen.barros.pena at intel.com> wrote:
>
>> Thanks, Scott. Alex should review it when he has a chance.
>>
>> Cheers
>>
>> Belén
>>
>> On 26/03/2014 12:31, "Scott Rifenbark" <srifenbark at gmail.com> wrote:
>>
>> >Hi Belen,
>> >
>> >
>> >Here is a re-written version.  I did not know how to cast that very last
>> >sentence.  It seemed to come from nowhere.  The piece talks about two
>> >commands, the build directory and two files (toaster.sqlite and
>> >toastermain/setting.py).  The manage.py thing comes
>> > out of the blue.  So, I just put it at the end.  I imagine there is some
>> >relationship between it and the rest of the information.  If I knew the
>> >relationship I could work it into the main stuff a little better.
>>
>
> 
> [Alex]
> manage.py is referring to this file in the tree:
> bitbake/lib/toaster/manage.py
> It's the main Django control script in the toaster project. Maybe we should
> make this clear, and spell out the entire name ?
>

Alex - I would use the full path name just to be clear about that manage.py
file.

>
>  >
>> >
>> >
>> >Also, I am not sure if the "build/" directory means literally the default
>> >build directory, which is named "build", or if it means the build
>>
>
> [Alex] It's 
>
> the build directory in the general sense, I assumed that the users
> don't change this name, hence the 'build/' reference. How is it called in
> other
> pieces of documentation ?
>

Alex - in the mainstream YP documentation, the build directory is
consistently referred to as "Build Directory."  When I use the term in a
chapter or section I try to link the term to the formal definition in the
dev-manual.  I don't link every occurrence but the first ones to appear in
major sections or chapters.  The link is
http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#build-directory.
When I am referring to an actual Build Directory, I format it using a
different font (Courier) and use the actual name.  So, if it is the default
Build Directory, I say the build directory, and the word "build" appears in
the font reserved for filenames and commands throughout the YP
documentation.

>
> 
>
>> >directory in a general sense, which could be named I suppose whatever the
>> >user wants it to be named.
>> >
>> >
>> >Finally, I am not mentioning the words "pre-requisites" or "requirements"
>> >in the re-write even though the original text cast the information as
>> >such.  Really, what is here doesn't qualify as per-requisites.  They are
>> >more like "behaviors".
>> >
>> >
>> >Hope this helps.  Let me know if you need further work on it.
>> >
>> >
>> >Scott
>> >
>> >
>> >=============================================
>> >
>> >
>> >When using the buildslist and builddelete commands, you need to consider
>> >the following:
>> >
>> >
>> >* For default configurations, your working directory must be the "build"
>> >directory.  Using these command from the "build" directory allows Toaster
>> >to find the "toaster.sqlite" file, which is located in the "build"
>> >directory.
>> >
>> >
>> >* For other database configurations, it is possible that you can use
>> >these commands from a directory other than the "build" directory.  To do
>> >so, the "toastermain/settings.py" file must be configured to point to the
>> >correct database backend.
>> >
>> >
>> >It is recommended to always call "manage.py" from the "build" directory.
>> >
>> >==========================================================
>> >
>> >
>> >On Wed, Mar 26, 2014 at 5:23 AM, Barros Pena, Belen
>> ><belen.barros.pena at intel.com> wrote:
>> >
>> >Hi Scott,
>> >
>> >There is some more detail we need to add to the explanation about how to
>> >delete builds from the Toaster database. This is Alex's explanation:
>> >
>> >The buildslist and builddelete commands have some prerequisites in terms
>> >of how they're invoked:
>> >
>> >* in the default configuration, the current working directory needs to be
>> >the 'build/' directory as to let the system find the "toaster.sqlite"
>> file
>> >in this directory
>> >
>> >* in other database configuration, it may be possible to invoke from
>> other
>> >directories, provided that the toastermain/settings.py file is correctly
>> >configured as to point to the correct database backend.
>> >
>> >I recommend to always call manage.py from the "build/" directory.
>> >
>> >Thanks!
>> >
>> >Belén
>> >
>> >
>> >
>> >On 19/03/2014 21:55, "Scott Rifenbark" <srifenbark at gmail.com> wrote:
>> >
>> >
>> >>Here is a quick section on deleting a build from the toaster database.
>> >>
>> >>-----------------------------------
>> >>
>> >>Deleting a Build from the Toaster Database
>> >>
>> >>
>> >>You can use the manage.py command, which is located in the
>> >>/poky/bitbake/lib/toaster directory to identify and delete builds from
>> >>the Toaster database.  Follow these steps to delete a build:
>> >>
>> >>
>> >>1. Identify the build:  Run the following command from the toaster
>> >>directory to display a user-readable, tabbed list of build IDs and
>> >>identification information:
>> >>
>> >>
>> >>     ./manage.py buildslist
>> >>
>> >>
>> >>2. Delete a specific build: Using the build ID displayed in the previous
>> >>step, run the following command to delete a specific build:
>> >>
>> >>
>> >>     ./manage.py <build_id>
>> >>
>> >>
>> >>The build and all related information is deleted from the Toaster
>> >>database.  The deletion operation traverses the ForeignKey relationships
>> >>recursively.
>> >>
>> >>
>> >>
>> >>
>> >>
>> >>On Wed, Mar 19, 2014 at 10:52 AM, Barros Pena, Belen
>> >><belen.barros.pena at intel.com> wrote:
>> >>
>> >>Hi Scott,
>> >>
>> >>There is one more thing that needs to be documented: how to delete
>> builds
>> >>from the Toaster database.
>> >>
>> >>https://bugzilla.yoctoproject.org/show_bug.cgi?id=4625
>> >>
>> >>There is a file in the /poky/bitbake/lib/toaster directory called
>> >>manage.py. You can run that file with additional commands. There are 2
>> >>commands relevant to delete builds:
>> >>
>> >>1. buildslist
>> >>This command is run ./manage.py buildslist and it will show you a
>> >>user-readable tabbed list of build ids and identification information
>> >>
>> >>2. builddelete
>> >>This command is run ./manage.py <build_id> and will delete the build
>> with
>> >>the specified id AND ALL related information (traversing the ForeignKey
>> >>relationships recursively) from the database.
>> >>
>> >>Alex, feel free to add anything that might be missing above.
>> >>
>> >>Since it looks like pretty much everything related to Toaster will be
>> >>documented in the wiki for 1.6, we should probably do the same with this
>> >>one too, but I might add the information to the Toaster manual in the YP
>> >>website as well.
>> >>
>> >>If you have any questions, let us know.
>> >>
>> >>Thanks!
>> >>
>> >>Belén
>> >>
>> >>
>> >>
>> >>On 18/03/2014 16:47, "Barros Pena, Belen" <belen.barros.pena at intel.com>
>> >>wrote:
>> >>
>> >>>Hi Scott,
>> >>>
>> >>>As I mentioned, we would like to document how to set up a Toaster
>> >>>instance
>> >>>in a remote host. Alex Damian sent an email to the mailing list
>> >>>explaining
>> >>>the process back in February. This is it:
>> >>>
>> >>>
>> https://lists.yoctoproject.org/pipermail/toaster/2014-February/000464.ht
>> >>>m
>> >>>l
>> >>>
>> >>>We are thinking of documenting this in the wiki for the moment, with
>> >>>maybe
>> >>>a link to it from the existing Toaster section in the Development
>> >>>Manual.
>> >>>
>> >>>Just contact any of us, or the Toaster mailing list, if you have any
>> >>>questions.
>> >>>
>> >>>Thanks for your help with this!
>> >>>
>> >>>Belén
>> >>>
>> >>
>> >>
>> >>>--
>> >>>_______________________________________________
>> >>>toaster mailing list
>> >>>toaster at yoctoproject.org
>> >>>https://lists.yoctoproject.org/listinfo/toaster
>> >>
>> >>
>> >>
>> >>
>> >>
>> >>
>> >>
>> >>
>> >>
>> >>
>> >>
>> >>
>> >
>> >
>> >
>> >
>> >
>> >
>> >
>> >
>> >
>> >
>> >
>> >
>> >
>> >
>> >
>>
>>
>
>
> --
> Alex Damian
> Yocto Project
> SSG / OTC
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.yoctoproject.org/pipermail/toaster/attachments/20140331/1aad2bd4/attachment-0001.html>