mirrors/crosvm
1
0
Fork 0
mirror of https://chromium.googlesource.com/crosvm/crosvm synced 2025-02-11 20:56:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
crosvm/docs/book/src/SUMMARY.md

28 lines
1,015 B
Markdown
Raw Normal View History

book: add initial book using mdbook This change adds a document that was already written, but never published before. Also, the summary includes a skeleton of chapters to be filled in by future changes. TEST=mdbook build docs/book BUG=None Change-Id: If1d6e295b6d5a639f728f5de0df73de094399166 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2982861 Reviewed-by: Dennis Kempin <denniskempin@google.com> Tested-by: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2021-06-23 18:05:57 +00:00
# Summary
docs: Use mdformat to format markdown files The tool is added to ./tools/fmt which will be called during ./tools/presubmit as well as by Kokoro during testing. This requires a new dev container version to bundle the mdformat tool in the container. Note: mdformat does not have any IDE integrations, but the prettier plugin with prose-wrap enabled and a line length of 100 provides almost identical results. BUG=None TEST=./tools/fmt --check Change-Id: I0ae5659eff8555df7c85c70e62095a1e116b98da Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3416098 Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2022-01-25 23:14:43 +00:00
- [Introduction](./introduction.md)
- [Building Crosvm](./building_crosvm/index.md)
- [For Linux](./building_crosvm/linux.md)
- [For Chromium OS](./building_crosvm/chromium_os.md)
- [Running Crosvm](./running_crosvm/index.md)
- [Example Usage](./running_crosvm/example_usage.md)
- [Advanced Usage](./running_crosvm/advanced_usage.md)
- [Custom Kernel / Rootfs](./running_crosvm/custom_kernel_rootfs.md)
- [System Requirements](./running_crosvm/requirements.md)
- [Features](./running_crosvm/features.md)
- [Devices](./running_crosvm/devices.md)
- [Architecture](./architecture.md)
- [Contributing](./contributing.md)
book: add initial book using mdbook This change adds a document that was already written, but never published before. Also, the summary includes a skeleton of chapters to be filled in by future changes. TEST=mdbook build docs/book BUG=None Change-Id: If1d6e295b6d5a639f728f5de0df73de094399166 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2982861 Reviewed-by: Dennis Kempin <denniskempin@google.com> Tested-by: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2021-06-23 18:05:57 +00:00
docs: Use mdformat to format markdown files The tool is added to ./tools/fmt which will be called during ./tools/presubmit as well as by Kokoro during testing. This requires a new dev container version to bundle the mdformat tool in the container. Note: mdformat does not have any IDE integrations, but the prettier plugin with prose-wrap enabled and a line length of 100 provides almost identical results. BUG=None TEST=./tools/fmt --check Change-Id: I0ae5659eff8555df7c85c70e62095a1e116b98da Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3416098 Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2022-01-25 23:14:43 +00:00
______________________________________________________________________
book: add initial book using mdbook This change adds a document that was already written, but never published before. Also, the summary includes a skeleton of chapters to be filled in by future changes. TEST=mdbook build docs/book BUG=None Change-Id: If1d6e295b6d5a639f728f5de0df73de094399166 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2982861 Reviewed-by: Dennis Kempin <denniskempin@google.com> Tested-by: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2021-06-23 18:05:57 +00:00
docs: Use mdformat to format markdown files The tool is added to ./tools/fmt which will be called during ./tools/presubmit as well as by Kokoro during testing. This requires a new dev container version to bundle the mdformat tool in the container. Note: mdformat does not have any IDE integrations, but the prettier plugin with prose-wrap enabled and a line length of 100 provides almost identical results. BUG=None TEST=./tools/fmt --check Change-Id: I0ae5659eff8555df7c85c70e62095a1e116b98da Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3416098 Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2022-01-25 23:14:43 +00:00
- [Onboarding Resources](./onboarding.md)
- [Appendix](./appendix/index.md)
- [Sandboxing](./appendix/sandboxing.md)
- [Seccomp](./appendix/seccomp.md)
- [Minijail](./appendix/minijail.md)
mdbook: Generate cargo-doc by GitHub Actions BUG=b:199874828 TEST=run in my GitHub account Change-Id: Ie456a90731ccedc4934a13110902ea153fce23ae Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3159891 Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-08-24 09:58:07 +00:00
docs: Use mdformat to format markdown files The tool is added to ./tools/fmt which will be called during ./tools/presubmit as well as by Kokoro during testing. This requires a new dev container version to bundle the mdformat tool in the container. Note: mdformat does not have any IDE integrations, but the prettier plugin with prose-wrap enabled and a line length of 100 provides almost identical results. BUG=None TEST=./tools/fmt --check Change-Id: I0ae5659eff8555df7c85c70e62095a1e116b98da Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3416098 Reviewed-by: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Alexandre Courbot <acourbot@chromium.org> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Dennis Kempin <denniskempin@google.com>
2022-01-25 23:14:43 +00:00
______________________________________________________________________
mdbook: Generate cargo-doc by GitHub Actions BUG=b:199874828 TEST=run in my GitHub account Change-Id: Ie456a90731ccedc4934a13110902ea153fce23ae Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3159891 Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-08-24 09:58:07 +00:00
[API Documentation](./api.md)
Reference in a new issue Copy permalink