| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 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 |
|
|---|
| 7 | <!ENTITY rust-download-http "https://static.rust-lang.org/dist/rustc-&rust-version;-src.tar.xz">
|
|---|
| 8 | <!ENTITY rust-download-ftp " ">
|
|---|
| 9 | <!ENTITY rust-md5sum "4f202568150660f369de3afbfb410970">
|
|---|
| 10 | <!ENTITY rust-size "207 MB">
|
|---|
| 11 | <!ENTITY rust-buildsize "8.9 GB (298 MB installed); add 6.4 GB if running the tests">
|
|---|
| 12 | <!ENTITY rust-time "6.7 SBU (including download time; add 6.2 SBU for tests, both using parallelism=8)">
|
|---|
| 13 | ]>
|
|---|
| 14 |
|
|---|
| 15 | <sect1 id="rust" xreflabel="rustc-&rust-version;">
|
|---|
| 16 | <?dbhtml filename="rust.html"?>
|
|---|
| 17 |
|
|---|
| 18 |
|
|---|
| 19 | <title>Rustc-&rust-version;</title>
|
|---|
| 20 |
|
|---|
| 21 | <indexterm zone="rust">
|
|---|
| 22 | <primary sortas="a-rust">Rust</primary>
|
|---|
| 23 | </indexterm>
|
|---|
| 24 |
|
|---|
| 25 | <sect2 role="package">
|
|---|
| 26 | <title>Introduction to Rust</title>
|
|---|
| 27 | <para>
|
|---|
| 28 | The <application>Rust</application> programming language is designed
|
|---|
| 29 | to be a safe, concurrent, practical language.
|
|---|
| 30 | </para>
|
|---|
| 31 |
|
|---|
| 32 | <para>
|
|---|
| 33 | This package is updated on a six-weekly release cycle. Because it is
|
|---|
| 34 | such a large and slow package to build, is at the moment only required
|
|---|
| 35 | by a few packages in this book, and particularly because newer versions
|
|---|
| 36 | tend to break older mozilla packages, the BLFS editors take the view that
|
|---|
| 37 | it should only be updated when that is necessary (either to fix problems,
|
|---|
| 38 | or to allow a new version of a package to build).
|
|---|
| 39 | </para>
|
|---|
| 40 |
|
|---|
| 41 | <para>
|
|---|
| 42 | As with many other programming languages, rustc (the rust compiler)
|
|---|
| 43 | needs a binary from which to bootstrap. It will download a stage0
|
|---|
| 44 | binary at the start of the build, so you cannot compile it without an
|
|---|
| 45 | Internet connection.
|
|---|
| 46 | </para>
|
|---|
| 47 |
|
|---|
| 48 | <note>
|
|---|
| 49 | <para>
|
|---|
| 50 | Although BLFS usually installs in <filename
|
|---|
| 51 | class="directory">/usr</filename>, when you later upgrade to a newer
|
|---|
| 52 | version of <application>rust</application> the old libraries in <filename
|
|---|
| 53 | class="directory">/usr/lib/rustlib</filename> will remain, with various
|
|---|
| 54 | hashes in their names, but will not be usable and will waste space. The
|
|---|
| 55 | editors recommend placing the files in the <filename
|
|---|
| 56 | class="directory">/opt</filename> directory. In particular, if you
|
|---|
| 57 | have reason to rebuild with a modified configuration (e.g. using the
|
|---|
| 58 | shipped LLVM after building with shared LLVM, perhaps to compile crates
|
|---|
| 59 | for architectures which the BLFS LLVM build does not support)
|
|---|
| 60 | it is possible for the install to leave a broken
|
|---|
| 61 | <command>cargo</command> program. In such a situation, either remove
|
|---|
| 62 | the existing installation first, or use a different prefix such as
|
|---|
| 63 | /opt/rustc-&rust-version;-build2.
|
|---|
| 64 | </para>
|
|---|
| 65 |
|
|---|
| 66 | <para>
|
|---|
| 67 | If you prefer, you can of course change the prefix to <filename
|
|---|
| 68 | class="directory">/usr</filename>.
|
|---|
| 69 | </para>
|
|---|
| 70 | </note>
|
|---|
| 71 |
|
|---|
| 72 | <para>
|
|---|
| 73 | The current <application>rustbuild</application> build-system will use
|
|---|
| 74 | all processors, although it does not scale well and often falls
|
|---|
| 75 | back to just using one core while waiting for a library to compile.
|
|---|
| 76 | However it can be mostly limited to a specified number of processors by
|
|---|
| 77 | a combination of adding the switch <literal>--jobs <N></literal>
|
|---|
| 78 | (e.g. '--jobs 4' to limit to 4 processors) on each invocation of
|
|---|
| 79 | <command>python3 x.py</command> <emphasis>and</emphasis> using an
|
|---|
| 80 | environment variable <envar>CARGO_BUILD_JOBS=<N></envar>. At the
|
|---|
| 81 | moment this is not effective when some of the rustc tests are run.
|
|---|
| 82 | </para>
|
|---|
| 83 |
|
|---|
| 84 | <para>
|
|---|
| 85 | The current version of rust's num_cpus crate now recognizes that cgroups
|
|---|
| 86 | can be used to restrict which processors it is allowed to use. So if your
|
|---|
| 87 | machine lacks DRAM (typically, less than 2 GB DRAM per core) that might be
|
|---|
| 88 | an alternative to taking CPUs offline.
|
|---|
| 89 | Read <xref linkend='build-in-cgroup'/> for how to use a cgroup.
|
|---|
| 90 | </para>
|
|---|
| 91 |
|
|---|
| 92 | <para>
|
|---|
| 93 | At the moment <application>Rust</application> does not provide any
|
|---|
| 94 | guarantees of a stable ABI.
|
|---|
| 95 | </para>
|
|---|
| 96 |
|
|---|
| 97 | <note>
|
|---|
| 98 | <para>
|
|---|
| 99 | Rustc defaults to building for ALL supported architectures, using a
|
|---|
| 100 | shipped copy of LLVM. In BLFS the build is only for the X86
|
|---|
| 101 | architecture.
|
|---|
| 102 | If you intend to develop rust crates, this build may not be good
|
|---|
| 103 | enough for your purposes.
|
|---|
| 104 | </para>
|
|---|
| 105 | <para>
|
|---|
| 106 | The build times of this version when repeated on the same machine are
|
|---|
| 107 | often reasonably consistent, but as with all compilations using
|
|---|
| 108 | <command>rustc</command> there can be some very slow outliers.
|
|---|
| 109 | </para>
|
|---|
| 110 | </note>
|
|---|
| 111 |
|
|---|
| 112 | &lfs122_checked;
|
|---|
| 113 |
|
|---|
| 114 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 115 | <itemizedlist spacing="compact">
|
|---|
| 116 | <listitem>
|
|---|
| 117 | <para>
|
|---|
| 118 | Download (HTTP): <ulink url="&rust-download-http;"/>
|
|---|
| 119 | </para>
|
|---|
| 120 | </listitem>
|
|---|
| 121 | <listitem>
|
|---|
| 122 | <para>
|
|---|
| 123 | Download (FTP): <ulink url="&rust-download-ftp;"/>
|
|---|
| 124 | </para>
|
|---|
| 125 | </listitem>
|
|---|
| 126 | <listitem>
|
|---|
| 127 | <para>
|
|---|
| 128 | Download MD5 sum: &rust-md5sum;
|
|---|
| 129 | </para>
|
|---|
| 130 | </listitem>
|
|---|
| 131 | <listitem>
|
|---|
| 132 | <para>
|
|---|
| 133 | Download size: &rust-size;
|
|---|
| 134 | </para>
|
|---|
| 135 | </listitem>
|
|---|
| 136 | <listitem>
|
|---|
| 137 | <para>
|
|---|
| 138 | Estimated disk space required: &rust-buildsize;
|
|---|
| 139 | </para>
|
|---|
| 140 | </listitem>
|
|---|
| 141 | <listitem>
|
|---|
| 142 | <para>
|
|---|
| 143 | Estimated build time: &rust-time;
|
|---|
| 144 | </para>
|
|---|
| 145 | </listitem>
|
|---|
| 146 | </itemizedlist>
|
|---|
| 147 | <!-- only keep this here for reuse in case we need a patch
|
|---|
| 148 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
|---|
| 149 | <itemizedlist spacing="compact">
|
|---|
| 150 | <listitem>
|
|---|
| 151 | <para>
|
|---|
| 152 | Optional patch (recommended if running the test suite):
|
|---|
| 153 | <ulink url="&patch-root;/rustc-&rust-version;-testsuite_fix-1.patch"/>
|
|---|
| 154 | </para>
|
|---|
| 155 | </listitem>
|
|---|
| 156 | </itemizedlist>
|
|---|
| 157 | -->
|
|---|
| 158 | <bridgehead renderas="sect3">Rust Dependencies</bridgehead>
|
|---|
| 159 |
|
|---|
| 160 | <bridgehead renderas="sect4">Required</bridgehead>
|
|---|
| 161 | <para role="required">
|
|---|
| 162 | <xref linkend="cmake"/> and
|
|---|
| 163 | <!-- Required for downloading stage 0 binaries.
|
|---|
| 164 | Otherwise it's recommended (if not installed, a vendored copy
|
|---|
| 165 | will be built). -->
|
|---|
| 166 | <xref linkend="curl"/>
|
|---|
| 167 | </para>
|
|---|
| 168 |
|
|---|
| 169 | &build-use-internet;
|
|---|
| 170 |
|
|---|
| 171 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
|---|
| 172 | <para role="recommended">
|
|---|
| 173 | <xref linkend="libssh2"/>,
|
|---|
| 174 | <xref linkend="llvm"/>
|
|---|
| 175 | (built with -D LLVM_LINK_LLVM_DYLIB=ON so that rust can link to
|
|---|
| 176 | system LLVM instead of building its shipped version), and
|
|---|
| 177 | <xref linkend="sqlite"/>
|
|---|
| 178 | </para>
|
|---|
| 179 |
|
|---|
| 180 | <note>
|
|---|
| 181 | <para>
|
|---|
| 182 | If a recommended dependency is not installed, a shipped copy in the
|
|---|
| 183 | Rustc source tarball will be built and used.
|
|---|
| 184 | </para>
|
|---|
| 185 | </note>
|
|---|
| 186 |
|
|---|
| 187 | <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 188 | <para role="optional">
|
|---|
| 189 | <xref linkend="gdb"/> (used by the test suite if it is present),
|
|---|
| 190 | <xref linkend="git"/> (required by the test suite),
|
|---|
| 191 | <ulink url="https://github.com/bytecodealliance/wasmtime/tree/main/cranelift">cranelift</ulink>,
|
|---|
| 192 | <ulink url="https://jemalloc.net/">jemalloc</ulink>,
|
|---|
| 193 | libgccjit (read command explanation in
|
|---|
| 194 | <xref role="nodep" linkend="gcc"/>), and
|
|---|
| 195 | <ulink url='https://libgit2.org/'>libgit2</ulink>
|
|---|
| 196 | </para>
|
|---|
| 197 |
|
|---|
| 198 | <para condition="html" role="usernotes">
|
|---|
| 199 | Editor Notes: <ulink url="&blfs-wiki;/rust"/>
|
|---|
| 200 | </para>
|
|---|
| 201 | </sect2>
|
|---|
| 202 |
|
|---|
| 203 | <sect2 role="installation">
|
|---|
| 204 | <title>Installation of Rust</title>
|
|---|
| 205 |
|
|---|
| 206 | <para>
|
|---|
| 207 | To install into the
|
|---|
| 208 | <filename class="directory">/opt</filename> directory, remove any
|
|---|
| 209 | existing <filename>/opt/rustc</filename> symlink
|
|---|
| 210 | and create a new directory (i.e. with a different name if trying a
|
|---|
| 211 | modified build of the same version).
|
|---|
| 212 | As the <systemitem class="username">root</systemitem>
|
|---|
| 213 | user:
|
|---|
| 214 | </para>
|
|---|
| 215 |
|
|---|
| 216 | <screen role="root"><userinput>mkdir -pv /opt/rustc-&rust-version; &&
|
|---|
| 217 | ln -svfn rustc-&rust-version; /opt/rustc</userinput></screen>
|
|---|
| 218 |
|
|---|
| 219 | <note>
|
|---|
| 220 | <para>
|
|---|
| 221 | If multiple versions of <application>Rust</application> are installed
|
|---|
| 222 | in <filename class="directory">/opt</filename>, changing to another
|
|---|
| 223 | version only requires changing the <filename> /opt/rustc</filename>
|
|---|
| 224 | symbolic link and then running <command>ldconfig</command>.
|
|---|
| 225 | </para>
|
|---|
| 226 | </note>
|
|---|
| 227 |
|
|---|
| 228 | <para>
|
|---|
| 229 | Create a suitable <filename>config.toml</filename> file which will
|
|---|
| 230 | configure the build.
|
|---|
| 231 | </para>
|
|---|
| 232 |
|
|---|
| 233 | <screen><userinput>cat << EOF > config.toml
|
|---|
| 234 | <literal># see config.toml.example for more possible options
|
|---|
| 235 | # See the 8.4 book for an old example using shipped LLVM
|
|---|
| 236 | # e.g. if not installing clang, or using a version before 13.0
|
|---|
| 237 |
|
|---|
| 238 | # Tell x.py the editors have reviewed the content of this file
|
|---|
| 239 | # and updated it to follow the major changes of the building system,
|
|---|
| 240 | # so x.py will not warn us to do such a review.
|
|---|
| 241 | change-id = 127866
|
|---|
| 242 |
|
|---|
| 243 | [llvm]
|
|---|
| 244 | # by default, rust will build for a myriad of architectures
|
|---|
| 245 | targets = "X86"
|
|---|
| 246 |
|
|---|
| 247 | # When using system llvm prefer shared libraries
|
|---|
| 248 | link-shared = true
|
|---|
| 249 |
|
|---|
| 250 | [build]
|
|---|
| 251 | # omit docs to save time and space (default is to build them)
|
|---|
| 252 | docs = false
|
|---|
| 253 |
|
|---|
| 254 | # install extended tools: cargo, clippy, etc
|
|---|
| 255 | extended = true
|
|---|
| 256 |
|
|---|
| 257 | # Do not query new versions of dependencies online.
|
|---|
| 258 | locked-deps = true
|
|---|
| 259 |
|
|---|
| 260 | # Specify which extended tools (those from the default install).
|
|---|
| 261 | tools = ["cargo", "clippy", "rustdoc", "rustfmt"]
|
|---|
| 262 |
|
|---|
| 263 | # Use the source code shipped in the tarball for the dependencies.
|
|---|
| 264 | # The combination of this and the "locked-deps" entry avoids downloading
|
|---|
| 265 | # many crates from Internet, and makes the Rustc build more stable.
|
|---|
| 266 | vendor = true
|
|---|
| 267 |
|
|---|
| 268 | [install]
|
|---|
| 269 | prefix = "/opt/rustc-&rust-version;"
|
|---|
| 270 | docdir = "share/doc/rustc-&rust-version;"
|
|---|
| 271 |
|
|---|
| 272 | [rust]
|
|---|
| 273 | channel = "stable"
|
|---|
| 274 | description = "for BLFS &version;"
|
|---|
| 275 |
|
|---|
| 276 | # Enable the same optimizations as the official upstream build.
|
|---|
| 277 | lto = "thin"
|
|---|
| 278 | codegen-units = 1
|
|---|
| 279 |
|
|---|
| 280 | [target.x86_64-unknown-linux-gnu]
|
|---|
| 281 | # NB the output of llvm-config (i.e. help options) may be
|
|---|
| 282 | # dumped to the screen when config.toml is parsed.
|
|---|
| 283 | llvm-config = "/usr/bin/llvm-config"
|
|---|
| 284 |
|
|---|
| 285 | [target.i686-unknown-linux-gnu]
|
|---|
| 286 | # NB the output of llvm-config (i.e. help options) may be
|
|---|
| 287 | # dumped to the screen when config.toml is parsed.
|
|---|
| 288 | llvm-config = "/usr/bin/llvm-config"</literal>
|
|---|
| 289 | EOF</userinput></screen>
|
|---|
| 290 | <!-- It seems gone in 1.81.0 but not confirmed upstream
|
|---|
| 291 | <note>
|
|---|
| 292 | <para>
|
|---|
| 293 | The <command>python3 x.py</command> commands may output a warning
|
|---|
| 294 | message complaining <computeroutput>no codegen-backends
|
|---|
| 295 | config matched the requested path to build a codegen
|
|---|
| 296 | backend</computeroutput>. And the provided
|
|---|
| 297 | <quote>suggestion</quote> (<computeroutput>add backend to
|
|---|
| 298 | codegen-backends in config.toml</computeroutput>) will not silence
|
|---|
| 299 | it. This warning is <ulink
|
|---|
| 300 | url='https://github.com/rust-lang/rust/issues/110692'>bogus</ulink>
|
|---|
| 301 | and it should be ignored.
|
|---|
| 302 | </para>
|
|---|
| 303 | </note>
|
|---|
| 304 | -->
|
|---|
| 305 | <!-- https://github.com/rust-lang/rust/issues/128493
|
|---|
| 306 | https://github.com/rust-lang/rust/issues/130018
|
|---|
| 307 | https://github.com/rust-lang/rust/pull/130034 -->
|
|---|
| 308 | <para>
|
|---|
| 309 | Now remove some tests triggering a full rebuild of the Rust standard
|
|---|
| 310 | library and compiler, remove a special case for supporting the
|
|---|
| 311 | <command>cargo</command> test suite (that we don't run because it's
|
|---|
| 312 | expected to be running in a Rustc git repository) but triggering a rebuild
|
|---|
| 313 | of <command>cargo</command> when running
|
|---|
| 314 | <command>python3 x.py install</command>, and prevent building one
|
|---|
| 315 | component useless for BLFS:
|
|---|
| 316 | </para>
|
|---|
| 317 |
|
|---|
| 318 | <screen><userinput>sed '/MirOpt/d' -i src/bootstrap/src/core/builder.rs &&
|
|---|
| 319 |
|
|---|
| 320 | sed 's/!path.ends_with("cargo")/true/' \
|
|---|
| 321 | -i src/bootstrap/src/core/build_steps/tool.rs &&
|
|---|
| 322 |
|
|---|
| 323 | sed 's/^.*build_wasm.*$/#[allow(unreachable_code)]&return false;/' \
|
|---|
| 324 | -i src/bootstrap/src/lib.rs</userinput></screen>
|
|---|
| 325 |
|
|---|
| 326 | <para>
|
|---|
| 327 | Compile <application>Rust</application> by running the following
|
|---|
| 328 | commands:
|
|---|
| 329 | </para>
|
|---|
| 330 |
|
|---|
| 331 | <!-- fixed in 1.58.0, retain as a reminder that fixed crates can be used
|
|---|
| 332 | <screen><userinput>sed -i -e '/^curl /s/0.4.38/0.4.40/' \
|
|---|
| 333 | -e '/^curl-sys /s/0.4.48/0.4.50/' \
|
|---|
| 334 | src/tools/cargo/Cargo.toml && -->
|
|---|
| 335 |
|
|---|
| 336 | <screen><userinput>[ ! -e /usr/include/libssh2.h ] || export LIBSSH2_SYS_USE_PKG_CONFIG=1
|
|---|
| 337 | [ ! -e /usr/include/sqlite3.h ] || export LIBSQLITE3_SYS_USE_PKG_CONFIG=1
|
|---|
| 338 | python3 x.py build</userinput></screen>
|
|---|
| 339 |
|
|---|
| 340 | <note>
|
|---|
| 341 | <para>
|
|---|
| 342 | The test suite will generate some messages in the
|
|---|
| 343 | <phrase revision="sysv">system log</phrase>
|
|---|
| 344 | <phrase revision="systemd">systemd journal</phrase>
|
|---|
| 345 | for traps on invalid opcodes, and for segmentation faults.
|
|---|
| 346 | In themselves these are nothing to worry about, just a way for the
|
|---|
| 347 | test to be terminated.
|
|---|
| 348 | </para>
|
|---|
| 349 | </note>
|
|---|
| 350 |
|
|---|
| 351 | <para>
|
|---|
| 352 | To run the tests (again using all available CPUs) issue:
|
|---|
| 353 | </para>
|
|---|
| 354 |
|
|---|
| 355 | <screen remap="test"><userinput>python3 x.py test --verbose --no-fail-fast | tee rustc-testlog</userinput></screen>
|
|---|
| 356 |
|
|---|
| 357 | <para>
|
|---|
| 358 | Four tests in the
|
|---|
| 359 | <filename class='directory'>tests/run-make</filename> directory are
|
|---|
| 360 | known to fail because they need targets not enabled
|
|---|
| 361 | in the BLFS <xref linkend='llvm'/> configuration (nor the
|
|---|
| 362 | <literal>llvm.targets</literal> in <filename>config.toml</filename>,
|
|---|
| 363 | in case building with the shipped LLVM). And, one test named
|
|---|
| 364 | <literal>core::config::tests::download_ci_llvm</literal> is known to
|
|---|
| 365 | fail.
|
|---|
| 366 | </para>
|
|---|
| 367 |
|
|---|
| 368 | <!-- Let's just comment this out. Nobody has tested on a system w/o
|
|---|
| 369 | FileCheck for a long time.
|
|---|
| 370 | <para>
|
|---|
| 371 | If <command>FileCheck</command> from <application>LLVM</application> has
|
|---|
| 372 | not been installed, all 47 tests from the <quote>assembly</quote> suite
|
|---|
| 373 | will fail.
|
|---|
| 374 | </para>
|
|---|
| 375 | -->
|
|---|
| 376 | <para>
|
|---|
| 377 | As with all large test suites, some tests might fail on some machines -
|
|---|
| 378 | if the number of additional failures is low,
|
|---|
| 379 | check the log for 'failures:' and review lines above that, particularly the
|
|---|
| 380 | 'stderr:' lines. Any mention of
|
|---|
| 381 | SIGSEGV or signal 11 in a failing test is a cause for concern.
|
|---|
| 382 | </para>
|
|---|
| 383 |
|
|---|
| 384 | <para>
|
|---|
| 385 | If you get any <emphasis>other</emphasis> failing test which reports an
|
|---|
| 386 | issue number then you should search for that issue. For example, when
|
|---|
| 387 | rustc >= 1.41.1 was built with a version of sysllvm before 10.0 the test
|
|---|
| 388 | for issue 69225 failed <ulink
|
|---|
| 389 | url="https://github.com/rust-lang/rust/issues/69225"/> and that should be
|
|---|
| 390 | regarded as a critical failure (they released 1.41.1 because of it).
|
|---|
| 391 | Most other failures will not be critical.
|
|---|
| 392 | </para>
|
|---|
| 393 |
|
|---|
| 394 | <para>
|
|---|
| 395 | Therefore, you should determine the number of failures.
|
|---|
| 396 | The number of tests which passed and failed can be found by running:
|
|---|
| 397 | </para>
|
|---|
| 398 |
|
|---|
| 399 | <!-- split into two lines for narrower screen windows -->
|
|---|
| 400 | <screen remap="test"><userinput>grep '^test result:' rustc-testlog |
|
|---|
| 401 | awk '{sum1 += $4; sum2 += $6} END { print sum1 " passed; " sum2 " failed" }'</userinput></screen>
|
|---|
| 402 |
|
|---|
| 403 | <para>
|
|---|
| 404 | The other available fields are $8 for those which were ignored
|
|---|
| 405 | (i.e. skipped), $10 for 'measured' and $12 for 'filtered out' but both
|
|---|
| 406 | those last two are probably zero.
|
|---|
| 407 | </para>
|
|---|
| 408 |
|
|---|
| 409 | <para>
|
|---|
| 410 | Now, as the &root; user, install the package:
|
|---|
| 411 | </para>
|
|---|
| 412 |
|
|---|
| 413 | <note>
|
|---|
| 414 | <para>
|
|---|
| 415 | If <command>sudo</command> or <command>su</command> is invoked for
|
|---|
| 416 | switching to the &root; user, ensure
|
|---|
| 417 | <envar>LIBSSH2_SYS_USE_PKG_CONFIG</envar> and
|
|---|
| 418 | <envar>LIBSQLITE3_SYS_USE_PKG_CONFIG</envar> are correctly passed or
|
|---|
| 419 | the following command may rebuild <command>cargo</command> with
|
|---|
| 420 | shipped copies of libssh2 and sqlite. For <command>sudo</command>,
|
|---|
| 421 | use the
|
|---|
| 422 | <option>--preserve-env=LIB{SSH2,SQLITE3}_SYS_USE_PKG_CONFIG</option>
|
|---|
| 423 | option. For <command>su</command>, do <emphasis>not</emphasis> use
|
|---|
| 424 | the <option>-</option> or <option>--login</option> options.
|
|---|
| 425 | </para>
|
|---|
| 426 | </note>
|
|---|
| 427 |
|
|---|
| 428 | <screen role='root'><userinput>python3 x.py install rustc std &&
|
|---|
| 429 | python3 x.py install --stage=1 cargo clippy rustfmt</userinput></screen>
|
|---|
| 430 |
|
|---|
| 431 | <para>
|
|---|
| 432 | Still as the &root; user, fix the installation of documentation,
|
|---|
| 433 | symlink a <application>Zsh</application>
|
|---|
| 434 | completion file into the correct location, and move a
|
|---|
| 435 | <application>Bash</application> completion file into the location
|
|---|
| 436 | recommended by the <application>Bash</application> completion
|
|---|
| 437 | maintainers:
|
|---|
| 438 | </para>
|
|---|
| 439 |
|
|---|
| 440 | <screen role='root'><userinput>rm -fv /opt/rustc-&rust-version;/share/doc/rustc-&rust-version;/*.old &&
|
|---|
| 441 | install -vm644 README.md \
|
|---|
| 442 | /opt/rustc-&rust-version;/share/doc/rustc-&rust-version; &&
|
|---|
| 443 |
|
|---|
| 444 | install -vdm755 /usr/share/zsh/site-functions &&
|
|---|
| 445 | ln -sfv /opt/rustc/share/zsh/site-functions/_cargo \
|
|---|
| 446 | /usr/share/zsh/site-functions
|
|---|
| 447 |
|
|---|
| 448 | mv -v /etc/bash_completion.d/cargo /usr/share/bash-completion/completions</userinput></screen>
|
|---|
| 449 |
|
|---|
| 450 | <para>
|
|---|
| 451 | Finally, unset the exported environment variables:
|
|---|
| 452 | </para>
|
|---|
| 453 |
|
|---|
| 454 | <screen><userinput>unset LIB{SSH2,SQLITE3}_SYS_USE_PKG_CONFIG</userinput></screen>
|
|---|
| 455 |
|
|---|
| 456 | </sect2>
|
|---|
| 457 |
|
|---|
| 458 | <sect2 role="commands">
|
|---|
| 459 | <title>Command Explanations</title>
|
|---|
| 460 |
|
|---|
| 461 | <para>
|
|---|
| 462 | <command>ln -svfn rustc-&rust-version; /opt/rustc</command>: if this is
|
|---|
| 463 | not the first use of the <filename class="directory">/opt/rustc</filename>
|
|---|
| 464 | symlink, overwrite it by forcing, and use the '-n' flag to avoid getting
|
|---|
| 465 | confusing results from e.g. <command>ls -l</command>.
|
|---|
| 466 | </para>
|
|---|
| 467 |
|
|---|
| 468 | <para>
|
|---|
| 469 | <literal>targets = "X86"</literal>: this avoids building all the available
|
|---|
| 470 | linux cross-compilers (AArch64, MIPS, PowerPC, SystemZ, etc). Unfortunately,
|
|---|
| 471 | rust insists on installing source files for these below
|
|---|
| 472 | <filename class="directory">/opt/rustc/lib/src</filename>.
|
|---|
| 473 | </para>
|
|---|
| 474 |
|
|---|
| 475 | <para>
|
|---|
| 476 | <literal>extended = true</literal>: this installs several tools
|
|---|
| 477 | (specified by the <literal>tools</literal> entry) alongside
|
|---|
| 478 | <command>rustc</command>.
|
|---|
| 479 | </para>
|
|---|
| 480 |
|
|---|
| 481 | <para>
|
|---|
| 482 | <literal>tools = ["cargo", "clippy", "rustdoc", "rustfmt"]</literal>:
|
|---|
| 483 | only build the tools from the 'default' profile in binary command
|
|---|
| 484 | <command>rustup</command> which are recommended for most users.
|
|---|
| 485 | The other tools are unlikely to be useful unless using (old) code
|
|---|
| 486 | analyzers or editing the standard library.
|
|---|
| 487 | </para>
|
|---|
| 488 |
|
|---|
| 489 | <para>
|
|---|
| 490 | <literal>channel = "stable"</literal>: this ensures only stable features
|
|---|
| 491 | can be used, the default in <filename>config.toml</filename> is to use
|
|---|
| 492 | development features, which is not appropriate for a released version.
|
|---|
| 493 | </para>
|
|---|
| 494 |
|
|---|
| 495 | <!-- comment while using shipped LLVM -->
|
|---|
| 496 | <para>
|
|---|
| 497 | <literal>[target.x86_64-unknown-linux-gnu]</literal>: the syntax of
|
|---|
| 498 | <filename>config.toml</filename> requires an <literal>llvm-config</literal>
|
|---|
| 499 | entry for each target for which system-llvm is to be used. Change the target
|
|---|
| 500 | to <literal>[target.i686-unknown-linux-gnu]</literal> if you are building
|
|---|
| 501 | on 32-bit x86. This whole section may be omitted if you wish to build
|
|---|
| 502 | against the shipped llvm, or do not have clang, but the resulting build will
|
|---|
| 503 | be larger and take longer.
|
|---|
| 504 | </para>
|
|---|
| 505 |
|
|---|
| 506 | <!--<para>
|
|---|
| 507 | <command>sed -i -e '/^curl /s/0.4.38/0.4.40/' ... </command>: two crates
|
|---|
| 508 | normally downloaded for this release do not correctly initialise
|
|---|
| 509 | <application>curl</application> if using
|
|---|
| 510 | <application>openssl-3.0.0</application>. Upstream has fixed that for a
|
|---|
| 511 | future release, this sed causes the fixed versions to be used.
|
|---|
| 512 | </para>-->
|
|---|
| 513 |
|
|---|
| 514 | <!-- https://github.com/alexcrichton/ssh2-rs/issues/173 -->
|
|---|
| 515 | <para>
|
|---|
| 516 | <command>export LIBSSH2_SYS_USE_PKG_CONFIG=1</command>: Allow
|
|---|
| 517 | <command>cargo</command> to link to system libssh2.
|
|---|
| 518 | </para>
|
|---|
| 519 |
|
|---|
| 520 | <!-- src/tools/cargo/Cargo.toml is specifying "bundled" as the
|
|---|
| 521 | upstream is suggesting to avoid issues building for Windoge.
|
|---|
| 522 | We don't care about Windoge so override this if we have
|
|---|
| 523 | system sqlite3. -->
|
|---|
| 524 | <para>
|
|---|
| 525 | <command>export LIBSQLITE3_SYS_USE_PKG_CONFIG=1</command>: Allow
|
|---|
| 526 | <command>cargo</command> to link to system sqlite.
|
|---|
| 527 | </para>
|
|---|
| 528 |
|
|---|
| 529 | <!--<para>
|
|---|
| 530 | <command>export RUSTFLAGS="$RUSTFLAGS -C link-args=-lffi"</command>:
|
|---|
| 531 | This adds a link to libffi to any RUSTFLAGS you may already be passing
|
|---|
| 532 | to the build. On some systems, linking fails to include libffi unless
|
|---|
| 533 | this is used. The reason why this is needed is not clear.
|
|---|
| 534 | 2023-01-14 : assumed to be no longer needed, but it is some years
|
|---|
| 535 | since one person reported needing this, keep it commented for the moment.
|
|---|
| 536 | </para>-->
|
|---|
| 537 |
|
|---|
| 538 | <para>
|
|---|
| 539 | <parameter>--verbose</parameter>: this switch can sometimes provide more
|
|---|
| 540 | information about a test which fails.
|
|---|
| 541 | </para>
|
|---|
| 542 |
|
|---|
| 543 | <para>
|
|---|
| 544 | <parameter>--no-fail-fast</parameter>: this switch ensures that the test suite
|
|---|
| 545 | will not stop at the first error.
|
|---|
| 546 | </para>
|
|---|
| 547 |
|
|---|
| 548 | <!-- https://github.com/rust-lang/rust/issues/94147 -->
|
|---|
| 549 | <para>
|
|---|
| 550 | <parameter>--stage=1</parameter>: this switch works around an issue
|
|---|
| 551 | causing some Rustc components unnecessarily rebuilt running
|
|---|
| 552 | <command>python3 x.py install</command>.
|
|---|
| 553 | </para>
|
|---|
| 554 |
|
|---|
| 555 | </sect2>
|
|---|
| 556 |
|
|---|
| 557 | <sect2 role="configuration">
|
|---|
| 558 | <title>Configuring Rust</title>
|
|---|
| 559 |
|
|---|
| 560 | <sect3 id="rustc-config">
|
|---|
| 561 | <title>Configuration Information</title>
|
|---|
| 562 |
|
|---|
| 563 | <para>
|
|---|
| 564 | If you installed <application>rustc</application> in
|
|---|
| 565 | <filename class="directory">/opt</filename>, you need to update the
|
|---|
| 566 | following configuration files so that <application>rustc</application>
|
|---|
| 567 | is correctly found by other packages and system processes.
|
|---|
| 568 | </para>
|
|---|
| 569 |
|
|---|
| 570 | <para>
|
|---|
| 571 | As the <systemitem class="username">root</systemitem> user, create
|
|---|
| 572 | the <filename>/etc/profile.d/rustc.sh</filename> file:
|
|---|
| 573 | </para>
|
|---|
| 574 |
|
|---|
| 575 | <screen role="root"><userinput>cat > /etc/profile.d/rustc.sh << "EOF"
|
|---|
| 576 | <literal># Begin /etc/profile.d/rustc.sh
|
|---|
| 577 |
|
|---|
| 578 | pathprepend /opt/rustc/bin PATH
|
|---|
| 579 |
|
|---|
| 580 | # End /etc/profile.d/rustc.sh</literal>
|
|---|
| 581 | EOF</userinput></screen>
|
|---|
| 582 |
|
|---|
| 583 | <para>
|
|---|
| 584 | Immediately after installation, update the current PATH
|
|---|
| 585 | for your current shell as a normal user:
|
|---|
| 586 | </para>
|
|---|
| 587 |
|
|---|
| 588 | <screen><userinput>source /etc/profile.d/rustc.sh</userinput></screen>
|
|---|
| 589 |
|
|---|
| 590 | </sect3>
|
|---|
| 591 | </sect2>
|
|---|
| 592 |
|
|---|
| 593 |
|
|---|
| 594 | <sect2 role="content">
|
|---|
| 595 | <title>Contents</title>
|
|---|
| 596 |
|
|---|
| 597 | <segmentedlist>
|
|---|
| 598 | <segtitle>Installed Programs</segtitle>
|
|---|
| 599 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 600 | <segtitle>Installed Directories</segtitle>
|
|---|
| 601 |
|
|---|
| 602 | <seglistitem>
|
|---|
| 603 | <seg>
|
|---|
| 604 | cargo-clippy, cargo-fmt, cargo, clippy-driver, rust-gdb,
|
|---|
| 605 | rust-gdbgui, rust-lldb, rustc, rustdoc, and rustfmt
|
|---|
| 606 | </seg>
|
|---|
| 607 | <seg>
|
|---|
| 608 | librustc-driver-<16-byte-hash>.so,
|
|---|
| 609 | libstd-<16-byte-hash>.so, and
|
|---|
| 610 | libtest-<16-byte-hash>.so
|
|---|
| 611 | </seg>
|
|---|
| 612 | <seg>
|
|---|
| 613 | ~/.cargo,
|
|---|
| 614 | /opt/rustc, symbolic link to
|
|---|
| 615 | /opt/rustc-&rust-version;
|
|---|
| 616 | </seg>
|
|---|
| 617 | </seglistitem>
|
|---|
| 618 | </segmentedlist>
|
|---|
| 619 |
|
|---|
| 620 | <variablelist>
|
|---|
| 621 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 622 | <?dbfo list-presentation="list"?>
|
|---|
| 623 | <?dbhtml list-presentation="table"?>
|
|---|
| 624 |
|
|---|
| 625 | <varlistentry id="cargo-clippy">
|
|---|
| 626 | <term><command>cargo-clippy</command></term>
|
|---|
| 627 | <listitem>
|
|---|
| 628 | <para>
|
|---|
| 629 | provides lint checks for a cargo package
|
|---|
| 630 | </para>
|
|---|
| 631 | <indexterm zone="rust cargo-clippy">
|
|---|
| 632 | <primary sortas="b-cargo-clippy">cargo-clippy</primary>
|
|---|
| 633 | </indexterm>
|
|---|
| 634 | </listitem>
|
|---|
| 635 | </varlistentry>
|
|---|
| 636 |
|
|---|
| 637 | <varlistentry id="cargo-fmt">
|
|---|
| 638 | <term><command>cargo-fmt</command></term>
|
|---|
| 639 | <listitem>
|
|---|
| 640 | <para>
|
|---|
| 641 | formats all bin and lib files of the current crate using
|
|---|
| 642 | rustfmt
|
|---|
| 643 | </para>
|
|---|
| 644 | <indexterm zone="rust cargo-fmt">
|
|---|
| 645 | <primary sortas="b-cargo-fmt">cargo-fmt</primary>
|
|---|
| 646 | </indexterm>
|
|---|
| 647 | </listitem>
|
|---|
| 648 | </varlistentry>
|
|---|
| 649 |
|
|---|
| 650 | <!-- <varlistentry id="cargo-miri">
|
|---|
| 651 | <term><command>cargo-miri</command></term>
|
|---|
| 652 | <listitem>
|
|---|
| 653 | <para>
|
|---|
| 654 | is for use by Miri to interpret bin crates and tests. It is
|
|---|
| 655 | not installed by default.
|
|---|
| 656 | </para>
|
|---|
| 657 | <indexterm zone="rust cargo-miri">
|
|---|
| 658 | <primary sortas="b-cargo-miri">cargo-miri</primary>
|
|---|
| 659 | </indexterm>
|
|---|
| 660 | </listitem>
|
|---|
| 661 | </varlistentry>-->
|
|---|
| 662 |
|
|---|
| 663 | <varlistentry id="cargo">
|
|---|
| 664 | <term><command>cargo</command></term>
|
|---|
| 665 | <listitem>
|
|---|
| 666 | <para>
|
|---|
| 667 | is the Package Manager for Rust
|
|---|
| 668 | </para>
|
|---|
| 669 | <indexterm zone="rust cargo">
|
|---|
| 670 | <primary sortas="b-cargo">cargo</primary>
|
|---|
| 671 | </indexterm>
|
|---|
| 672 | </listitem>
|
|---|
| 673 | </varlistentry>
|
|---|
| 674 |
|
|---|
| 675 | <varlistentry id="clippy-driver">
|
|---|
| 676 | <term><command>clippy-driver</command></term>
|
|---|
| 677 | <listitem>
|
|---|
| 678 | <para>
|
|---|
| 679 | provides lint checks for Rust
|
|---|
| 680 | </para>
|
|---|
| 681 | <indexterm zone="rust clippy-driver">
|
|---|
| 682 | <primary sortas="b-clippy-driver">clippy-driver</primary>
|
|---|
| 683 | </indexterm>
|
|---|
| 684 | </listitem>
|
|---|
| 685 | </varlistentry>
|
|---|
| 686 |
|
|---|
| 687 | <!-- <varlistentry id="miri">
|
|---|
| 688 | <term><command>miri</command></term>
|
|---|
| 689 | <listitem>
|
|---|
| 690 | <para>
|
|---|
| 691 | is an interpreter for Rust's mid-level intermediate representation
|
|---|
| 692 | (MIR). It is not installed by default.
|
|---|
| 693 | </para>
|
|---|
| 694 | <indexterm zone="rust miri">
|
|---|
| 695 | <primary sortas="b-miri">miri</primary>
|
|---|
| 696 | </indexterm>
|
|---|
| 697 | </listitem>
|
|---|
| 698 | </varlistentry>
|
|---|
| 699 |
|
|---|
| 700 | <varlistentry id="rls">
|
|---|
| 701 | <term><command>rls</command></term>
|
|---|
| 702 | <listitem>
|
|---|
| 703 | <para>
|
|---|
| 704 | is the Rust Language Server. This can run in the background to
|
|---|
| 705 | provide IDEs, editors, and other tools with information about Rust
|
|---|
| 706 | programs
|
|---|
| 707 | </para>
|
|---|
| 708 | <indexterm zone="rust rls">
|
|---|
| 709 | <primary sortas="b-rls">rls</primary>
|
|---|
| 710 | </indexterm>
|
|---|
| 711 | </listitem>
|
|---|
| 712 | </varlistentry>
|
|---|
| 713 |
|
|---|
| 714 | <varlistentry id="rust-analyzer">
|
|---|
| 715 | <term><command>rust-analyzer</command></term>
|
|---|
| 716 | <listitem>
|
|---|
| 717 | <para>
|
|---|
| 718 | is an implementation of Language Server Protocol for the Rust
|
|---|
| 719 | programming language.
|
|---|
| 720 | </para>
|
|---|
| 721 | <indexterm zone="rust rust-analyzer">
|
|---|
| 722 | <primary sortas="b-rust-analyzer">rust-analyzer</primary>
|
|---|
| 723 | </indexterm>
|
|---|
| 724 | </listitem>
|
|---|
| 725 | </varlistentry>
|
|---|
| 726 |
|
|---|
| 727 | <varlistentry id="rust-demangler">
|
|---|
| 728 | <term><command>rust-demangler</command></term>
|
|---|
| 729 | <listitem>
|
|---|
| 730 | <para>
|
|---|
| 731 | converts a list of Rust mangled symbols into a
|
|---|
| 732 | corresponding list of demangled symbols
|
|---|
| 733 | </para>
|
|---|
| 734 | <indexterm zone="rust rust-demangler">
|
|---|
| 735 | <primary sortas="b-rust-demangler">rust-demangler</primary>
|
|---|
| 736 | </indexterm>
|
|---|
| 737 | </listitem>
|
|---|
| 738 | </varlistentry> -->
|
|---|
| 739 |
|
|---|
| 740 | <varlistentry id="rust-gdb">
|
|---|
| 741 | <term><command>rust-gdb</command></term>
|
|---|
| 742 | <listitem>
|
|---|
| 743 | <para>
|
|---|
| 744 | is a wrapper script for gdb, pulling in Python pretty-printing
|
|---|
| 745 | modules installed in
|
|---|
| 746 | <filename class="directory">/opt/rustc-&rust-version;/lib/rustlib/etc</filename>
|
|---|
| 747 | </para>
|
|---|
| 748 | <indexterm zone="rust rust-gdb">
|
|---|
| 749 | <primary sortas="b-rust-gdb">rust-gdb</primary>
|
|---|
| 750 | </indexterm>
|
|---|
| 751 | </listitem>
|
|---|
| 752 | </varlistentry>
|
|---|
| 753 |
|
|---|
| 754 | <varlistentry id="rust-gdbgui">
|
|---|
| 755 | <term><command>rust-gdbgui</command></term>
|
|---|
| 756 | <listitem>
|
|---|
| 757 | <para>
|
|---|
| 758 | is a wrapper script for a graphical front end to gdb that runs in a
|
|---|
| 759 | browser
|
|---|
| 760 | </para>
|
|---|
| 761 | <indexterm zone="rust rust-gdbgui">
|
|---|
| 762 | <primary sortas="b-rust-gdbgui">rust-gdbgui</primary>
|
|---|
| 763 | </indexterm>
|
|---|
| 764 | </listitem>
|
|---|
| 765 | </varlistentry>
|
|---|
| 766 |
|
|---|
| 767 | <varlistentry id="rust-lldb">
|
|---|
| 768 | <term><command>rust-lldb</command></term>
|
|---|
| 769 | <listitem>
|
|---|
| 770 | <para>
|
|---|
| 771 | is a wrapper script for LLDB (the LLVM debugger)
|
|---|
| 772 | pulling in the Python pretty-printing modules
|
|---|
| 773 | </para>
|
|---|
| 774 | <indexterm zone="rust rust-lldb">
|
|---|
| 775 | <primary sortas="b-rust-lldb">rust=lldb</primary>
|
|---|
| 776 | </indexterm>
|
|---|
| 777 | </listitem>
|
|---|
| 778 | </varlistentry>
|
|---|
| 779 |
|
|---|
| 780 | <varlistentry id="rustc">
|
|---|
| 781 | <term><command>rustc</command></term>
|
|---|
| 782 | <listitem>
|
|---|
| 783 | <para>
|
|---|
| 784 | is the rust compiler
|
|---|
| 785 | </para>
|
|---|
| 786 | <indexterm zone="rust rustc">
|
|---|
| 787 | <primary sortas="b-rustc">rustc</primary>
|
|---|
| 788 | </indexterm>
|
|---|
| 789 | </listitem>
|
|---|
| 790 | </varlistentry>
|
|---|
| 791 |
|
|---|
| 792 | <varlistentry id="rustdoc">
|
|---|
| 793 | <term><command>rustdoc</command></term>
|
|---|
| 794 | <listitem>
|
|---|
| 795 | <para>
|
|---|
| 796 | generates documentation from rust source code
|
|---|
| 797 | </para>
|
|---|
| 798 | <indexterm zone="rust rustdoc">
|
|---|
| 799 | <primary sortas="b-rustdoc">rustdoc</primary>
|
|---|
| 800 | </indexterm>
|
|---|
| 801 | </listitem>
|
|---|
| 802 | </varlistentry>
|
|---|
| 803 |
|
|---|
| 804 | <varlistentry id="rustfmt">
|
|---|
| 805 | <term><command>rustfmt</command></term>
|
|---|
| 806 | <listitem>
|
|---|
| 807 | <para>
|
|---|
| 808 | formats rust code
|
|---|
| 809 | </para>
|
|---|
| 810 | <indexterm zone="rust rustfmt">
|
|---|
| 811 | <primary sortas="b-rustfmt">rustfmt</primary>
|
|---|
| 812 | </indexterm>
|
|---|
| 813 | </listitem>
|
|---|
| 814 | </varlistentry>
|
|---|
| 815 |
|
|---|
| 816 | <varlistentry id="libstd">
|
|---|
| 817 | <term><filename class="libraryfile">libstd-<16-byte-hash>.so</filename></term>
|
|---|
| 818 | <listitem>
|
|---|
| 819 | <para>
|
|---|
| 820 | is the Rust Standard Library, the foundation of portable Rust software
|
|---|
| 821 | </para>
|
|---|
| 822 | <indexterm zone="rust libstd">
|
|---|
| 823 | <primary sortas="c-libstd">libstd-<16-byte-hash>.so</primary>
|
|---|
| 824 | </indexterm>
|
|---|
| 825 | </listitem>
|
|---|
| 826 | </varlistentry>
|
|---|
| 827 | </variablelist>
|
|---|
| 828 | </sect2>
|
|---|
| 829 |
|
|---|
| 830 | </sect1>
|
|---|
