glfs/shareddeps/drivers/rust-bindgen.xml
Zeckmathederg a5a5f0f785 Removed all unstable notes on all packages.
Important: Added a section about stability.

Also fixed a build failure with last commit (missing ending para tag).
2024-10-18 12:39:05 -06:00

117 lines
3.0 KiB
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 rust-bindgen-download-http "https://github.com/rust-lang/rust-bindgen/archive/v&rust-bindgen-version;.tar.gz">
<!ENTITY rust-bindgen-download-ftp " ">
]>
<sect1 id="rust-bindgen" xreflabel="rust-bindgen-&rust-bindgen-version;">
<?dbhtml filename="rust-bindgen.html"?>
<title>rust-bindgen-&rust-bindgen-version;</title>
<indexterm zone="rust-bindgen">
<primary sortas="a-rust-bindgen">rust-bindgen</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to rust-bindgen</title>
<para>
Automatically generates <application>Rust</application> FFI
bindings to C (and some C++) libraries.
</para>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&rust-bindgen-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&rust-bindgen-download-ftp;"/>
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">rust-bindgen Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="llvm"/> with <application>Clang</application> and
<xref linkend="rust"/>
</para>
&build-use-internet;
</sect2>
<sect2 role="installation">
<title>Installation of rust-bindgen</title>
<para>
Install <application>rust-bindgen</application> by running the following
commands:
</para>
<screen><userinput>cargo build --release</userinput></screen>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>install -Dm755 target/release/bindgen /usr/bin/</userinput></screen>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Program</segtitle>
<segtitle>Installed Library</segtitle>
<segtitle>Installed Directory</segtitle>
<seglistitem>
<seg>
bindgen
</seg>
<seg>
none
</seg>
<seg>
none
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="bindgen">
<term><command>bindgen</command></term>
<listitem>
<para>
generates <application>Rust</application> FFI bindings to
C (and some C++) libraries
</para>
<indexterm zone="rust-bindgen bindgen">
<primary sortas="b-bindgen">bindgen</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>