camlspotter.bitbucket.org / omy / OMyExternal.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>OMyExternal &mdash; OMyMakefile v1.0.0 documentation</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '#',
        VERSION:     '1.0.0',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="OMyMakefile v1.0.0 documentation" href="index.html" />
    <link rel="next" title="OMyMakefile" href="OMyMakefile.html" />
    <link rel="prev" title="General usage of OMy" href="GeneralUsage.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="OMyMakefile.html" title="OMyMakefile"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="GeneralUsage.html" title="General usage of OMy"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">OMyMakefile v1.0.0 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="omyexternal">
<h1>OMyExternal<a class="headerlink" href="#omyexternal" title="Permalink to this headline"></a></h1>
<p>Functions to integrate non-OMake projects</p>
<div class="section" id="downloading">
<h2>Downloading<a class="headerlink" href="#downloading" title="Permalink to this headline"></a></h2>
<p id="index-0"><strong>WGet(url, dir)</strong></p>
<blockquote>
Run wget and retrieve $(url) to $(dir)
If the file is already downloaded, does nothing.</blockquote>
</div>
<div class="section" id="files">
<h2>Files<a class="headerlink" href="#files" title="Permalink to this headline"></a></h2>
<p id="index-1"><strong>Files(dir)</strong></p>
<blockquote>
List up files in directory $(dir), without the prefix &#8220;$(dir)/&#8221;</blockquote>
<p id="index-2"><strong>OCamlModulesFromPath(files)</strong></p>
<blockquote>
<p>Get the OCaml module paths from OCaml object and interface file names: x.cmo, y.cmx =&gt; x, y</p>
<p>CR : Defined but not useful</p>
</blockquote>
</div>
<div class="section" id="functions-for-external-projects">
<h2>Functions for <cite>External</cite> projects<a class="headerlink" href="#functions-for-external-projects" title="Permalink to this headline"></a></h2>
<div class="section" id="general-rule-for-commands">
<h3>General rule for commands<a class="headerlink" href="#general-rule-for-commands" title="Permalink to this headline"></a></h3>
<p id="index-3"><strong>OCamlExternal(PACK)</strong></p>
<blockquote>
<p>Add a rule to install non-omake project.</p>
<blockquote>
<dl class="docutils">
<dt>Argument</dt>
<dd><dl class="first last docutils">
<dt>PACK (mandatory)</dt>
<dd>Name of the package. Once installed, <tt class="docutils literal"><span class="pre">Installed($(PACK))</span></tt> is created.</dd>
</dl>
</dd>
<dt>Environments</dt>
<dd><dl class="first last docutils">
<dt>URL (optional)</dt>
<dd>URL of the source</dd>
<dt>REQUIRED_PACKS (mandatory)</dt>
<dd>List of install mark files of required package: ex. REQUIRED_PACKS=$(Installed type-conv)</dd>
<dt>CONFIGURE (optional)</dt>
<dd>Configure command: ex. (cd $(EXTRACT_DIR); ./configure &#8211;prefix $PREFIX)
Command is executed at the directory where the function is called.</dd>
<dt>INSTALL (mandatory)</dt>
<dd>Install command: ex. (cd $(EXTRACT_DIR); make all install).
Command is executed at the directory where the function is called.</dd>
<dt>OBJS (optional?)</dt>
<dd>The list of files installed</dd>
</dl>
</dd>
</dl>
</blockquote>
<p>CR jfuruse: this is pretty buggy</p>
</blockquote>
<p id="index-4"><strong>OCamlExternalPack(PACK)</strong></p>
<blockquote>
<p>Add a rule to install non-omake OCaml package.</p>
<blockquote>
<dl class="docutils">
<dt>Argument</dt>
<dd><dl class="first last docutils">
<dt>PACK (mandatory)</dt>
<dd>Name of the package. Once installed, <tt class="docutils literal"><span class="pre">Installed($(PACK))</span></tt> is created.</dd>
</dl>
</dd>
<dt>Environments</dt>
<dd><dl class="first last docutils">
<dt>URL (optional)</dt>
<dd>URL of the source</dd>
<dt>REQUIRED_PACKS (mandatory)</dt>
<dd>List of install mark files of required package: ex. REQUIRED_PACKS=$(Installed type-conv)</dd>
<dt>CONFIGURE (optional)</dt>
<dd>Configure command: ex. (cd $(EXTRACT_DIR); ./configure &#8211;prefix $PREFIX)
Command is executed at the directory where the function is called.</dd>
<dt>INSTALL (mandatory)</dt>
<dd>Install command: ex. (cd $(EXTRACT_DIR); ocamlfind install ...).
Command is executed at the directory where the function is called.
<tt class="docutils literal"><span class="pre">ocamlfind</span> <span class="pre">remove</span> <span class="pre">$(PACK)</span></tt> is automatically done before the installation.</dd>
<dt>OBJS (pretty optional?)</dt>
<dd>The list of files installed</dd>
</dl>
</dd>
</dl>
</blockquote>
<p>CR jfuruse: this is pretty buggy</p>
</blockquote>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h3><a href="index.html">Table Of Contents</a></h3>
            <ul>
<li><a class="reference external" href="#">OMyExternal</a><ul>
<li><a class="reference external" href="#downloading">Downloading</a></li>
<li><a class="reference external" href="#files">Files</a></li>
<li><a class="reference external" href="#functions-for-external-projects">Functions for <cite>External</cite> projects</a><ul>
<li><a class="reference external" href="#general-rule-for-commands">General rule for commands</a></li>
</ul>
</li>
</ul>
</li>
</ul>

            <h4>Previous topic</h4>
            <p class="topless"><a href="GeneralUsage.html"
                                  title="previous chapter">General usage of OMy</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="OMyMakefile.html"
                                  title="next chapter">OMyMakefile</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="_sources/OMyExternal.txt"
                     rel="nofollow">Show Source</a></li>
            </ul>
          <div id="searchbox" style="display: none">
            <h3>Quick search</h3>
              <form class="search" action="search.html" method="get">
                <input type="text" name="q" size="18" />
                <input type="submit" value="Go" />
                <input type="hidden" name="check_keywords" value="yes" />
                <input type="hidden" name="area" value="default" />
              </form>
              <p class="searchtip" style="font-size: 90%">
              Enter search terms or a module, class or function name.
              </p>
          </div>
          <script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="OMyMakefile.html" title="OMyMakefile"
             >next</a> |</li>
        <li class="right" >
          <a href="GeneralUsage.html" title="General usage of OMy"
             >previous</a> |</li>
        <li><a href="index.html">OMyMakefile v1.0.0 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2011, Jun FURUSE.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.4.
    </div>
  </body>
</html>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.