[05bcb18d] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[df09c18] | 7 | <!ENTITY cbindgen-download-http "https://github.com/eqrion/cbindgen/archive/v&cbindgen-version;/cbindgen-&cbindgen-version;.tar.gz">
|
---|
| 8 | <!ENTITY cbindgen-download-ftp " ">
|
---|
[f0f259bb] | 9 | <!ENTITY cbindgen-md5sum "939514c0ff78898a2cb737759c49ad6e">
|
---|
| 10 | <!ENTITY cbindgen-size "140 KB">
|
---|
| 11 | <!ENTITY cbindgen-buildsize "88 MB (add 515 MB for tests) ">
|
---|
| 12 | <!ENTITY cbindgen-time "0.9 SBU (Using paralleism=4; add 0.5 SBU for tests)">
|
---|
[05bcb18d] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="cbindgen" xreflabel="Cbindgen-&cbindgen-version;">
|
---|
| 16 | <?dbhtml filename="cbindgen.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Cbindgen-&cbindgen-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="cbindgen">
|
---|
| 26 | <primary sortas="a-cbindgen">cbindgen</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Cbindgen</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | <application>Cbindgen</application> can be used to generate C bindings for
|
---|
| 34 | <application>Rust</application> code.
|
---|
| 35 | </para>
|
---|
| 36 |
|
---|
[7ee3d2dc] | 37 | &lfs90_checked;
|
---|
[05bcb18d] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&cbindgen-download-http;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&cbindgen-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download MD5 sum: &cbindgen-md5sum;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download size: &cbindgen-size;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated disk space required: &cbindgen-buildsize;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated build time: &cbindgen-time;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
[df09c18] | 72 | <!--
|
---|
[05bcb18d] | 73 | <note>
|
---|
| 74 | <para>
|
---|
| 75 | The <application>cbindgen</application> source tarball shown above
|
---|
| 76 | downloads with the correct name, cbindgen-&cbindgen-version;.tar.gz,
|
---|
| 77 | if using a browser such as Firefox. If you prefer to use a command line
|
---|
| 78 | program such as wget, you normally would obtain
|
---|
| 79 | &cbindgen-version;.tar.gz. To obtain this package with the proper
|
---|
| 80 | filename, run:
|
---|
| 81 |
|
---|
| 82 | <screen><userinput>wget -c https://github.com/eqrion/cbindgen/archive/v&cbindgen-version;.tar.gz \
|
---|
| 83 | -O cbindgen-&cbindgen-version;.tar.gz</userinput></screen>.
|
---|
| 84 | </para>
|
---|
| 85 | </note>
|
---|
[df09c18] | 86 | -->
|
---|
[05bcb18d] | 87 | <bridgehead renderas="sect3">cbindgen Dependencies</bridgehead>
|
---|
| 88 |
|
---|
| 89 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 90 | <para role="required">
|
---|
| 91 | <xref linkend="rust"/>
|
---|
| 92 | </para>
|
---|
| 93 |
|
---|
| 94 | <para condition="html" role="usernotes">
|
---|
| 95 | User Notes: <ulink url="&blfs-wiki;/cbindgen"/>
|
---|
| 96 | </para>
|
---|
| 97 | </sect2>
|
---|
| 98 |
|
---|
| 99 | <sect2 role="installation">
|
---|
| 100 | <title>Installation of cbindgen</title>
|
---|
| 101 |
|
---|
| 102 | <note>
|
---|
| 103 | <para>
|
---|
| 104 | As with most <application>Rust</application> packages, this needs a
|
---|
| 105 | network connection to check the current versions of the required cargo
|
---|
| 106 | crates, and to download them if they are not already present.
|
---|
| 107 | </para>
|
---|
| 108 | </note>
|
---|
| 109 |
|
---|
| 110 | <para>
|
---|
| 111 | Install <application>cbindgen</application> by running the following
|
---|
| 112 | commands:
|
---|
| 113 | </para>
|
---|
| 114 |
|
---|
| 115 | <screen><userinput>cargo build --release</userinput></screen>
|
---|
| 116 |
|
---|
| 117 | <para>
|
---|
| 118 | To test the results, issue: <command>cargo test</command>.
|
---|
[f0f259bb] | 119 | Five tests, test_expand*, are known to fail.
|
---|
[05bcb18d] | 120 | </para>
|
---|
| 121 |
|
---|
| 122 | <para>
|
---|
| 123 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 124 | </para>
|
---|
| 125 |
|
---|
| 126 | <screen role="root"><userinput>install -Dm755 target/release/cbindgen /usr/bin/</userinput></screen>
|
---|
| 127 |
|
---|
| 128 | </sect2>
|
---|
| 129 |
|
---|
| 130 | <sect2 role="content">
|
---|
| 131 | <title>Contents</title>
|
---|
| 132 |
|
---|
| 133 | <segmentedlist>
|
---|
| 134 | <segtitle>Installed Program</segtitle>
|
---|
| 135 | <segtitle>Installed Library</segtitle>
|
---|
| 136 | <segtitle>Installed Directory</segtitle>
|
---|
| 137 |
|
---|
| 138 | <seglistitem>
|
---|
| 139 | <seg>
|
---|
| 140 | cbindgen
|
---|
| 141 | </seg>
|
---|
| 142 | <seg>
|
---|
[1575ce1] | 143 | none
|
---|
[05bcb18d] | 144 | </seg>
|
---|
| 145 | <seg>
|
---|
| 146 | none
|
---|
| 147 | </seg>
|
---|
| 148 | </seglistitem>
|
---|
| 149 | </segmentedlist>
|
---|
| 150 |
|
---|
| 151 | <variablelist>
|
---|
| 152 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 153 | <?dbfo list-presentation="list"?>
|
---|
| 154 | <?dbhtml list-presentation="table"?>
|
---|
| 155 |
|
---|
| 156 | <varlistentry id="cbindgen-prog">
|
---|
| 157 | <term><command>cbindgen</command></term>
|
---|
| 158 | <listitem>
|
---|
| 159 | <para>
|
---|
| 160 | generates C bindings for <application>Rust</application> code.
|
---|
| 161 | </para>
|
---|
| 162 | <indexterm zone="cbindgen cbindgen-prog">
|
---|
| 163 | <primary sortas="b-cbindgen">cbindgen</primary>
|
---|
| 164 | </indexterm>
|
---|
| 165 | </listitem>
|
---|
| 166 | </varlistentry>
|
---|
| 167 |
|
---|
| 168 | </variablelist>
|
---|
| 169 |
|
---|
| 170 | </sect2>
|
---|
| 171 |
|
---|
| 172 | </sect1>
|
---|