Skip to content

Commit

Permalink
Fix as per Lint workflow (#477)
Browse files Browse the repository at this point in the history
  • Loading branch information
paulo-ferraz-oliveira committed Oct 14, 2023
1 parent f8c3c7a commit 72b5894
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 11 deletions.
5 changes: 3 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@
- Shellcheck and shfmt completion scripts (#463)
- Shellcheck and shfmt generated files (#464)
- Trim kerl releases output **Breaking change** (#465)
- Bury dead code **Breaking change** (#466)
patches and code for very old OTP releases have been removed - if you need this, please use 3.1.0 or earlier.
- Bury dead code **Breaking change** (#466)
patches and code for very old OTP releases have been removed - if you need this,
please use 3.1.0 or earlier.
- Fix kerl remote command (#469)
- Fix csh (de)activate (#470)
- Fix no whitespace before ps output (#474)
Expand Down
19 changes: 10 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,22 +43,23 @@ We may discuss details with you regarding the implementation, and its inclusion
We try to have as many of `kerl`'s features tested as possible. Everything that a user can do,
and is repeatable in any way, should be tested, to guarantee backwards compatible.

## Adding support for your Linux distribution to scan for build pre-requisites
## Adding support for your Linux distribution to scan for build pre-requisites

Erlang needs several packages to build correctly - many of which may or may not be present on a fresh
OS install or docker image, so as a convenience, kerl tests for these packages before it attempts to
OS install or Docker image, so as a convenience, `kerl` tests for these packages before it attempts to
build.

We currently have tests for many popular Linux distributions but the sheer number of them means we
may not have support for yours. If you want to add it, here is what we are looking for:

* starting around line 700 are a series of `_KPP_<distro>_` parameters.
* Inspect the `/etc/os-release` file and find out what your distribution is called there
* Use that name to name your variables.
* Add a new function in the style of `_rpm()` `_dpkg()` etc to probe your distribution's package manager
* Add the list of packages corresponding to names used by the package manager in another variable
* Add the package probe function name to a new variable so kerl knows how to drive its testing
* Test locally and submit the output from that test as a comment in your PR
- Starting around line 700 are a series of `_KPP_<distro>_` parameters
- Inspect the `/etc/os-release` file and find out what your distribution is called there
- Use that name to name your variables
- Add a new function in the style of `_rpm()`, `_dpkg()`, etc., to probe your distribution's package
manager
- Add the list of packages corresponding to names used by the package manager in another variable
- Add the package probe function name to a new variable so `kerl` knows how to drive its testing
- Test locally and submit the output from that test as a comment in your PR

## Submitting your changes

Expand Down

0 comments on commit 72b5894

Please sign in to comment.