Bug 4730

Accepted.

Do we have any basic information on Web Hob in written form?  I would like to see what we have and begin formulating a plan for this bug. 

Thanks, 
Scott

I think everything we have is in the wiki:

https://wiki.yoctoproject.org/wiki/Web_Hob

Any questions, let me know.

Belen

(In reply to comment #2)
> Do we have any basic information on Web Hob in written form?  I would like
> to see what we have and begin formulating a plan for this bug. 
> 
> Thanks, 
> Scott

Here is a first draft of the section for the webhob service.  For now, the name I used throughout is "WebHob."  Hopefully that will change before the release.  

http://www.yoctoproject.org/docs/1.5/dev-manual/dev-manual.html#examining-builds-using-webhob

Please review this.  Consider our goals as agreed on in this bug for initially documenting this piece in the manual set.  We want to introduce this thing, give some benefits, tell how to start and stop it, and describe what the user sees a bit.

Thanks,
Scott

I updated the section to use the name "Toaster."  I also made some assumptions on the file names.  I hope we can change them to the following and not leave the webhob name laying around for the user:

    toaster.sqlite: Toaster's database file.

    tstmain.log: Toaster's log file.

    tstmain.pid: Contains the PID of the web server.

    dsi.pid: Contains the PID of th bridge.

    bitbake-cookerdaemon.log: The BitBake server's log file.

Please review the section and provide feedback here in the bug's comments.

http://www.yoctoproject.org/docs/1.5/dev-manual/dev-manual.html#examining-builds-using-toaster

Scott

Belen's comments:

SECTION 5.17

"Understand why a task fails or was reused from the shared state cache when you thought it should have been rebuilt from scratch."

I provided this specific case as an example, but I think we need to turn it into something more generic, like: "See information about the tasks executed and reused during the build"

"See performance-related information such as size, build time, CPU usage, disk input, and disk output."

I am not sure we should include size on this list. For disk input and disk output, we provide a single measure (Disk I/O). It's probably kind of a standard term that people should understand.

To this section, we should probably add that we show errors, warnings and traces to aid debugging, or something like that.

SECTION 5.17.1

Should we include a note about the fact that Toaster needs to be started before building, otherwise data collection will not happen? Or would that be overkill? I just think we really need to get that message across, particularly since building is a time consuming process, so you'll probably be quite disappointed if after waiting for the build to complete you realise Toast wasn't running so you have no data. 

SECTION 5.17.3. 

Can we leave out any specifics about the interface? It might still change. I agree a generic overview of the interface capabilities is a good idea, but again I would keep it high level. Something like: "Toaster will show you a list of builds for which it has data. Click on any of them to see build information, which includes configuration details, information about tasks, all recipes and packages built and their dependencies, packages installed in your final image, execution time, CPU usage and disk I/O per task."

And that's all from my side. I'll let the tech people review the rest.

Thanks for putting this together!

Belen

Applied Belen's review comments.  I have received no additional feedback on the section. 

Here is the link for the latest version:

http://www.yoctoproject.org/docs/1.5/dev-manual/dev-manual.html#examining-builds-using-webhob

Scott

Thanks, Scott. It looks good to me, but someone from the dev team should review the content.  

By the way, the anchor tag #examining-builds-using-webhob in no longer working. This one

http://www.yoctoproject.org/docs/1.5/dev-manual/dev-manual.html#examining-builds-using-toaster

works like a charm though :)

Belen

(In reply to comment #7)
> Applied Belen's review comments.  I have received no additional feedback on
> the section. 
> 
> Here is the link for the latest version:
> 
> http://www.yoctoproject.org/docs/1.5/dev-manual/dev-manual.html#examining-
> builds-using-webhob
> 
> Scott

Belen, 

Thanks for pointing out the anchor tag.  I evidently changed that in the file but lazily cut-and-pasted the link from an earlier comment in Bugzilla :)

Alexandru.damian is the only other person on the CC list besides you, Saul, and myself.

Scott


http://www.yoctoproject.org/docs/1.5/dev-manual/dev-manual.html#examining-builds-using-toaster

Hi Scott,

We have had to review our deliverables for the 1.5 release, and it looks like the web user interface will not make it into this release. We'll be delivering the web API instead.

We probably need to review the Toaster section you have created to exclude any references to the user interface.

Sorry about the extra work :(

Belén

Hi, 

I have adjusted our "Toaster" section to exclude the Web Interface information since it will not be part of 1.5.  I am leaving the section in the XML source of the chapter, however, but commented out for future use.  The new section basically introduces the API by highlighting how it works and its capabilities.  I leverage off the existing Wiki page where the REST API is fully documented.

Here is the section.  Please comment.

http://www.yoctoproject.org/docs/1.5/dev-manual/dev-manual.html#examining-builds-using-toaster

Thanks, 
Scott

(In reply to comment #11)
> Hi, 
> 
> I have adjusted our "Toaster" section to exclude the Web Interface
> information since it will not be part of 1.5.  I am leaving the section in
> the XML source of the chapter, however, but commented out for future use. 
> The new section basically introduces the API by highlighting how it works
> and its capabilities.  I leverage off the existing Wiki page where the REST
> API is fully documented.
> 
> Here is the section.  Please comment.
> 
> http://www.yoctoproject.org/docs/1.5/dev-manual/dev-manual.html#examining-
> builds-using-toaster

Thanks for getting this ready, Scott. It looks good to me. 

Alex, Paul: it would be good if you cast an eye over this. It should only take a minute (the section is very short).

Belén

> 
> Thanks, 
> Scott

Seems fine to me, thank you :).

I am marking this RESOLVED.  Thanks everyone.

Scott

Verified.