mirrors/crosvm
1
0
Fork 0
mirror of https://chromium.googlesource.com/crosvm/crosvm synced 2024-11-25 05:03:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

crosvm: Make commands work.

Browse source 
Previewing docs, from CONTRIBUTING.md or from the dev_container, it's
`cd docs/book`.

BUG=None
TEST=copy-paste

Change-Id: If56a9f83c6722764b0979b6738f96a0800031da6
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/3779081
Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org>
Tested-by: Keiichi Watanabe <keiichiw@chromium.org>
This commit is contained in:
Junichi Uekawa 2022-07-07 14:44:52 +09:00 committed by crosvm LUCI
parent 89f754b0be
commit 6e7a617abb
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -114,13 +114,16 @@ When all tests pass, your change is merged into `origin/main`.
[Google Markdown style guide].
To render the book locally, you need to install mdbook and [mdbook-mermaid], which should be
installed when you run `./tools/install-deps`script.
installed when you run `./tools/install-deps`script. Or you can use the `tools/dev_container`
environment.
```sh
cd crosvm/docs/book/
cd docs/book/
mdbook build
```
Output is found at `docs/book/book/html/`.
> Note: If you make a certain size of changes, it's recommended to reinstall mdbook manually with
> `cargo install mdbook`, as `./tools/install-deps` only installs a binary with some convenient
> features disabled. For example, the full version of mdbook allows you to edit files while checking