Add more details to the descriptiion of what this package does.

Correct capitalizatiom throughout, and tweak English idiom.
This commit is contained in:
David Bryant 2022-12-07 11:10:58 -06:00
parent 8f10e6fa49
commit e9c46b31c7

View File

@ -26,6 +26,11 @@
<para>The Libffi library provides a portable, high level programming <para>The Libffi library provides a portable, high level programming
interface to various calling conventions. This allows a programmer to call interface to various calling conventions. This allows a programmer to call
any function specified by a call interface description at run time.</para> any function specified by a call interface description at run time.</para>
<para>FFI stands for Foreign Function Interface. An FFI allows a program written
in one language to call a program written in another language. Specifically,
Libffi can provide a bridge between an interpreter like Perl, or Python, and
shared library subroutines written in C, or C++.</para>
<segmentedlist> <segmentedlist>
<segtitle>&buildtime;</segtitle> <segtitle>&buildtime;</segtitle>
@ -43,7 +48,7 @@
<title>Installation of Libffi</title> <title>Installation of Libffi</title>
<note> <note>
<para>Similar to GMP, libffi builds with optimizations specific <para>Like GMP, Libffi builds with optimizations specific
to the processor in use. If building for another system, change the to the processor in use. If building for another system, change the
value of the <parameter>--with-gcc-arch=</parameter> parameter in the value of the <parameter>--with-gcc-arch=</parameter> parameter in the
following command to an architecture name fully implemented by the following command to an architecture name fully implemented by the
@ -52,7 +57,7 @@
Illegal Operation Errors.</para> Illegal Operation Errors.</para>
</note> </note>
<para>Prepare libffi for compilation:</para> <para>Prepare Libffi for compilation:</para>
<screen><userinput remap="configure">./configure --prefix=/usr \ <screen><userinput remap="configure">./configure --prefix=/usr \
--disable-static \ --disable-static \
@ -67,7 +72,7 @@
<listitem> <listitem>
<para>Ensure GCC optimizes for the current system. If this <para>Ensure GCC optimizes for the current system. If this
is not specified, the system is guessed and the code generated is not specified, the system is guessed and the code generated
may not be correct for some systems. If the generated code may not be correct. If the generated code
will be copied from the native system to a less capable will be copied from the native system to a less capable
system, use the less capable system as a parameter. For details system, use the less capable system as a parameter. For details
about alternative system types, see <ulink about alternative system types, see <ulink
@ -80,8 +85,8 @@
<!-- To editors: try to remove it once GJS fixed (at GNOME 43) --> <!-- To editors: try to remove it once GJS fixed (at GNOME 43) -->
<term><parameter>--disable-exec-static-tramp</parameter></term> <term><parameter>--disable-exec-static-tramp</parameter></term>
<listitem> <listitem>
<para>Disable static trampoline support. It's a new security <para>Disable static trampoline support, a new security
feature in libffi, but some BLFS packages (notably feature in Libffi. Some BLFS packages (notably
<application>GJS</application>) have not been adapted for it.</para> <application>GJS</application>) have not been adapted for it.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -121,7 +126,7 @@
<varlistentry id="libffi"> <varlistentry id="libffi">
<term><filename class="libraryfile">libffi</filename></term> <term><filename class="libraryfile">libffi</filename></term>
<listitem> <listitem>
<para>contains the foreign function interface API functions</para> <para>Contains the foreign function interface API functions</para>
<indexterm zone="ch-system-libffi"> <indexterm zone="ch-system-libffi">
<primary sortas="c-libffi">libffi</primary> <primary sortas="c-libffi">libffi</primary>
</indexterm> </indexterm>