From 42425456e7dd885360945ed4d508397d9a00d102 Mon Sep 17 00:00:00 2001 From: Christophe de Dinechin Date: Wed, 5 May 2021 15:06:39 +0200 Subject: [PATCH 1/2] docs: Remove horizontal ruler markers that disable spell checks There is a bug in the CI script checking spelling that causes it to skip any text that follows a horizontal ruler. (https://github.com/kata-containers/tests/issues/3448) Solution: replace one horizontal ruler marker with another that does not trip the spell-checking script. Fixes: #1793 Signed-off-by: Christophe de Dinechin --- docs/Limitations.md | 2 +- tools/packaging/ccloudvm/README.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/Limitations.md b/docs/Limitations.md index a440ea344c..294edfd860 100644 --- a/docs/Limitations.md +++ b/docs/Limitations.md @@ -28,7 +28,7 @@ * [Appendices](#appendices) * [The constraints challenge](#the-constraints-challenge) ---- +*** # Overview diff --git a/tools/packaging/ccloudvm/README.md b/tools/packaging/ccloudvm/README.md index e2ec137d6b..cec0443cae 100644 --- a/tools/packaging/ccloudvm/README.md +++ b/tools/packaging/ccloudvm/README.md @@ -2,7 +2,8 @@ * [How to use Kata workloads for `ccloudvm`](#how-to-use-kata-workloads-for-ccloudvm) * [Create Docker\* and Kata Containers virtualized environment](#create-docker-and-kata-containers-virtualized-environment) ---- + +*** The [ccloudvm](https://github.com/intel/ccloudvm/) tool is a command to create development and demo environments. The tool sets up these development From 5fdf617e7fe2cb81c1b274b8bc8f2ff96be3566c Mon Sep 17 00:00:00 2001 From: Christophe de Dinechin Date: Fri, 7 May 2021 11:38:04 +0200 Subject: [PATCH 2/2] docs: Fix spell-check errors found after new text is discovered The spell-checker scripts has some bugs that caused large chunks of texts to not be spell checked at all (see #1793). The previous commit worked around this bug, which exposed another bug: The following source text: are discussions about using VM save and restore to give [`criu`](https://github.com/checkpoint-restore/criu)-like functionality, which might provide a solution yields the surprising error below: WARNING: Word 'givelike': did you mean one of the following?: give like, give-like, wavelike Apparently, an extra space is removed, which is another issue with the spell-checking script. This case is somewhat contrived because of the URL link, so for now, I decided for a creative rewriting, inserting the word "a" knowing that "alike" is a valid word ;-) Fixes: #1793 Signed-off-by: Christophe de Dinechin --- docs/Limitations.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/Limitations.md b/docs/Limitations.md index 294edfd860..95cb58c8f3 100644 --- a/docs/Limitations.md +++ b/docs/Limitations.md @@ -94,7 +94,9 @@ This section lists items that might be possible to fix. ### checkpoint and restore The runtime does not provide `checkpoint` and `restore` commands. There -are discussions about using VM save and restore to give [`criu`](https://github.com/checkpoint-restore/criu)-like functionality, which might provide a solution. +are discussions about using VM save and restore to give us a +`[criu](https://github.com/checkpoint-restore/criu)`-like functionality, +which might provide a solution. Note that the OCI standard does not specify `checkpoint` and `restore` commands.