Update documentation on config via environment variables
authorRob Tsuk <robtsuk@google.com>
Mon, 30 Apr 2018 15:49:27 +0000 (08:49 -0700)
committerRob Tsuk <robtsuk@google.com>
Mon, 30 Apr 2018 15:49:27 +0000 (08:49 -0700)
Use source replacement as a specific example of the kind
of configuration feature that cannot currently be set by
environmental variables.

src/doc/src/reference/config.md

index d72e9a75dc5f2c970a3659fbda967e09593ab5dc..903a2383788d8e1393f36902a24491e126dc40f1 100644 (file)
@@ -133,9 +133,11 @@ example the `build.jobs` key can also be defined by `CARGO_BUILD_JOBS`.
 
 Environment variables will take precedent over TOML configuration, and currently
 only integer, boolean, and string keys are supported to be defined by
-environment variables.
+environment variables. This means that [source replacement][source], which is expressed by
+tables, cannot be configured through environment variables.
 
 In addition to the system above, Cargo recognizes a few other specific
 [environment variables][env].
 
 [env]: reference/environment-variables.html
+[source]: (reference/source-replacement.html)