Improve documentation

Kobzol · Kobzol · commit 0c599cb931da · 2024-06-28T10:46:52.000+02:00
diff --git 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 {

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,8 @@ pub enum OutputMode {`
`34`	`34`	`/// By default, the command will print its stdout/stderr to stdout/stderr of bootstrap`
`35`	`35`	`/// ([OutputMode::OnlyOutput]). If bootstrap uses verbose mode, then it will also print the`
`36`	`36`	`/// command itself in case of failure ([OutputMode::All]).`
`37`		-/// If you want to handle the output programmatically, use `output_mode(OutputMode::OnlyOnFailure)`.
	`37`	+/// If you want to handle the output programmatically, use `output_mode(OutputMode::OnlyOnFailure)`,
	`38`	`+/// which will print the output only if the command fails.`
`38`	`39`	`///`
`39`	`40`	`/// [allow_failure]: BootstrapCommand::allow_failure`
`40`	`41`	`/// [delay_failure]: BootstrapCommand::delay_failure`
`@@ -113,7 +114,7 @@ impl BootstrapCommand {`
`113`	`114`	`}`
`114`	`115`	`}`
`115`	`116`
`116`		-/// This implementation is temporary, until all `Command` invocations are migrated to
	`117`	+/// FIXME: This implementation is temporary, until all `Command` invocations are migrated to
`117`	`118`	/// `BootstrapCommand`.
`118`	`119`	`impl<'a> From<&'a mut Command> for BootstrapCommand {`
`119`	`120`	`fn from(command: &'a mut Command) -> Self {`
`@@ -138,7 +139,7 @@ impl<'a> From<&'a mut Command> for BootstrapCommand {`
`138`	`139`	`}`
`139`	`140`	`}`
`140`	`141`
`141`		-/// This implementation is temporary, until all `Command` invocations are migrated to
	`142`	+/// FIXME: This implementation is temporary, until all `Command` invocations are migrated to
`142`	`143`	/// `BootstrapCommand`.
`143`	`144`	`impl<'a> From<&'a mut BootstrapCommand> for BootstrapCommand {`
`144`	`145`	`fn from(command: &'a mut BootstrapCommand) -> Self {`