From d4ce3e454f8c241df3f9dfd9b03614d6457a9356 Mon Sep 17 00:00:00 2001 From: curtis Date: Tue, 15 Jan 2019 03:04:48 -0500 Subject: [PATCH] docs: add note about virtcontainers if testing runtime If following the contributing doc and wanting to run make check and make test in kata-runtime, the virtcontainers/bin/hook executable is expected to exist. But it only exists if it is compiled and installed. So a note has been added that if make test|check for runtime, to ensure that virtcontainers has been compiled and installed. Signed-off-by: ccollicutt --- CONTRIBUTING.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0040a9d124..659e7fb076 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,8 +73,17 @@ Kata Containers utilizes a number of [CI systems](https://en.wikipedia.org/wiki/ to automatically check every PR. As well as performing execution tests locally on your PR before submission, you are strongly encouraged to also run the same suite of [static checks](https://github.com/kata-containers/tests/blob/master/.ci/static-checks.sh) -the CI will execute. The easiest way to execute these in most of the repositories is -to invoke the `Makefile` `check` and `test` rules, while developer mode is enabled: +the CI will execute. + +> **Note:** If working on `kata-runtime`, first ensure `make` and `make install` has been run in the virtcontainers subdirectory. (See [virtcontainers](https://github.com/kata-containers/runtime/blob/master/virtcontainers/documentation/Developers.md#testing) documentation for more information.) +> +> ```sh +> $ cd runtime/virtcontainers +> $ make +> $ sudo -E PATH=$PATH make install +> ``` + +The easiest way to execute static checks in most of the repositories is to invoke the `Makefile` `check` and `test` rules, while developer mode is enabled. ```sh $ export KATA_DEV_MODE=true