diff options
| author | Alex Crichton <alex@alexcrichton.com> | 2020-04-30 10:53:16 -0700 |
|---|---|---|
| committer | Alex Crichton <alex@alexcrichton.com> | 2020-05-01 09:05:13 -0700 |
| commit | e1832fa4e4700a5f8935ac3e88f7688a15e17df0 (patch) | |
| tree | 83a9e5e259160bdfeef7c5f3cba30860144a6017 /src/doc/rustc | |
| parent | eece58a8e35c444afba6fa34873bc0244e32cd29 (diff) | |
| download | rust-e1832fa4e4700a5f8935ac3e88f7688a15e17df0.tar.gz rust-e1832fa4e4700a5f8935ac3e88f7688a15e17df0.zip | |
Rename `bitcode-in-rlib` option to `embed-bitcode`
This commit finishes work first pioneered in #70458 and started in #71528. The `-C bitcode-in-rlib` option, which has not yet reached stable, is renamed to `-C embed-bitcode` since that more accurately reflects what it does now anyway. Various tests and such are updated along the way as well. This'll also need to be backported to the beta channel to ensure we don't accidentally stabilize `-Cbitcode-in-rlib` as well.
Diffstat (limited to 'src/doc/rustc')
| -rw-r--r-- | src/doc/rustc/src/codegen-options/index.md | 60 |
1 files changed, 27 insertions, 33 deletions
diff --git a/src/doc/rustc/src/codegen-options/index.md b/src/doc/rustc/src/codegen-options/index.md index 6b31430f7ec..08b5ab10817 100644 --- a/src/doc/rustc/src/codegen-options/index.md +++ b/src/doc/rustc/src/codegen-options/index.md @@ -7,32 +7,6 @@ a version of this list for your exact compiler by running `rustc -C help`. This option is deprecated and does nothing. -## bitcode-in-rlib - -This flag controls whether or not the compiler puts LLVM bitcode into generated -rlibs. It takes one of the following values: - -* `y`, `yes`, `on`, or no value: put bitcode in rlibs (the default). -* `n`, `no`, or `off`: omit bitcode from rlibs. - -LLVM bitcode is only needed when link-time optimization (LTO) is being -performed, but it is enabled by default for backwards compatibility reasons. - -The use of `-C bitcode-in-rlib=no` can significantly improve compile times and -reduce generated file sizes. For these reasons, Cargo uses `-C -bitcode-in-rlib=no` whenever possible. Likewise, if you are building directly -with `rustc` we recommend using `-C bitcode-in-rlib=no` whenever you are not -using LTO. - -If combined with `-C lto`, `-C bitcode-in-rlib=no` will cause `rustc` to abort -at start-up, because the combination is invalid. - -> **Note**: the implementation of this flag today is to enable the -> `-Zembed-bitcode` option. When bitcode is embedded into an rlib then all -> object files within the rlib will have a special section (typically named -> `.llvmbc`, depends on the platform though) which contains LLVM bytecode. This -> section of the object file will not appear in the final linked artifact. - ## code-model This option lets you choose which code model to use. @@ -86,6 +60,26 @@ It takes one of the following values: For example, for gcc flavor linkers, this issues the `-nodefaultlibs` flag to the linker. +## embed-bitcode + +This flag controls whether or not the compiler puts LLVM bitcode into generated +rlibs. It takes one of the following values: + +* `y`, `yes`, `on`, or no value: put bitcode in rlibs (the default). +* `n`, `no`, or `off`: omit bitcode from rlibs. + +LLVM bitcode is only needed when link-time optimization (LTO) is being +performed, but it is enabled by default for backwards compatibility reasons. + +The use of `-C embed-bitcode=no` can significantly improve compile times and +reduce generated file sizes. For these reasons, Cargo uses `-C +embed-bitcode=no` whenever possible. Likewise, if you are building directly +with `rustc` we recommend using `-C embed-bitcode=no` whenever you are not +using LTO. + +If combined with `-C lto`, `-C embed-bitcode=no` will cause `rustc` to abort +at start-up, because the combination is invalid. + ## extra-filename This option allows you to put extra data in each output filename. It takes a @@ -355,21 +349,21 @@ Supported values for this option are: - `static` - non-relocatable code, machine instructions may use absolute addressing modes. - `pic` - fully relocatable position independent code, -machine instructions need to use relative addressing modes. +machine instructions need to use relative addressing modes. \ Equivalent to the "uppercase" `-fPIC` or `-fPIE` options in other compilers, -depending on the produced crate types. +depending on the produced crate types. \ This is the default model for majority of supported targets. #### Special relocation models -- `dynamic-no-pic` - relocatable external references, non-relocatable code. -Only makes sense on Darwin and is rarely used. +- `dynamic-no-pic` - relocatable external references, non-relocatable code. \ +Only makes sense on Darwin and is rarely used. \ If StackOverflow tells you to use this as an opt-out of PIC or PIE, don't believe it, use `-C relocation-model=static` instead. - `ropi`, `rwpi` and `ropi-rwpi` - relocatable code and read-only data, relocatable read-write data, -and combination of both, respectively. +and combination of both, respectively. \ Only makes sense for certain embedded ARM targets. -- `default` - relocation model default to the current target. +- `default` - relocation model default to the current target. \ Only makes sense as an override for some other explicitly specified relocation model previously set on the command line. @@ -380,7 +374,7 @@ Supported values can also be discovered by running `rustc --print relocation-mod In addition to codegen effects, `relocation-model` has effects during linking. If the relocation model is `pic` and the current target supports position-independent executables -(PIE), the linker will be instructed (`-pie`) to produce one. +(PIE), the linker will be instructed (`-pie`) to produce one. \ If the target doesn't support both position-independent and statically linked executables, then `-C target-feature=+crt-static` "wins" over `-C relocation-model=pic`, and the linker is instructed (`-static`) to produce a statically linked |
