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

23 lines
1.2 KiB
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
# Introduction
The crosvm project is a hosted (a.k.a.
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
[type-2](https://en.wikipedia.org/wiki/Hypervisor#Classification)) virtual machine monitor.
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
crosvm runs untrusted operating systems along with virtualized devices. Initially intended to be
used with KVM and Linux, crosvm supports multiple kinds of hypervisors. crosvm is focussed on safety
within the programming language and a sandbox around the virtual devices to protect the host from
attack in case of exploits in crosvm itself.
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
Other programs similar to crosvm are QEMU and VirtualBox. An operating system, made of a root file
system image and a kernel binary, are given as input to crosvm and then crosvm will run the
operating system using the platform's hypervisor.
Add crosvm logo in README and mdbook BUG=none TEST=none Change-Id: Ifc5851b2936fe11f28ddec66af6a5d3e42c2c047 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3237467 Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Daniel Verkamp <dverkamp@chromium.org> Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-10-21 15:24:02 +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
- [Source code](https://chromium.googlesource.com/chromiumos/platform/crosvm/)
- [GitHub mirror](https://github.com/google/crosvm)
- [API documentation](https://google.github.io/crosvm/doc/crosvm/), useful for searching API.
- Files for this book are under
[/docs/](https://chromium.googlesource.com/chromiumos/platform/crosvm/+/HEAD/docs/).
- [Issue tracker](https://bugs.chromium.org/p/chromium/issues/list?q=component:OS%3ESystems%3EContainers)
mdbook: Add links to source code at top page BUG=none TEST=none Change-Id: Ife7f1d7c8d5885f72e9b489e62735e8b236c1750 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3245056 Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Dennis Kempin <denniskempin@google.com> Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
2021-10-27 00:42:29 +00:00
Add crosvm logo in README and mdbook BUG=none TEST=none Change-Id: Ifc5851b2936fe11f28ddec66af6a5d3e42c2c047 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3237467 Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org> Reviewed-by: Daniel Verkamp <dverkamp@chromium.org> Reviewed-by: Dennis Kempin <denniskempin@google.com>
2021-10-21 15:24:02 +00:00
![logo](./logo.svg)
Reference in a new issue Copy permalink