source: general/genlib/libclc.xml@ c10629e

<?xml version="1.0" encoding="UTF-8"?>
<!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;

  <!ENTITY libclc-download-http "https://github.com/llvm/llvm-project/releases/download/llvmorg-&libclc-version;/libclc-&libclc-version;.src.tar.xz">
  <!ENTITY libclc-md5sum        "0c7627f6c82bb63f712e1cc00d89eed7">
  <!ENTITY libclc-size          "124 KB">
  <!ENTITY libclc-buildsize     "380 MB">
  <!ENTITY libclc-time          "1.2 SBU (with parallelism=8)">
]>

<sect1 id="libclc" xreflabel="libclc-&libclc-version;">
  <?dbhtml filename="libclc.html"?>

  <title>libclc-&libclc-version;</title>

  <indexterm zone="libclc">
    <primary sortas="a-libclc">libclc</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libclc</title>

    <para>
      The <application>libclc</application> package contains an implementation
      of the library requirements of the OpenCL C programming language, as
      specified by the OpenCL 1.1 Specification.
    </para>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&libclc-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &libclc-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &libclc-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &libclc-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &libclc-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">libclc Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="spirv-llvm-translator"/>
    </para>

  </sect2>

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

    <para>
      Install <application>libclc</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -D CMAKE_INSTALL_PREFIX=/usr \
      -D CMAKE_BUILD_TYPE=Release  \
      -G Ninja ..                  &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>. Two tests,
      <filename>external-calls-clspv--.bc</filename> and
      <filename>external-calls-clspv64--.bc</filename>, are known to fail due
      to invalid syntax.
    </para>

    <para>
      Now, as the &root; user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/include/clc and
          /usr/share/clc
        </seg>
      </seglistitem>
    </segmentedlist>
  </sect2>
</sect1>