crosvm/README.chromeos.md

# Crosvm on ChromeOS

Here are pointers to useful documentation for working on Crosvm on Chrome OS.

## Uploading changes

See [Creating a CL for Chromium OS Developers](CONTRIBUTING.md#chromiumos-cl).

## Building

See [Building for ChromeOS](https://google.github.io/crosvm/building_crosvm/chromium_os.html) in the
crosvm mdbook.

## Submitting

See [presubmit checking](CONTRIBUTING.md#presubmit) and
[postsubmit merging](CONTRIBUTING.md#chromiumos-postsubmit)
crosvm: Merge README.chromeos to CONTRIBUTING. Docs are scattered around, and README.chromeos isn't markdown. Merge to CONTRIBUTING doc and update the relevant parts. Rename to README.chromeos.md and make it point to the other doc. BUG=None TEST=read it. Change-Id: Ib1df58e1a7c48d6faad71faffc9527da5f3218be Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3405403 Reviewed-by: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Junichi Uekawa <uekawa@chromium.org> 2022-01-21 08:53:49 +00:00			`# Crosvm on ChromeOS`

			`Here are pointers to useful documentation for working on Crosvm on Chrome OS.`

			`## Uploading changes`

			`See [Creating a CL for Chromium OS Developers](CONTRIBUTING.md#chromiumos-cl).`

			`## Building`

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			`See [Building for ChromeOS](https://google.github.io/crosvm/building_crosvm/chromium_os.html) in the`
			`crosvm mdbook.`
crosvm: Merge README.chromeos to CONTRIBUTING. Docs are scattered around, and README.chromeos isn't markdown. Merge to CONTRIBUTING doc and update the relevant parts. Rename to README.chromeos.md and make it point to the other doc. BUG=None TEST=read it. Change-Id: Ib1df58e1a7c48d6faad71faffc9527da5f3218be Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3405403 Reviewed-by: Dennis Kempin <denniskempin@google.com> Tested-by: kokoro <noreply+kokoro@google.com> Commit-Queue: Junichi Uekawa <uekawa@chromium.org> 2022-01-21 08:53:49 +00:00
			`## Submitting`

			`See [presubmit checking](CONTRIBUTING.md#presubmit) and`
			`[postsubmit merging](CONTRIBUTING.md#chromiumos-postsubmit)`