andreacavalli/netty-incubator-buffer-api
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
108 Commits 1 Branch 0 Tags 1.2 MiB
Java 99.6%
Dockerfile 0.2%
Makefile 0.2%
3b1743c7fd
Go to file
Chris Vest 3b1743c7fd Javadoc corrections for buffer accessor methods 
Fixes #22
2021-01-05 12:24:46 +01:00
.github/workflows Capture build artifacts for failed builds 2020-12-01 14:38:09 +01:00
src Javadoc corrections for buffer accessor methods 2021-01-05 12:24:46 +01:00
.dockerignore Add a docker-based build 2020-11-18 17:16:37 +01:00
.gitignore Prepare incubator repo for new buffer API 2020-11-17 14:56:28 +01:00
Dockerfile Try a different caching mechanism 2020-11-21 15:26:10 +01:00
Makefile The make clean command now also cleans up after failed build commands 2020-12-11 12:10:04 +01:00
pom.xml The assertj-core dependency should only be available in test scope 2020-11-23 18:11:22 +01:00
README.md Explain the make build in the README.md file 2020-11-18 17:32:42 +01:00

README.md

Netty Incubator Buffer API

This repository is incubating a new buffer API proposed for Netty 5.

Building and Testing

Short version: just run make.

The project currently relies on snapshot versions of the Panama Foreign fork of OpenJDK. This allows us to test out the must recent version of the jdk.incubator.foreign APIs, but also make building and local development more involved. To simplify things, we have a Docker based build, controlled via a Makefile with the following commands:

  • image – build the docker image. This includes building a snapshot of OpenJDK, and download all relevant Maven dependencies.
  • test – run all tests in a docker container. This implies image. The container is automatically deleted afterwards.
  • dbg – drop into a shell in the build container, without running the build itself. The debugging container is not deleted afterwards.
  • clean – remote the debugging container created by dbg.
  • build – build binaries and run all tests in a container, and copy the target directory out of the container afterwards. This is the default build target.