Skip to content

Commit

Permalink
Move documentation to the unstable book
Browse files Browse the repository at this point in the history
  • Loading branch information
danakj committed Sep 7, 2021
1 parent ce35f8e commit 2a687de
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 13 deletions.
13 changes: 0 additions & 13 deletions src/doc/rustc/src/command-line-arguments.md
Expand Up @@ -345,19 +345,6 @@ replacement is purely textual, with no consideration of the current system's
pathname syntax. For example `--remap-path-prefix foo=bar` will match
`foo/lib.rs` but not `./foo/lib.rs`.

<a id="option-remap-cwd-prefix"></a>
## `--remap-cwd-prefix`: remap paths under the cwd in output

Remap all absolute paths that are rooted under the current working directory to
be under the given value instead. The given value may be absolute or relative,
or empty. This switch takes precidence over `--remap-path-prefix` in case they
would both match a given path.

This flag allows the command line to be universally reproducible, such that the
same execution will work on all machines, regardless of build environment.

This is an unstable option. Use `-Z remap-cwd-prefix=val` to specify a value.

<a id="option-json"></a>
## `--json`: configure json messages printed by the compiler

Expand Down
24 changes: 24 additions & 0 deletions src/doc/unstable-book/src/compiler-flags/remap-cwd-prefix.md
@@ -0,0 +1,24 @@
# `remap-cwd-prefix`

The tracking issue for this feature is: [#87325](https://github.com/rust-lang/rust/issues/87325).

------------------------

This flag will rewrite absolute paths under the current working directory,
replacing the current working directory prefix with a specified value.

The given value may be absolute or relative, or empty. This switch takes
precidence over `--remap-path-prefix` in case they would both match a given
path.

This flag helps to produce deterministic output, by removing the current working
directory from build output, while allowing the command line to be universally
reproducible, such that the same execution will work on all machines, regardless
of build environment.

## Example
```sh
# This would produce an absolute path to main.rs in build outputs of
# "./main.rs".
rustc -Z remap-cwd-prefix=. main.rs
```

0 comments on commit 2a687de

Please sign in to comment.