Sign upLogin

Myoldmopar/decent_ci

View on GitHub
Star
docs/Lcov.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
  Module: Lcov
  
    &mdash; Documentation by YARD 0.9.19
  
</title>

  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />

  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  pathId = "Lcov";
  relpath = '';
</script>


  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>


  </head>
  <body>
    <div class="nav_wrap">
      <iframe id="nav" src="class_list.html?1"></iframe>
      <div id="resizer"></div>
    </div>

    <div id="main" tabindex="-1">
      <div id="header">
        <div id="menu">
  
    <a href="_index.html">Index (L)</a> &raquo;
    
    
    <span class="title">Lcov</span>
  
</div>

        <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="class_list.html">

        <svg width="24" height="24">
          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
        </svg>
    </a>
  
</div>
        <div class="clear"></div>
      </div>

      <div id="content"><h1>Module: Lcov
  
  
  
</h1>
<div class="box_info">
  

  
  
  
  
  <dl>
      <dt>Includes:</dt>
      <dd><span class='object_link'><a href="Runners.html" title="Runners (module)">Runners</a></span></dd>
  </dl>
  
  

  
  <dl>
    <dt>Included in:</dt>
    <dd><span class='object_link'><a href="PotentialBuild.html" title="PotentialBuild (class)">PotentialBuild</a></span></dd>
  </dl>
  

  
  <dl>
    <dt>Defined in:</dt>
    <dd>lib/lcov.rb</dd>
  </dl>
  
</div>

<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    
<p>contains functions necessary for working with the &#39;lcov&#39; coverage generation tool</p>


  </div>
</div>
<div class="tags">
  

</div>






  
    <h2>
      Instance Method Summary
      <small><a href="#" class="summary_toggle">collapse</a></small>
    </h2>

    <ul class="summary">
      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#generate_base_command_line-instance_method" title="#generate_base_command_line (instance method)">#<strong>generate_base_command_line</strong>(compiler, build_dir)  &#x21d2; Object </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#generate_filter_command_line-instance_method" title="#generate_filter_command_line (instance method)">#<strong>generate_filter_command_line</strong>(build_dir)  &#x21d2; Object </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#generate_html_command_line-instance_method" title="#generate_html_command_line (instance method)">#<strong>generate_html_command_line</strong>(compiler, build_dir)  &#x21d2; Object </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#lcov-instance_method" title="#lcov (instance method)">#<strong>lcov</strong>(this_config, compiler, build_dir)  &#x21d2; Object </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
    </ul>
  


  
  
  
  
  
  
  
  
  <h3 class="inherited">Methods included from <span class='object_link'><a href="Runners.html" title="Runners (module)">Runners</a></span></h3>
  <p class="inherited"><span class='object_link'><a href="Runners.html#monitor_thread_state-instance_method" title="Runners#monitor_thread_state (method)">#monitor_thread_state</a></span>, <span class='object_link'><a href="Runners.html#read_state_singular-instance_method" title="Runners#read_state_singular (method)">#read_state_singular</a></span>, <span class='object_link'><a href="Runners.html#run_scripts-instance_method" title="Runners#run_scripts (method)">#run_scripts</a></span>, <span class='object_link'><a href="Runners.html#run_single_script-instance_method" title="Runners#run_single_script (method)">#run_single_script</a></span>, <span class='object_link'><a href="Runners.html#run_with_timeout-instance_method" title="Runners#run_with_timeout (method)">#run_with_timeout</a></span></p>


  <div id="instance_method_details" class="method_details_list">
    <h2>Instance Method Details</h2>

    
      <div class="method_details first">
  <h3 class="signature first" id="generate_base_command_line-instance_method">
  
    #<strong>generate_base_command_line</strong>(compiler, build_dir)  &#x21d2; <tt>Object</tt> 
  

  

  
</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


9
10
11
12</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/lcov.rb', line 9</span>

