doc/api/helium/target-sf-check-env.html
author Simon Howkins <simonh@symbian.org>
Thu, 10 Dec 2009 12:01:59 +0000
changeset 825 1de547e13d13
parent 627 56a1d97e7c73
permissions -rw-r--r--
Updates to make the build environment check more reasonable: Mercurial v1.3 permitted The Java compiler is not a showstopping issue 7-zip can be installed in any location Update to Helium 5 Helium can be installed in PDT 1.*, not necessarily 1.0 Raptor installation path not significant Update to Raptor 2.9.* The Raptor patch to update the bundled version of python is no longer relevant BRAG calculations updated to ignore items not being in the system path, as this just doesn't matter. Overall effect is that the build environment check should pass on a machine that is able to do a build!


<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE HTML PUBLIC "-//w3c//dtd xhtml 1.0 strict//en"
      "http://www.w3.org/tr/xhtml1/dtd/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">


<head>
    <meta name="keywords" content="helium"/>
    <meta http-equiv="content-type" content="text/html+xml; charset=iso-8859-1"/>
    <link rel="stylesheet" href="stylesheet.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:   '',
        VERSION:    '0'
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>

    <script type="text/javascript" src="../_static/interface.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    
    <title>Target sf-check-env</title>
</head>


<body>
<!-- ========= start of top navbar ======= -->
<a name="navbar_top"><!-- --></a>
<a href="#skip-navbar_top" title="skip navigation links"></a>
<table border="0" width="100%" cellpadding="1" cellspacing="0" summary="">
<tr>
<td colspan="2" bgcolor="#eeeeff" class="navbarcell1">
<a name="navbar_top_firstrow"><!-- --></a>
<table border="0" cellpadding="0" cellspacing="3" summary="">
  <tr align="center" valign="top">
  <td bgcolor="#ffffff" class="navbarcell1"> &#160;<a href="overview-summary.html"><font class="navbarfont1"><b>overview</b></font>&#160;</a></td>

  <td bgcolor="#ffffff" class="navbarcell1">    <a href="deprecated-list.html"><font class="navbarfont1"><b>deprecated</b></font></a>&#160;</td>
    
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="properties-table.html"><font class="navbarfont1"><b>properties-table</b></font></a>&#160;</td>  
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="index-1.html"><font class="navbarfont1"><b>index</b></font></a>&#160;</td>
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="help.html"><font class="navbarfont1"><b>help</b></font></a>&#160;</td>
  </tr>
</table>
</td>
<td align="right" valign="top" rowspan="3"><em>
<b>Helium API</b></em>

</td>
</tr>

<tr>
<td bgcolor="white" class="navbarcell2"><font size="-2">
&#160;prev&#160;
&#160;next</font></td>
<td bgcolor="white" class="navbarcell2"><font size="-2">
  <a href="index.html?overview-summary.html" target="_top"><b>frames</b></a>  &#160;
&#160;<a href="overview-summary.html" target="_top"><b>no frames</b></a>  &#160;

&#160;<script type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<a href="allclasses-noframe.html"><b>all classes</b></a>');
  }
  //-->
</script>
<noscript>
  <a href="allclasses-noframe.html"><b>all classes</b></a>
</noscript>


</font></td>
</tr>
</table>
<a name="skip-navbar_top"></a>
<!-- ========= end of top navbar ========= -->
    <hr/>


    
<h2>Target sf-check-env</h2>

<p><b>Location</b></p>
<p>    <tt class="docutils literal"><a href="/d:/maintools/sf-config/common/build.xml#L95">d:\maintools\sf-config\common\build.xml:95:</a></tt>  
</p>

<p><b>Conditional execution</b></p>        
<p>No conditions on target execution.</p>
<hr/>

<h3>Description</h3>
<p>
</p>
<p/>
<hr/>


<h3>Target external Dependency</h3>
<p> 
<table class="docutils" width="50%">
    <tr>
        <th class="head">Name</th>
    </tr>
        <tr>
                    <td>perl</td>
            </tr>
        <tr>
                    <td>perl</td>
            </tr>
</table>
</p>


<h3>Property dependencies</h3>


<p> 
<table class="docutils" width="50%">
    <tr>
        <th class="head">Name</th><th class="head">Edit status</th>
    </tr>
    <tr>
        <td colspan="2">User editable properties</td>
    </tr>
    <tr>
        <td colspan="2">Internal properties</td>
    </tr>
                    <tr>
                        <td><a href="property-build.log.dir.html" title="<p>This is where the build logs are stored.</p>" target="classframe"><tt class="docutils literal">build.log.dir</tt></a></td><td><a href="help.html" title="Help" target="classframe">discouraged</a></td>
                    </tr>
</table>
</p>

<hr/>


<h3>Target dependencies</h3>
<p align="center">
<img src="target-sf-check-env.dot.png" alt="sf-check-env dependencies" usemap="#dependencies"
     style="border-style: none"/>
<map name="dependencies" id="dependencies">
<area shape="rect" id="node1" href="target-sf-check-env.html" title="sf&#45;check&#45;env" alt="" coords="127,5,233,53">
<area shape="rect" id="node2" href="target-sf-prep.html" title="sf&#45;prep" alt="" coords="5,5,77,53">
</map>
</p>
<hr/>


