• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1This directory contains [GitHub Actions](https://github.com/features/actions) workflow files.
2
3# Known issues
4
5## USAN, ASAN (`lz4-ubsan-x64`, `lz4-ubsan-x86`, `lz4-asan-x64`)
6
7For now, `lz4-ubsan-*` uses the `-fsanitize-recover=pointer-overflow` flag:
8there are known cases of pointer overflow arithmetic within `lz4.c` fast compression.
9These cases are not dangerous with known architecture,
10but they are not guaranteed to work by the C standard,
11which means that, in some future, some new architecture or some new compiler
12may decide to do something funny that could break this behavior.
13Hence, in anticipation, it's better to remove them.
14This has been already achieved in `lz4hc.c`.
15However, the same attempt in `lz4.c` resulted in massive speed losses,
16which is not an acceptable cost for preemptively solving a "potential future" problem
17not active anywhere today.
18Therefore, a more acceptable work-around will have to be found first.
19
20
21
22## cppcheck (`lz4-cppcheck`)
23
24This test script ignores the exit code of `make cppcheck`.
25Because this project doesn't 100% follow their recommendation.
26Also sometimes it reports false positives.
27
28
29
30# Notes
31
32- You can investigate various information at the right pane of GitHub
33  Actions report page.
34
35| Item                      | Section in the right pane             |
36| ------------------------- | ------------------------------------- |
37| OS, VM                    | Set up job                            |
38| git repo, commit hash     | Run actions/checkout@v2               |
39| Version of tools          | Environment info                      |
40
41
42
43# Difference with `.travis.yml`
44
45The following tests are not be included due to limitation of GH-Actions.
46
47- name: aarch64 real-hw tests
48- name: PPC64LE real-hw tests
49- name: IBM s390x real-hw tests
50