Skip to content

Commit

Permalink
Versioning clarifications.
Browse files Browse the repository at this point in the history
Signed-off-by: fruffy <[email protected]>
  • Loading branch information
fruffy committed Jul 3, 2024
1 parent 7a91717 commit d313bd4
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ use them, but YMMV.

- Google Protocol Buffers v3.25.3 or higher for control plane API generation

- C++ boost library
- C++ boost 1.76 library

- Python 3 for scripting and running tests

Expand Down Expand Up @@ -323,6 +323,8 @@ projects unless you install version 3.25.3.

P4C also depends on Google Abseil library. This library is also a pre-requisite for Protobuf of any version newer than 3.21. Therefore the use of Protobuf of suitable version automatically fulfils Abseil dependency. P4C typically installs its own version of Abseil using CMake's `FetchContent` module (Abseil LTS 20240116.1 at the moment).

For C++20 support P4C requires a Boost version of at least 1.76.

### CMake
P4C requires a CMake version of at least 3.16.3 or higher. On older systems, a newer version of CMake can be installed using `pip3 install --user cmake==3.16.3`. We have a CI test on Ubuntu 18.04 that uses this option, but there is no guarantee that this will lead to a successful build.

Expand Down Expand Up @@ -412,7 +414,7 @@ Installing on macOS:

## Garbage collector

P4c relies on [BDW garbage collector](https://github.com/ivmai/bdwgc)
P4C relies on [BDW garbage collector](https://github.com/ivmai/bdwgc)
to manage its memory. By default, the P4C executables are linked with
the garbage collector library. When the GC causes problems, this can
be disabled by setting `ENABLE_GC` cmake option to `OFF`. However,
Expand All @@ -423,7 +425,7 @@ a problem on MacOS.

## Crash dumps

P4c will use [libbacktrace](https://github.com/ianlancetaylor/libbacktrace.git)
P4C will use [libbacktrace](https://github.com/ianlancetaylor/libbacktrace.git)
to produce readable crash dumps if it is available. This is an optional
dependency; if it is not available everything should build just fine, but
crash dumps will not be very readable.
Expand Down

0 comments on commit d313bd4

Please sign in to comment.