Skip to content

book.toml: Add a [book] table (and a description) #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 17, 2018

Conversation

wking
Copy link
Contributor

@wking wking commented Apr 17, 2018

Avoid:

$ mdbook build
2018-04-17 22:35:25 [WARN] (mdbook::config): It looks like you are using the legacy book.toml format.
2018-04-17 22:35:25 [WARN] (mdbook::config): We'll parse it for now, but you should probably convert to the new format.
2018-04-17 22:35:25 [WARN] (mdbook::config): See the mdbook documentation for more details, although as a rule of thumb
2018-04-17 22:35:25 [WARN] (mdbook::config): just move all top level configuration entries like `title`, `author` and
2018-04-17 22:35:25 [WARN] (mdbook::config): `description` under a table called `[book]`, move the `destination` entry
2018-04-17 22:35:25 [WARN] (mdbook::config): from `[output.html]`, renamed to `build-dir`, under a table called
2018-04-17 22:35:25 [WARN] (mdbook::config): `[build]`, and it should all work.
2018-04-17 22:35:25 [WARN] (mdbook::config): Documentation: http://rust-lang-nursery.github.io/mdBook/format/config.html
2018-04-17 22:35:25 [INFO] (mdbook::book): Book building has started

I've added the suggested [book]. And while I'm touching the file, I've also copied the first sentence from the README into the description entry.

Avoid [1]:

  $ mdbook build
  2018-04-17 22:35:25 [WARN] (mdbook::config): It looks like you are using the legacy book.toml format.
  2018-04-17 22:35:25 [WARN] (mdbook::config): We'll parse it for now, but you should probably convert to the new format.
  2018-04-17 22:35:25 [WARN] (mdbook::config): See the mdbook documentation for more details, although as a rule of thumb
  2018-04-17 22:35:25 [WARN] (mdbook::config): just move all top level configuration entries like `title`, `author` and
  2018-04-17 22:35:25 [WARN] (mdbook::config): `description` under a table called `[book]`, move the `destination` entry
  2018-04-17 22:35:25 [WARN] (mdbook::config): from `[output.html]`, renamed to `build-dir`, under a table called
  2018-04-17 22:35:25 [WARN] (mdbook::config): `[build]`, and it should all work.
  2018-04-17 22:35:25 [WARN] (mdbook::config): Documentation: http://rust-lang-nursery.github.io/mdBook/format/config.html
  2018-04-17 22:35:25 [INFO] (mdbook::book): Book building has started
  ...

I've added the suggested [book].  And while I'm touching the file,
I've also copied the first sentence from the README into the
description entry.

[1]: https://travis-ci.org/rust-lang-nursery/api-guidelines/builds/367895578#L490
Copy link
Member

@dtolnay dtolnay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks. What a helpful message from the mdBook folks.

@dtolnay dtolnay merged commit faa8c5a into rust-lang:master Apr 17, 2018
@wking wking deleted the update-book-toml branch April 17, 2018 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants