Skip to content

Minor docs updates #366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 20, 2024
Merged

Minor docs updates #366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9755695
Properly format list in README
lukaszstolarczuk Mar 20, 2024
7a8fda2
Mention logger in PR template
lukaszstolarczuk Mar 20, 2024
2609e53
Use proper tag in docker's readme
lukaszstolarczuk Mar 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ simply replace word `docker` with `podman`.
To build docker image on local machine enter the root dir of the repository and execute:

```sh
docker build -t ur:ubuntu-22.04 -f .github/docker/ubuntu-22.04.Dockerfile .
docker build -t umf:ubuntu-22.04 -f .github/docker/ubuntu-22.04.Dockerfile .
```

To set any build time variable (e.g., an optional ARG from docker recipe), add to the command (after `build`), e.g.:
Expand All @@ -33,7 +33,7 @@ One other example of using these extra build arguments are proxy settings. They
To run docker container (using the previously built image) execute:

```sh
docker run --shm-size=4G -v /your/workspace/path/:/opt/workspace:z -w /opt/workspace/ -it ur:ubuntu-22.04 /bin/bash
docker run --shm-size=4G -v /your/workspace/path/:/opt/workspace:z -w /opt/workspace/ -it umf:ubuntu-22.04 /bin/bash
```

To set (or override) any docker environment variable, add to the command (after `run`):
Expand Down
1 change: 1 addition & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,4 @@ Before checking all the boxes please mark the PR as draft.
- [ ] Extended the README/documentation
- [ ] All newly added source files have a license
- [ ] All newly added source files are referenced in CMake files
- [ ] Logger (with debug/info/... messages) is used
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ A good practices, when opening a PR, are:
- one PR should fix/enhance one thing, split large PR into a few smaller PRs,
- keep commits neat and in order,
- squash commits to include only relevant ones (no "fixes after review" or similar),
- if a commit fixes an open issue, add in the commit message line: `Fixes #<issue_no>`
- if a commit only mention an open issue, add in the commit message, e.g. `Ref. #<issue_no>`
- if a commit fixes an open issue, add in the commit message line: `Fixes #<issue_no>`,
- if a commit only mention an open issue, add in the commit message, e.g. `Ref. #<issue_no>`.

### Building and testing

Expand Down
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,8 @@ A memory provider that provides memory from L0 device.
1) Linux or Windows OS
2) The `UMF_BUILD_LEVEL_ZERO_PROVIDER` option turned `ON` (by default)

Additionally, required for tests:
Additionally, required for tests:

3) Linux OS
4) The `UMF_BUILD_GPU_TESTS` option turned `ON`
5) System with Level Zero compatible GPU
Expand Down