<h3>Source code</h3>
<pre>
    &lt;target name=&quot;sf-check-env&quot;&gt;
        &lt;!-- Conditional location of BuildEnv.xml. Project always preferred to default --&gt;
        &lt;if&gt;&lt;available file=&quot;${sf.project.location}/BuildEnv.xml&quot;/&gt;        
            &lt;then&gt;
                &lt;property name=&quot;sf.buildenv.location&quot; value=&quot;${sf.project.location}&quot;/&gt;
            &lt;/then&gt;
            &lt;else&gt;
                &lt;property name=&quot;sf.buildenv.location&quot; value=&quot;${sf.common.config.dir}/tools&quot;/&gt;
            &lt;/else&gt;
        &lt;/if&gt;
        
        &lt;echo message=&quot;Build Env against ${sf.buildenv.location}/BuildEnv.xml&quot;/&gt;
        &lt;exec executable=&quot;perl&quot; dir=&quot;${sf.common.config.dir}/tools&quot; resultproperty=&quot;sf.checkenv.exit&quot;&gt;
            &lt;arg value=&quot;CheckBuildEnv.pl&quot;/&gt;
            &lt;arg value=&quot;--xml=${sf.buildenv.location}/BuildEnv.xml&quot;/&gt;
            &lt;arg value=&quot;--dbg=${build.log.dir}/BuildEnvironmentCheck.log&quot;/&gt;
            &lt;arg value=&quot;--sbs='${sf.spec.sbs.config}'&quot;/&gt;
            &lt;arg value=&quot;--tools='${sf.spec.sbs.tools.config}'&quot;/&gt;
            &lt;arg value=&quot;Common&quot;/&gt;
        &lt;/exec&gt;
        &lt;exec executable=&quot;perl&quot; failonerror=&quot;false&quot; output=&quot;${build.log.dir}/summary/BuildEnvironmentCheck_BRAG.xml&quot; logError=&quot;true&quot;&gt;
            &lt;arg value=&quot;${sf.common.config.dir}/tools/brag/logToBRAG.pl&quot;/&gt;
            &lt;arg value=&quot;--phase=Prebuild&quot;/&gt;
            &lt;arg value=&quot;--step=Build Environment Check&quot;/&gt;
            &lt;arg value=&quot;--rules=${sf.common.config.dir}/tools/brag/rules.BuildEnvironmentCheck.tsv&quot;/&gt;
            &lt;arg value=&quot;${build.log.dir}/BuildEnvironmentCheck.log&quot;/&gt;
        &lt;/exec&gt;
        &lt;fail&gt;
            &lt;condition&gt;
                &lt;not&gt;
                    &lt;or&gt;
                        &lt;equals arg1=&quot;sf.checkenv.exit&quot; arg2=&quot;0&quot;/&gt;
                        &lt;isset property=&quot;sf.suppress.buildenv.check&quot;/&gt;
                    &lt;/or&gt;
                &lt;/not&gt;
            &lt;/condition&gt;
Build Environment Check failed. To stop this failure aborting the build set property sf.suppress.buildenv.check to any value.
        &lt;/fail&gt;
    &lt;/target&gt;
</pre>


    <hr/>
<!-- ========= start of top navbar ======= -->
<a name="navbar_top"><!-- --></a>
<a href="#skip-navbar_top" title="skip navigation links"></a>
<table border="0" width="100%" cellpadding="1" cellspacing="0" summary="">
<tr>
<td colspan="2" bgcolor="#eeeeff" class="navbarcell1">
<a name="navbar_top_firstrow"><!-- --></a>
<table border="0" cellpadding="0" cellspacing="3" summary="">
  <tr align="center" valign="top">
  <td bgcolor="#ffffff" class="navbarcell1"> &#160;<a href="overview-summary.html"><font class="navbarfont1"><b>overview</b></font>&#160;</a></td>

  <td bgcolor="#ffffff" class="navbarcell1">    <a href="deprecated-list.html"><font class="navbarfont1"><b>deprecated</b></font></a>&#160;</td>
    
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="properties-table.html"><font class="navbarfont1"><b>properties-table</b></font></a>&#160;</td>  
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="index-1.html"><font class="navbarfont1"><b>index</b></font></a>&#160;</td>
  <td bgcolor="#eeeeff" class="navbarcell1">    <a href="help.html"><font class="navbarfont1"><b>help</b></font></a>&#160;</td>
  </tr>
</table>
</td>
<td align="right" valign="top" rowspan="3"><em>
<b>Helium API</b></em>

</td>
</tr>

<tr>
<td bgcolor="white" class="navbarcell2"><font size="-2">
&#160;prev&#160;
&#160;next</font></td>
<td bgcolor="white" class="navbarcell2"><font size="-2">
  <a href="index.html?overview-summary.html" target="_top"><b>frames</b></a>  &#160;
&#160;<a href="overview-summary.html" target="_top"><b>no frames</b></a>  &#160;

&#160;<script type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<a href="allclasses-noframe.html"><b>all classes</b></a>');
  }
  //-->
</script>
<noscript>
  <a href="allclasses-noframe.html"><b>all classes</b></a>
</noscript>


</font></td>
</tr>
</table>
<a name="skip-navbar_top"></a>
<!-- ========= end of top navbar ========= -->
    <font size="-2">Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: http://www.eclipse.org/legal/epl-v10.html</font>
 </body>

</html>