From f4b8b0f5c0f2a5275cb62b9a14b17f0cc7f7ae66 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Tue, 30 Apr 2019 09:24:20 +0100 Subject: [PATCH] docs: Clarify virtcontainers build If working on the runtime, it is necessary to return to the top-level directory after having built `virtcontainers`. Make this clearer by using a `pushd` and `popd` pair rather than a single `cd`. Fixes #93. Signed-off-by: James O. D. Hunt --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 13d3d4c5e8..b2e274b53b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -78,13 +78,16 @@ your PR before submission, you are strongly encouraged to also run the same suit [static checks](https://github.com/kata-containers/tests/blob/master/.ci/static-checks.sh) 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.) +> **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 +> $ pushd runtime/virtcontainers > $ make > $ sudo -E PATH=$PATH make install +> $ popd > ``` +> +> The final `popd` is required to return to the top-level directory from where other build rules can be executed. 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.