diff options
| author | Jakub Beránek <jakub.beranek@vsb.cz> | 2024-06-28 10:46:52 +0200 |
|---|---|---|
| committer | Jakub Beránek <jakub.beranek@vsb.cz> | 2024-07-03 21:13:55 +0200 |
| commit | 9192479dc352c96927f3bfeda746d07c71a1a470 (patch) | |
| tree | ccb551efafaee7736979cf0e3980049087b0c378 | |
| parent | 1cfd47fe0b78f48a04ac8fce792a406b638da40b (diff) | |
| download | rust-9192479dc352c96927f3bfeda746d07c71a1a470.tar.gz rust-9192479dc352c96927f3bfeda746d07c71a1a470.zip | |
Improve documentation
| -rw-r--r-- | src/bootstrap/src/utils/exec.rs | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/src/bootstrap/src/utils/exec.rs b/src/bootstrap/src/utils/exec.rs index 8bcb2301f1a..87a3a2b0b28 100644 --- a/src/bootstrap/src/utils/exec.rs +++ b/src/bootstrap/src/utils/exec.rs @@ -34,7 +34,8 @@ pub enum OutputMode { /// By default, the command will print its stdout/stderr to stdout/stderr of bootstrap /// ([OutputMode::OnlyOutput]). If bootstrap uses verbose mode, then it will also print the /// command itself in case of failure ([OutputMode::All]). -/// If you want to handle the output programmatically, use `output_mode(OutputMode::OnlyOnFailure)`. +/// If you want to handle the output programmatically, use `output_mode(OutputMode::OnlyOnFailure)`, +/// which will print the output only if the command fails. /// /// [allow_failure]: BootstrapCommand::allow_failure /// [delay_failure]: BootstrapCommand::delay_failure @@ -113,7 +114,7 @@ impl BootstrapCommand { } } -/// This implementation is temporary, until all `Command` invocations are migrated to +/// FIXME: This implementation is temporary, until all `Command` invocations are migrated to /// `BootstrapCommand`. impl<'a> From<&'a mut Command> for BootstrapCommand { fn from(command: &'a mut Command) -> Self { @@ -138,7 +139,7 @@ impl<'a> From<&'a mut Command> for BootstrapCommand { } } -/// This implementation is temporary, until all `Command` invocations are migrated to +/// FIXME: This implementation is temporary, until all `Command` invocations are migrated to /// `BootstrapCommand`. impl<'a> From<&'a mut BootstrapCommand> for BootstrapCommand { fn from(command: &'a mut BootstrapCommand) -> Self { |
