Auto merge of #43989 - circuitfox:sliceext-binary-search-sig, r=alexcrichton

[rust.git] / config.toml.example

diff --git a/config.toml.example b/config.toml.example
index 962be2e608501659cfafe2e0a7d559e1a0c1263a..266f4250132135a78593035e6abd7546c5950550 100644 (file)
--- a/config.toml.example
+++ b/config.toml.example
@@ -73,6 +73,10 @@
 # controlled by rustbuild's -j parameter.
 #link-jobs = 0
 
+# When invoking `llvm-config` this configures whether the `--shared` argument is
+# passed to prefer linking to shared libraries.
+#link-shared = false
+
 # =============================================================================
 # General build configuration options
 # =============================================================================
@@ -142,10 +146,10 @@
 # option to true.
 #full-bootstrap = false
 
-# Enable a build of the and extended rust tool set which is not only the
-# compiler but also tools such as Cargo. This will also produce "combined
-# installers" which are used to install Rust and Cargo together. This is
-# disabled by default.
+# Enable a build of the extended rust tool set which is not only the compiler
+# but also tools such as Cargo. This will also produce "combined installers"
+# which are used to install Rust and Cargo together. This is disabled by
+# default.
 #extended = false
 
 # Verbosity level: 0 == not verbose, 1 == verbose, 2 == very verbose
@@ -166,6 +170,15 @@
 # to +10 on Unix platforms, and by using a "low priority" job object on Windows.
 #low-priority = false
 
+# Arguments passed to the `./configure` script, used during distcheck. You
+# probably won't fill this in but rather it's filled in by the `./configure`
+# script.
+#configure-args = []
+
+# Indicates that a local rebuild is occurring instead of a full bootstrap,
+# essentially skipping stage0 as the local compiler is recompiling itself again.
+#local-rebuild = false
+
 # =============================================================================
 # General install configuration options
 # =============================================================================
@@ -195,6 +208,13 @@
 # =============================================================================
 [rust]
 
+# Indicates that the build should be optimized for debugging Rust. Note that
+# this is typically not what you want as it takes an incredibly large amount of
+# time to have a debug-mode rustc compile any code (notably libstd). If this
+# value is set to `true` it will affect a number of configuration options below
+# as well, if unconfigured.
+#debug = false
+
 # Whether or not to optimize the compiler and standard library
 # Note: the slowness of the non optimized compiler compiling itself usually
 #       outweighs the time gains in not doing optimizations, therefore a
@@ -249,6 +269,10 @@
 # desired in distributions, for example.
 #rpath = true
 
+# Suppresses extraneous output from tests to ensure the output of the test
+# harness is relatively clean.
+#quiet-tests = false
+
 # Flag indicating whether tests are compiled with optimizations (the -O flag) or
 # with debuginfo (the -g flag)
 #optimize-tests = true
@@ -259,7 +283,13 @@
 #codegen-tests = true
 
 # Flag indicating whether git info will be retrieved from .git automatically.
-#ignore-git = false
+# Having the git information can cause a lot of rebuilds during development.
+# Note: If this attribute is not explicity set (e.g. if left commented out) it
+# will default to true if channel = "dev", but will default to false otherwise.
+#ignore-git = true
+
+# When creating source tarballs whether or not to create a source tarball.
+#dist-src = false
 
 # =============================================================================
 # Options for specific targets
@@ -292,12 +322,22 @@
 # build native code.
 #android-ndk = "/path/to/ndk"
 
+# Force static or dynamic linkage of the standard library for this target. If
+# this target is a host for rustc, this will also affect the linkage of the
+# compiler itself. This is useful for building rustc on targets that normally
+# only use static libraries. If unset, the target's default linkage is used.
+#crt-static = false
+
 # The root location of the MUSL installation directory. The library directory
 # will also need to contain libunwind.a for an unwinding implementation. Note
 # that this option only makes sense for MUSL targets that produce statically
 # linked binaries
 #musl-root = "..."
 
+# Used in testing for configuring where the QEMU images are located, you
+# probably don't want to use this.
+#qemu-rootfs = "..."
+
 # =============================================================================
 # Distribution options
 #