source: BOOK/final-system/common/cloog.xml@ 352ed15

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;
]>

<sect1 id="ch-system-cloog" role="wrap">
  <?dbhtml filename="cloog.html"?>

  <title>CLooG-&cloog-version;</title>

  <indexterm zone="ch-system-cloog">
    <primary sortas="a-CLooG">CLooG</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>CLooG is a library to generate code for scanning Z-polyhedra.
    In other words, it finds code that reaches each integral point of one or
    more parameterized polyhedra.  GCC links with this library in order to
    enable the new loop generation code known as Graphite.</para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of CLooG</title>

    <para os="a">Prepare CLooG for compilation:</para>

<screen os="b"><userinput>CC="gcc -isystem /usr/include" \
LDFLAGS="-Wl,-rpath-link,/usr/lib:/lib" \
  ./configure --prefix=/usr --enable-shared</userinput></screen>

    <para os="c">Compile the package:</para>

<screen os="d"><userinput>make</userinput></screen>

    <important os="e">
      <para>The test suite for CLooG is considered
      critical. Do not skip it under any circumstance.</para>
    </important>

    <para os="f">Test the results:</para>

<screen os="g"><userinput>make check</userinput></screen>

    <para os="h">Install the package:</para>

<screen os="i"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 id="contents-cloog" role="content">
    <title>Contents of CLooG</title>

    <segmentedlist>
      <segtitle>Installed program</segtitle>
      <segtitle>Installed libraries</segtitle>
      <segtitle>Installed directories</segtitle>

      <seglistitem>
        <seg>cloog</seg>
        <seg>libcloog-isl.[a,so], libisl.[a,so]</seg>
        <seg>/usr/include/cloog, /usr/include/isl</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="cloog">
        <term><command>cloog</command></term>
        <listitem>
          <para>Loop generator for scanning Z-polyhedra</para>
          <indexterm zone="ch-system-cloog cloog">
            <primary sortas="b-cloog">cloog</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcloog-isl">
        <term><filename class="libraryfile">libcloog-isl</filename></term>
        <listitem>
          <para>Isl backend for CLooG.</para>
          <indexterm zone="ch-system-cloog libcloog-isl">
            <primary sortas="c-libcloog-isl">libcloog-isl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libisl">
        <term><filename class="libraryfile">libisl</filename></term>
        <listitem>
          <para>The Integer Set Library.</para>
          <indexterm zone="ch-system-cloog libisl">
            <primary sortas="c-libisl">libisl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>