Mirrors/mdBook
2
0
Fork 0
mirror of https://github.com/rust-lang/mdBook synced 2024-12-14 14:52:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1284 from ericonr/opt

Browse source 
Mention that uninstalled backend isn't marked optional.
This commit is contained in:
Eric Huss 2020-07-30 20:22:55 -07:00 committed by GitHub
commit 8746206060
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
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:
```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.

4
src/renderer/mod.rs
View file

@ -173,7 +173,9 @@ impl CmdRenderer {
return Ok(());
} else {
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
);
}