source: general/genlib/protobuf-c.xml

<?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 protobuf-c-download-http "https://github.com/protobuf-c/protobuf-c/releases/download/v&protobuf-c-version;/protobuf-c-&protobuf-c-version;.tar.gz">
  <!ENTITY protobuf-c-md5sum        "03030a3994b9f89ef166336048992484">
  <!ENTITY protobuf-c-size          "496 KB">
  <!ENTITY protobuf-c-buildsize     "60 MB">
  <!ENTITY protobuf-c-time          "0.6 SBU">
]>

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

  <title>Protobuf-c-&protobuf-c-version;</title>

  <indexterm zone="protobuf-c">
    <primary sortas="a-protobuf-c">Protobuf-c</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Protobuf-c</title>

    <para>
      The <application>Protobuf-c</application> package contains an
      implementation of the Google Protocol Buffers data serialization format
      in C.
    </para>

    &lfs121_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/protobuf-c-&protobuf-c-version;-consolidated_fixes-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Protobuf-c Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="protobuf"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Protobuf-c</title>

    <para>
      First, apply some upstream fixes to make this package compatible 
      with protobuf-26.1:
    </para>

    <screen role="pre"><userinput>patch -Np1 -i ../protobuf-c-&protobuf-c-version;-consolidated_fixes-1.patch</userinput></screen>

    <para>
      Install <application>Protobuf-c</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

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

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

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          protoc-gen-c and protoc-c (symlinked to protoc-gen-c)
        </seg>
        <seg>
          libprotobuf-c.so
        </seg>
        <seg>
          /usr/include/google and
          /usr/include/protobuf-c
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="protoc-c">
        <term><command>protoc-c</command></term>
        <listitem>
          <para>
            generates C descriptor code from a .proto file
          </para>
          <indexterm zone="protobuf-c protoc-c">
            <primary sortas="b-protoc-c">protoc-c</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libprotobuf-c">
        <term><filename class="libraryfile">libprotobuf-c.so</filename></term>
        <listitem>
          <para>
            contains a C implementation of the Google Protocol Buffers data
            serialization format
          </para>
          <indexterm zone="protobuf-c libprotobuf-c">
            <primary sortas="c-libprotobuf-c">libprotobuf-c.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>