<span class='kw'>def</span> <span class='id identifier rubyid_generate_base_command_line'>generate_base_command_line</span><span class='lparen'>(</span><span class='id identifier rubyid_compiler'>compiler</span><span class='comma'>,</span> <span class='id identifier rubyid_build_dir'>build_dir</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_lcov_flags'>lcov_flags</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-c -d . -o ./lcov.output --no-external --base-directory ../</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_compiler'>compiler</span><span class='lbracket'>[</span><span class='symbol'>:coverage_base_dir</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>cd </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_build_dir'>build_dir</span><span class='embexpr_end'>}</span><span class='tstring_content'> &amp;&amp; lcov </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_lcov_flags'>lcov_flags</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="generate_filter_command_line-instance_method">
  
    #<strong>generate_filter_command_line</strong>(build_dir)  &#x21d2; <tt>Object</tt> 
  

  

  
</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


14
15
16</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/lcov.rb', line 14</span>

<span class='kw'>def</span> <span class='id identifier rubyid_generate_filter_command_line'>generate_filter_command_line</span><span class='lparen'>(</span><span class='id identifier rubyid_build_dir'>build_dir</span><span class='rparen'>)</span>
  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>cd </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_build_dir'>build_dir</span><span class='embexpr_end'>}</span><span class='tstring_content'> &amp;&amp; lcov -r ./lcov.output `pwd`/\\* -o ./lcov.output.filtered</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="generate_html_command_line-instance_method">
  
    #<strong>generate_html_command_line</strong>(compiler, build_dir)  &#x21d2; <tt>Object</tt> 
  

  

  
</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


18
19
20
21
22
23</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/lcov.rb', line 18</span>

<span class='kw'>def</span> <span class='id identifier rubyid_generate_html_command_line'>generate_html_command_line</span><span class='lparen'>(</span><span class='id identifier rubyid_compiler'>compiler</span><span class='comma'>,</span> <span class='id identifier rubyid_build_dir'>build_dir</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_pass_limit'>pass_limit</span> <span class='op'>=</span> <span class='id identifier rubyid_compiler'>compiler</span><span class='lbracket'>[</span><span class='symbol'>:coverage_pass_limit</span><span class='rbracket'>]</span>
  <span class='id identifier rubyid_warn_limit'>warn_limit</span> <span class='op'>=</span> <span class='id identifier rubyid_compiler'>compiler</span><span class='lbracket'>[</span><span class='symbol'>:coverage_warn_limit</span><span class='rbracket'>]</span>
  <span class='id identifier rubyid_gen_html_flags'>gen_html_flags</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>./lcov.output.filtered -o lcov-html --demangle-cpp --function-coverage --rc genhtml_hi_limit=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_pass_limit'>pass_limit</span><span class='embexpr_end'>}</span><span class='tstring_content'>  --rc genhtml_med_limit=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_warn_limit'>warn_limit</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>cd </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_build_dir'>build_dir</span><span class='embexpr_end'>}</span><span class='tstring_content'> &amp;&amp; genhtml </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_gen_html_flags'>gen_html_flags</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="lcov-instance_method">
  
    #<strong>lcov</strong>(this_config, compiler, build_dir)  &#x21d2; <tt>Object</tt> 
  

  

  
</h3><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


25
26
27
28
29
30</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/lcov.rb', line 25</span>

<span class='kw'>def</span> <span class='id identifier rubyid_lcov'>lcov</span><span class='lparen'>(</span><span class='id identifier rubyid_this_config'>this_config</span><span class='comma'>,</span> <span class='id identifier rubyid_compiler'>compiler</span><span class='comma'>,</span> <span class='id identifier rubyid_build_dir'>build_dir</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_run_scripts'>run_scripts</span><span class='lparen'>(</span><span class='id identifier rubyid_this_config'>this_config</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_generate_base_command_line'>generate_base_command_line</span><span class='lparen'>(</span><span class='id identifier rubyid_compiler'>compiler</span><span class='comma'>,</span> <span class='id identifier rubyid_build_dir'>build_dir</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_run_scripts'>run_scripts</span><span class='lparen'>(</span><span class='id identifier rubyid_this_config'>this_config</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_generate_filter_command_line'>generate_filter_command_line</span><span class='lparen'>(</span><span class='id identifier rubyid_build_dir'>build_dir</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_out'>out</span><span class='comma'>,</span> <span class='op'>=</span> <span class='id identifier rubyid_run_scripts'>run_scripts</span><span class='lparen'>(</span><span class='id identifier rubyid_this_config'>this_config</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_generate_html_command_line'>generate_html_command_line</span><span class='lparen'>(</span><span class='id identifier rubyid_compiler'>compiler</span><span class='comma'>,</span> <span class='id identifier rubyid_build_dir'>build_dir</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_process_lcov_results'>process_lcov_results</span><span class='lparen'>(</span><span class='id identifier rubyid_out'>out</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

</div>

      <div id="footer">
  Generated on Thu May 18 10:34:59 2023 by
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.9.19 (ruby-2.7.0).
</div>

    </div>
  </body>
</html>