From b44a9ab990defa6a30d363f80a9e5ad4de594896 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 22 Jul 2013 20:39:54 +0300 Subject: dev-manual: First draft of webhob section Fixes [YOCTO #4730] First draft of the section documenting the webhob service. (From yocto-docs rev: 4d995519cd4e481445a5399f936fce682d330dfe) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 169 +++++++++++++++++++++ 1 file changed, 169 insertions(+) (limited to 'documentation/dev-manual/dev-manual-common-tasks.xml') diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index f4df9062f0..f060cc86ee 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -4319,6 +4319,175 @@ +
+ Examining Builds using Webhob + + + WebHob is a Web-based interface to the OpenEmbedded build system, + which uses BitBake. + WebHob offers features to record and analyze BitBake runs applied + to a specific target. + Using Webhob, you can do the following: + + Understand why a task fails or was + reused from the shared state cache when you thought it + should have been rebuilt from scratch. + See what is built (recipes and + packages) and what packages were installed into the final + image. + See performance-related information such + as size, build time, CPU usage, disk input, and disk + output. + + + + + This release of the WebHob service provides you with information + about a BitBake run. + The tool does not allow you to configure and launch a build. + Future development includes plans to integrate the data examination + features of WebHob with the configuration and build launching + capabilities of + Hob. + + For more information on using Hob to build an image, + see the + "Image Development Using Hob" + section. + + +
+ Starting WebHob + + + Getting set up to use WebHob and start it is simple. + First, be sure you have met the following requirements: + + You have set up your + Source Directory. + See the + Yocto Project Release + item for information on how to set up the Source + Directory. + Be sure your build machine has + Django + version 1.4 or greater installed. + + + + + Once you have met the requirements, follow these steps to + start WebHob running in the background of your shell: + + Set up your build environment by sourcing + the oe-init-build-env script. + + Edit your local.conf + configuration file as needed. + Start the WebHob service using this + command from within your build directory: + + $ source webhob start + + + + + + When WebHob starts, it creates some additional files in your + Build Directory. + Deleting these files will cause you to lose data or interrupt + WebHob: + + webhob.sqlite: + WebHob's database file. + whbmain.log: + WebHob's log file. + whbmain.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. + + +
+ +
+ Using WebHob + + + Once WebHob is running, it logs information for any BitBake + run from your Build Directory. + This logging is automatic. + All you need to do is access and use the information. + + + + You access the information one of two ways: + + Open a Browser and type enter in the + http://localhost:8000 URL. + + Use the xdg-open + tool from the shell and pass it the same URL. + + + Either method opens the home page for the WebHob interface. + +
+ +
+ Examining WebHob Data + + + The WebHob database is persistent regardless of whether you + start or stop the service. + The home page of the interface into the database organizes + builds into areas: + + Recent successful builds, which appear + in row format in a green area. + Recent failed builds, which appear + in row format in a red area. + Recent builds in progress, which appear + in row format in a yellow area. + All builds, which appear in row format at + the end of the page. + + + + + Each entry is linked to more detail on the particular build + or recipe. + You can click on the links to learn more information. + + + + When you click on a failed recipe link, you can find out + information such as the work directory, the pathname to the + failing recipe, the exact error message, and precursor tasks. + + + + Clicking on a successful build provides you with configuration, + task, and package information along with directory structure, + build time, CPU usage, and disk I/O information. + +
+ +
+ Stopping WebHob + + + Stop the WebHob service with the following command: + + $ source webhob stop + + The service stops but the WebHob database remains persistent. + +
+
+
Profiling with OProfile -- cgit v1.2.3-54-g00ecf