os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Porter's Handbook: Document CARGO_FEATURES==--no-default-features

Browse source 
Approved by:	bcr
Differential Revision:	https://reviews.freebsd.org/D23999
This commit is contained in:
Tobias Kortkamp 2020-03-18 12:29:36 +00:00
parent c8c789f42d
commit b37b441846
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=53991
1 changed files with 37 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
View file

@ -857,7 +857,14 @@ CMAKE_OFF= VAR3</programlisting>
<entry><varname>CARGO_FEATURES</varname></entry> <entry><varname>CARGO_FEATURES</varname></entry>
<entry></entry> <entry></entry>
<entry>List of application features to build (space <entry>List of application features to build (space
separated list).</entry> separated list). To deactivate all default
features add the special token
<literal>--no-default-features</literal>
to <varname>CARGO_FEATURES</varname>. Manually
passing it to <varname>CARGO_BUILD_ARGS</varname>,
<varname>CARGO_INSTALL_ARGS</varname>, and
<varname>CARGO_TEST_ARGS</varname> is not
needed.</entry>
</row> </row>
<row> <row>
@ -1129,6 +1136,35 @@ rust/crates/atty-0.2.9.tar.gz 100% of 5898 B 81 MBps 00m00s
<programlisting>CARGO_FEATURES= json yaml</programlisting> <programlisting>CARGO_FEATURES= json yaml</programlisting>
</example> </example>
<example xml:id="cargo-ex4">
<title>Encoding Application Features As Port Options</title>
<para>An example <literal>[features]</literal> section
in <filename>Cargo.toml</filename> could look like
this:</para>
<programlisting>[features]
pulseaudio_backend = ["librespot-playback/pulseaudio-backend"]
portaudio_backend = ["librespot-playback/portaudio-backend"]
default = ["pulseaudio_backend"]</programlisting>
<para><literal>pulseaudio_backend</literal> is a default
feature. It is always enabled unless we explicitly turn
off default features by adding
<literal>--no-default-features</literal> to
<varname>CARGO_FEATURES</varname>. Here we turn the
<literal>portaudio_backend</literal>
and <literal>pulseaudio_backend</literal> features into
port options:</para>
<programlisting>CARGO_FEATURES= --no-default-features
OPTIONS_DEFINE= PORTAUDIO PULSEAUDIO
PORTAUDIO_VARS= CARGO_FEATURES+=portaudio_backend
PULSEAUDIO_VARS= CARGO_FEATURES+=pulseaudio_backend</programlisting>
</example>
<example xml:id="cargo-ex3"> <example xml:id="cargo-ex3">
<title>Listing Crate Licenses</title> <title>Listing Crate Licenses</title>