1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
From 9f50b2a06614fff76379fa1738e22cfad14c6095 Mon Sep 17 00:00:00 2001
From: Johannes Demel <jdemel@gnuradio.org>
Date: Fri, 4 Jul 2025 16:03:36 +0200
Subject: [PATCH 02/12] readme: Add paragraph to outline dependency policy
This should help users and contributors to better understand the
different needs/desires. A written statement can be discussed.
Signed-off-by: Johannes Demel <jdemel@gnuradio.org>
---
README.md | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 6ee3ce3..f3ecb60 100644
--- a/README.md
+++ b/README.md
@@ -52,8 +52,8 @@ We use [cpu_features](https://github.com/google/cpu_features) to detect CPU feat
Some platforms require a very recent version that is not available through the appropriate package manager.
In this case you must use `cpu_features` as a submodule.
-**NOTE**: Most package managers provide recent enough `cpu_features` versions by now.
-Please default to the provided `cpu_features` version first, and only use the submodule in cases where this fails.
+**NOTE**: Most package managers provide recent enough `cpu_features` versions by now.
+Please default to the provided `cpu_features` version first, and only use the submodule in cases where this fails.
Please open an issue if this is the case.
There are two options to get the required code in a submodule:
@@ -116,6 +116,14 @@ The same goal applies to different OSes. Although this does only rarely happen,
We want to make sure VOLK works with C/C++ standard compliant compilers. Of course, as an open source project we focus on open source compilers, most notably GCC and Clang.
We want to make sure VOLK compiles on a wide variety of compilers. Thus, we target AppleClang and MSVC as well. Mind that MSVC lacks `aligned_alloc` support for aligned arrays. We use MSVC specific instructions in this case which cannot be `free`'d with `free`.
+### Dependency version policy
+Finding the correct way to handle the minimum (and potentially maximum) supported dependency version is a difficult task.
+For VOLK, we want to ensure that all widely used, and openly maintained, distributions (Ubuntu, Debian, Fedora, etc.) are supported.
+The default version of dependencies in these distributions are considered to be the baseline, or oldest supported versions.
+While older dependencies might work, we do not want to maintain workarounds etc. for these dependencies.
+Also, we want to signal to contributors that they can rely on certain minimum versions for contributions.
+If you want to use VOLK on an obsolete distribution, we assume you know what you are doing and you can make the necessary changes to compile VOLK on such a platform, e.g., decrease the minimum version checks and fix corresponding errors.
+This approach aims to strike a balance between the desire to use VOLK on every possible platform and the desire to be able to use the latest features.
## License
--
2.47.2
|
