github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-27 12:08:58 +00:00
Code Issues Projects Releases Wiki Activity

docs: Clarify virtcontainers build

Browse Source 
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 <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt 2019-04-30 09:24:20 +01:00
parent 47413c33fa
commit f4b8b0f5c0
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -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.