Skip to content

Commit

Permalink
Version update and new policy regarding static analysis
Browse files Browse the repository at this point in the history
  • Loading branch information
lemire committed Jan 30, 2025
1 parent 4df18c9 commit a5a3630
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 21 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cmake_minimum_required(VERSION 3.10)

project(xor_singleheader VERSION 2.0.0 LANGUAGES C)
project(xor_singleheader VERSION 2.1.0 LANGUAGES C)

include(CTest)

Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,19 @@ It took 0.358220 seconds to build an index over 10000000 values.
...
```

## Policy regarding static analysis

We always encourage bug reports and bug fixes.
If a static analyzer reports a warning, it may
be a bug, but you have to carry the analysis to
show that it is a bug.

It is not a goal of this project to be warning-free when reviewed with all possible
static analyzers.

We will be happy to take in safe non-invasive pull requests to silence some warnings. However,
please do not file in an issue in such cases.

## Implementations of xor and binary fuse filters in other programmming languages

* [Go](https://github.com/FastFilter/xorfilter)
Expand Down
20 changes: 0 additions & 20 deletions tests/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,23 +1,3 @@
add_executable(unit unit.c)
add_test(unit unit)
target_link_libraries(unit PRIVATE xor_singleheader)


# full warnings with sanitizers for tests. Include debug symbols and
# only -O2 to maintain some debugability.
if (MSVC)
# limited support for MSVC, this is not tested
list(APPEND TEST_COMPILE_OPTIONS /W4 /fsanitize=address)
else() # *nix
list(APPEND TEST_COMPILE_OPTIONS -g -O2
-Wall -Wextra)

if (NOT MINGW) # sanitizers are not supported under mingw
list(APPEND TEST_COMPILE_OPTIONS -fsanitize=address,undefined)
# sanitsizers need to be specified at link time as well
target_link_options(unit PRIVATE -fsanitize=address,undefined)
endif()
endif()

target_compile_options(unit PRIVATE ${TEST_COMPILE_OPTIONS})

0 comments on commit a5a3630

Please sign in to comment.