doc/build/html/commands/clean.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5
   6 <html xmlns="http://www.w3.org/1999/xhtml">
   7   <head>
   8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   9
  10     <title>Command clean &mdash; salomeTools 5.0.0dev documentation</title>
  11
  12     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
  13     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  14     <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
  15
  16     <script type="text/javascript">
  17       var DOCUMENTATION_OPTIONS = {
  18         URL_ROOT:    '../',
  19         VERSION:     '5.0.0dev',
  20         COLLAPSE_INDEX: false,
  21         FILE_SUFFIX: '.html',
  22         HAS_SOURCE:  true
  23       };
  24     </script>
  25     <script type="text/javascript" src="../_static/jquery.js"></script>
  26     <script type="text/javascript" src="../_static/underscore.js"></script>
  27     <script type="text/javascript" src="../_static/doctools.js"></script>
  28     <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  29     <link rel="top" title="salomeTools 5.0.0dev documentation" href="../index.html" />
  30     <link rel="next" title="Command package" href="package.html" />
  31     <link rel="prev" title="Command environ" href="environ.html" />
  32
  33   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  34
  35
  36   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  37
  38   </head>
  39   <body>
  40
  41
  42     <div class="document">
  43       <div class="documentwrapper">
  44         <div class="bodywrapper">
  45           <div class="body" role="main">
  46
  47   <div class="section" id="command-clean">
  48 <h1>Command clean<a class="headerlink" href="#command-clean" title="Permalink to this headline">¶</a></h1>
  49 <div class="section" id="description">
  50 <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
  51 <p>The <strong>clean</strong> command removes products in the <em>source, build, or install</em> directories of an application. Theses directories are usually named <tt class="docutils literal"><span class="pre">SOURCES,</span> <span class="pre">BUILD,</span> <span class="pre">INSTALL</span></tt>.</p>
  52 <p>Use the options to define what directories you want to suppress and to set the list of products</p>
  53 </div>
  54 <div class="section" id="usage">
  55 <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
  56 <ul>
  57 <li><p class="first">Clean all previously created <em>build</em> and <em>install</em> directories (example application as <em>SALOME_xx</em>):</p>
  58 <div class="highlight-bash"><div class="highlight"><pre><span class="c"># take care, is long time to restore, sometimes</span>
  59 sat clean SALOME-xx --build --install
  60 </pre></div>
  61 </div>
  62 </li>
  63 <li><p class="first">Clean previously created <em>build</em> and <em>install</em> directories, only for products with property <em>is_salome_module</em>:</p>
  64 <div class="highlight-bash"><div class="highlight"><pre>sat clean SALOME-xxx --build --install <span class="se">\</span>
  65                      --properties is_salome_module:yes
  66 </pre></div>
  67 </div>
  68 </li>
  69 </ul>
  70 </div>
  71 <div class="section" id="availables-options">
  72 <h2>Availables options<a class="headerlink" href="#availables-options" title="Permalink to this headline">¶</a></h2>
  73 <blockquote>
  74 <div><ul>
  75 <li><p class="first"><strong>--products</strong> : Products to clean.</p>
  76 </li>
  77 <li><p class="first"><strong>--properties</strong> :</p>
  78 <div class="line-block">
  79 <div class="line">Filter the products by their properties.</div>
  80 <div class="line">Syntax: <em>--properties &lt;property&gt;:&lt;value&gt;</em></div>
  81 </div>
  82 </li>
  83 <li><p class="first"><strong>--sources</strong> : Clean the product source directories.</p>
  84 </li>
  85 <li><p class="first"><strong>--build</strong> : Clean the product build directories.</p>
  86 </li>
  87 <li><p class="first"><strong>--install</strong> : Clean the product install directories.</p>
  88 </li>
  89 <li><p class="first"><strong>--all</strong> : Clean the product source, build and install directories.</p>
  90 </li>
  91 <li><p class="first"><strong>--sources_without_dev</strong> :</p>
  92 <div class="line-block">
  93 <div class="line">Do not clean the products in development mode,</div>
  94 <div class="line">(they could have <a class="reference external" href="https://en.wikipedia.org/wiki/Version_control">VCS</a> commits pending).</div>
  95 </div>
  96 </li>
  97 </ul>
  98 </div></blockquote>
  99 </div>
 100 <div class="section" id="some-useful-configuration-pathes">
 101 <h2>Some useful configuration pathes<a class="headerlink" href="#some-useful-configuration-pathes" title="Permalink to this headline">¶</a></h2>
 102 <p>No specific configuration.</p>
 103 </div>
 104 </div>
 105
 106
 107           </div>
 108         </div>
 109       </div>
 110       <div class="sphinxsidebar">
 111         <div class="sphinxsidebarwrapper">
 112             <p class="logo"><a href="../index.html">
 113               <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
 114             </a></p>
 115   <h3><a href="../index.html">Table Of Contents</a></h3>
 116   <ul>
 117 <li><a class="reference internal" href="#">Command clean</a><ul>
 118 <li><a class="reference internal" href="#description">Description</a></li>
 119 <li><a class="reference internal" href="#usage">Usage</a></li>
 120 <li><a class="reference internal" href="#availables-options">Availables options</a></li>
 121 <li><a class="reference internal" href="#some-useful-configuration-pathes">Some useful configuration pathes</a></li>
 122 </ul>
 123 </li>
 124 </ul>
 125 <div class="relations">
 126 <h3>Related Topics</h3>
 127 <ul>
 128   <li><a href="../index.html">Documentation overview</a><ul>
 129       <li>Previous: <a href="environ.html" title="previous chapter">Command environ</a></li>
 130       <li>Next: <a href="package.html" title="next chapter">Command package</a></li>
 131   </ul></li>
 132 </ul>
 133 </div>
 134   <h3>This Page</h3>
 135   <ul class="this-page-menu">
 136     <li><a href="../_sources/commands/clean.txt"
 137            rel="nofollow">Show Source</a></li>
 138   </ul>
 139 <div id="searchbox" style="display: none">
 140   <h3>Quick search</h3>
 141     <form class="search" action="../search.html" method="get">
 142       <input type="text" name="q" />
 143       <input type="submit" value="Go" />
 144       <input type="hidden" name="check_keywords" value="yes" />
 145       <input type="hidden" name="area" value="default" />
 146     </form>
 147     <p class="searchtip" style="font-size: 90%">
 148     Enter search terms or a module, class or function name.
 149     </p>
 150 </div>
 151 <script type="text/javascript">$('#searchbox').show(0);</script>
 152         </div>
 153       </div>
 154       <div class="clearer"></div>
 155     </div>
 156     <div class="footer">
 157       &copy;2018, CEA.
 158
 159       |
 160       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
 161       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
 162
 163       |
 164       <a href="../_sources/commands/clean.txt"
 165           rel="nofollow">Page source</a>
 166     </div>
 167
 168
 169
 170
 171   </body>
 172 </html>