--- a/buildframework/helium/doc/src/manual/debugging.rst Thu Mar 04 15:10:37 2010 +0200
+++ b/buildframework/helium/doc/src/manual/debugging.rst Tue Apr 27 08:33:08 2010 +0300
@@ -1,3 +1,23 @@
+.. ============================================================================
+ Name : debugging.rst
+ Part of : Helium
+
+ Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+ All rights reserved.
+ This component and the accompanying materials are made available
+ under the terms of the License "Eclipse Public License v1.0"
+ which accompanies this distribution, and is available
+ at the URL "http://www.eclipse.org/legal/epl-v10.html".
+
+ Initial Contributors:
+ Nokia Corporation - initial contribution.
+
+ Contributors:
+
+ Description:
+
+ ============================================================================
+
.. index::
module: Debugging
@@ -26,10 +46,7 @@
Output Logs
-----------
-When running Helium there are a large number of output logs created to assist with debugging and determining what has been performed and what has not.
-All of the log files are generated in the build area, usually under the ``output\logs`` folder. Many of the logs are created in different formats
-e.g. the Bill Of Materials log file exists as .html, .xml and .txt (all the same information). Some of the logs exist as different file formats giving
-different information at various stages of the activity, e.g. the cenrep logs in which case generally the .html files are a summary of the whole activity.
+When running Helium there are a large number of output logs created to assist with debugging and determining what has been performed and what has not. All of the log files are generated in the build area, usually under the ``output\logs`` folder. Many of the logs are created in different formats, e.g. the Bill Of Materials log file exists as .html, .xml and .txt (all the same information). Some of the logs exist as different file formats giving different information at various stages of the activity, e.g. the cenrep logs in which case generally the .html files are a summary of the whole activity.
For mc product builds the following log files are created
where xx is the name of the build + build id e.g. 12.030_ant_env.log
where nn is the variant number(s):
@@ -47,10 +64,10 @@
"hlm_listener.log", "Helium debug log", "Helium debug log for internal data [Helium runtime information] and it can be found inside HELIUM_CACHE_DIR folder"
"hlm_debug.log", "Helium debug log", "Helium debug log for all other debug log (all java logs) and it can be found inside HELIUM_CACHE_DIR folder"
-Targets and their log
-;;;;;;;;;;;;;;;;;;;;;
+Targets and their logs
+;;;;;;;;;;;;;;;;;;;;;;
-.. image:: ../images/dependencies_log.grph.png
+.. image:: dependencies_log.grph.png
.. index::
single: Troubleshooting
@@ -59,13 +76,10 @@
Troubleshooting - Helium
------------------------
-Use the ``diagnostics`` command provide debugging information when reporting problems. It lists all the environment variables and all the ANT
-properties and all the ANT targets within Helium
-so you might find it useful to pipe it to a log file so that you can read all of the output at your leisure.
+Use the :hlm-t:`diagnostics` command provide debugging information when reporting problems. It lists all the environment variables and all the Ant
+properties and all the Ant targets within Helium so you might find it useful to pipe it to a log file so that you can read all of the output at your leisure::
-To run the diagnostics command type in a command window where the hlm.bat file is:
-
-hlm diagnostics > diag.log
+ hlm diagnostics > diag.log
.. index::
single: Failing early in the build
@@ -73,7 +87,7 @@
Failing early in the build
;;;;;;;;;;;;;;;;;;;;;;;;;;;
-The ``failonerror`` property is defined in ``helium.ant.xml`` and has the default value ``false``. It is used to control whether the <exec>
+The :hlm-p:`failonerror` property is defined in ``helium.ant.xml`` and has the default value ``false``. It is used to control whether the ``<exec>``
tasks fail when errors occur or the build execution just continues. The build can be configured to "fail fast" if this is set to ``true``,
either on the command line or in a build configuration before importing ``helium.ant.xml``. Given that many ``exec`` tasks will return an
error code due to build errors, it is not recommended to set this to true for regular builds.