From 9b108d9937952b882dc91f397771ffa33f6f392e Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Thu, 26 May 2022 14:12:35 +0100 Subject: [PATCH] docs: Improve snap formatting Improve the snap docs by using more consistent formatting and proper shell code in the shell example. Signed-off-by: James O. D. Hunt --- snap/local/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/snap/local/README.md b/snap/local/README.md index 83d33847f..47174d174 100644 --- a/snap/local/README.md +++ b/snap/local/README.md @@ -43,14 +43,14 @@ $ make -C tools/packaging snap > only run the snap build in a minimal host environment. To install the resulting snap image, snap must be put in [classic mode][3] and the -security confinement must be disabled (*--classic*). Also since the resulting snap -has not been signed the verification of signature must be omitted (*--dangerous*). +security confinement must be disabled (`--classic`). Also since the resulting snap +has not been signed the verification of signature must be omitted (`--dangerous`). ```sh -$ sudo snap install --classic --dangerous kata-containers_[VERSION]_[ARCH].snap +$ sudo snap install --classic --dangerous "kata-containers_${version}_${arch}.snap" ``` -Replace `VERSION` with the current version of Kata Containers and `ARCH` with +Replace `${version}` with the current version of Kata Containers and `${arch}` with the system architecture. ## Configure Kata Containers