Commit fda5a83e authored by Baptiste Jonglez's avatar Baptiste Jonglez
Browse files

Update documentation to prepare for 1.3.1 release

parent bd08acaf
# Changelog for kea-hook-runscript
## 1.3.1 (2019-11-02)
Misc:
- Produce release tarballs with pre-built messages, to avoid depending on the `kea-msg-compiler` binary (#15)
## 1.3.0 (2019-11-02)
New features:
......
......@@ -80,24 +80,32 @@ is to continously display the content of this file:
## How to build
To build the hook, you need Kea and Boost development headers, the `kea-msg-compiler`
binary, and the Kea libraries.
To build the hook, you need the Kea libraries as well as the Kea and Boost development
headers.
If you build from the git repository, you additionally need the `kea-msg-compiler`
binary to compile messages.
The release tarballs for `kea-hook-runscript` already contain the compiled messages
to avoid depending on `kea-msg-compiler`. Make sure to use the actual release tarball,
not the source tarball that is automatically generated by Github.
### Using a packaged version of Kea
If you use a Kea package, make sure you have the appropriate development packages:
If you use a Kea package, you need the appropriate development packages:
on Debian, the packages are `kea-dev` and `libboost-dev`.
Then, to build the hook, simply run:
$ make
$ make -j
When using ISC-provided packages hosted on Cloudsmith, it has been reported that the
`kea-msg-compiler` binary may be missing (#15). In that case, build Kea from source
as explained below, but only set `$KEA_MSG_COMPILER` (so that you still use the packaged
headers and libraries of Kea).
`kea-msg-compiler` binary may be missing. In that case, you have several choices:
- use a tarball release for `kea-hook-runscript`, since they don't need `kea-msg-compiler`
- build Kea from source as explained below, but only set `$KEA_MSG_COMPILER` (so that you still use the packaged headers and libraries of Kea).
### Building Kea from source
### Using Kea source
To build against a local Kea source tree, assumed to be in `~/kea`:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment