From 3354723907492879fdd478db06908a6415b98129 Mon Sep 17 00:00:00 2001 From: Zihan Chen Date: Wed, 16 Nov 2022 00:17:36 +0000 Subject: [PATCH] book: Fix footnote escape from mdformat Footnote was escaped in last version, now deps contain all mdformat plugins required to support markdown extensions supported in mdbook TEST=./tools/health-check, mdbook build docs/book/ --dest-dir ../target generates html with correct footnote Change-Id: I0047a7174cf241c5510a84d30349ba64790f5830 Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4029524 Commit-Queue: Daniel Verkamp Auto-Submit: Zihan Chen Commit-Queue: Zihan Chen Reviewed-by: Daniel Verkamp --- docs/book/src/testing.md | 29 ++++++++++++++--------------- tools/install-deps | 3 ++- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/book/src/testing.md b/docs/book/src/testing.md index e41e5fa7eb..93cdd7fb07 100644 --- a/docs/book/src/testing.md +++ b/docs/book/src/testing.md @@ -51,23 +51,22 @@ Upstream crosvm is not involved in these tests and they are not executed in cros The platforms below can all be tested using `tools/run_tests -p $platform`. The table indicates how these tests are executed: -| Platform | Build | Unit Tests | Integration Tests | E2E Tests | -| :---------------------------- | :---: | :-----------------------------: | :---------------: | :-------: | -| x86_64 (linux) | ✅ | ✅ | ✅ | ✅ | -| aarch64 (linux) | ✅ | ✅ (qemu-static\[^qemu-static\]) | ✅ (qemu\[^qemu\]) | ❌ | -| armhf (linux) | ✅ | ✅ (qemu-static\[^qemu-static\]) | ❌ | ❌ | -| mingw64\[^windows\] (linux) | 🚧 | 🚧 (wine64) | ❌ | ❌ | -| mingw64\[^windows\] (windows) | 🚧 | 🚧 | 🚧 | ❌ | +| Platform | Build | Unit Tests | Integration Tests | E2E Tests | +| :-------------------------- | :---: | :---------------------------: | :---------------: | :-------: | +| x86_64 (linux) | ✅ | ✅ | ✅ | ✅ | +| aarch64 (linux) | ✅ | ✅ (qemu-static[^qemu-static]) | ✅ (qemu[^qemu]) | ❌ | +| armhf (linux) | ✅ | ✅ (qemu-static[^qemu-static]) | ❌ | ❌ | +| mingw64[^windows] (linux) | 🚧 | 🚧 (wine64) | ❌ | ❌ | +| mingw64[^windows] (windows) | 🚧 | 🚧 | 🚧 | ❌ | Crosvm CI will use the same configuration as `tools/run_tests`. -\[^qemu-static\]: qemu-static-aarch64 or qemu-static-arm translate instructions into x86 and -executes them on the host kernel. This works well for unit tests, but will fail when interacting -with platform specific kernel features. +[^qemu-static]: qemu-static-aarch64 or qemu-static-arm translate instructions into x86 and executes them on the + host kernel. This works well for unit tests, but will fail when interacting with platform + specific kernel features. -\[^qemu\]: run_tests will launch a VM for testing in the background. This VM is using full system -emulation, which causes tests to be slow. Also not all aarch64 features are properly emulated, which -prevents us from running e2e tests. +[^qemu]: run_tests will launch a VM for testing in the background. This VM is using full system + emulation, which causes tests to be slow. Also not all aarch64 features are properly emulated, + which prevents us from running e2e tests. -\[^windows\]: Windows builds of crosvm are a work in progress. Some tests are executed via wine64 on -linux +[^windows]: Windows builds of crosvm are a work in progress. Some tests are executed via wine64 on linux diff --git a/tools/install-deps b/tools/install-deps index d5a531ac19..adfd26f0fe 100755 --- a/tools/install-deps +++ b/tools/install-deps @@ -53,7 +53,8 @@ sudo apt-get install --yes --no-install-recommends \ pip3 install \ meson \ mdformat \ - mdformat-tables \ + mdformat-gfm \ + mdformat-footnote \ argh \ mypy \ black