actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Mention that uninstalled backend isn't marked optional. 

If an uninstalled backend (command not found) isn't marked optional,
warn about it, since it causes mdbook commands to error out.

Fixes #1283
This commit is contained in:
Érico Rolim 2020-07-24 23:18:22 -03:00
parent 303db0ddec
commit 78aa2a16f8
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
book-example/src/for_developers/backends.md
View File

@ -334,7 +334,9 @@ the usual `RUST_LOG` to control logging verbosity.
If you enable a backend that isn't installed, the default behavior is to throw an error: If you enable a backend that isn't installed, the default behavior is to throw an error:
```text ```text
The command wasn't found, is the "wordcount" backend installed? The command `mdbook-wordcount` wasn't found, is the "wordcount" backend installed?
If you want to ignore this error when the "wordcount" backend is not installed,
set `optional = true` in the `[output.wordcount]` section of the book.toml configuration file.
``` ```
This behavior can be changed by marking the backend as optional. This behavior can be changed by marking the backend as optional.

4
src/renderer/mod.rs
View File

@ -173,7 +173,9 @@ impl CmdRenderer {
return Ok(()); return Ok(());
} else { } else {
error!( error!(
"The command `{}` wasn't found, is the `{}` backend installed?", "The command `{0}` wasn't found, is the \"{1}\" backend installed? \
If you want to ignore this error when the \"{1}\" backend is not installed, \
set `optional = true` in the `[output.{1}]` section of the book.toml configuration file.",
self.cmd, self.name self.cmd, self.name
); );
} }