Skip to content

Commit 7989927

Browse files
common: extend utils' README files
with more and up-to-date information about our development scripts.
1 parent bc4c188 commit 7989927

File tree

2 files changed

+26
-3
lines changed

2 files changed

+26
-3
lines changed

utils/README

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,14 @@ Persistent Memory Development Kit
22

33
This is utils/README.
44

5-
The scripts found here are used during library development.
5+
Scripts found in this directory are used during library development.
6+
7+
Sub-directory 'docker' contains scripts for running builds, tests and checks
8+
inside a Docker containers, among with prepared images' recipes and instruction
9+
on using them.
10+
11+
Sub-directory 'gha-runners' contains scripts used for execution specific sets of tests,
12+
on a self-hosted runners in GitHub Actions.
13+
14+
Both of these sub-directories are intended to be used as development process vehicles
15+
and are part of continuous integration process.

utils/docker/images/README

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,18 @@ Persistent Memory Development Kit
22

33
This is utils/docker/images/README.
44

5-
Scripts in this directory let you prepare Docker images for building
6-
PMDK project under specified OS (ubuntu, fedora).
5+
Dockerfiles and scripts placed in this directory are intended to be used as
6+
development process vehicles and part of continuous integration process.
7+
8+
Images built out of those recipes may by used with Docker or podman as
9+
development environment.
10+
11+
To manually build docker image using docker(1) execute, e.g.:
12+
13+
docker build --build-arg https_proxy=http://proxy.com:port --build-arg http_proxy=http://proxy.com:port \
14+
-t pmdk:debian-unstable -f ./Dockerfile.ubuntu-22.04 .
15+
16+
To run build and tests within a (previously built) Docker container execute, e.g.:
17+
18+
docker run --network=bridge --shm-size=4G -v /your/workspace/path/:/opt/workspace:z -w /opt/workspace/ \
19+
-e PMDK_CC=gcc -it pmdk:ubuntu-22.04 /bin/bash

0 commit comments

Comments
 (0)