Skip to content

Commit e5b21dc

Browse files
committed
release 4.0.0
1 parent d0ad122 commit e5b21dc

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

CHANGES.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
v4.0.0
2-
------
1+
v4.0.0 2019-03-25
2+
-----------------
33

44
- Sexplib is now an optional library for the base `Cstruct` module.
55
A new `Cstruct_sexp` module has been introduced with the serialiser
@@ -16,6 +16,9 @@ v4.0.0
1616
packages to ensure that they pick up this version of the library.
1717
(fixes #222, @avsm)
1818

19+
- JavaScript stubs are now installed using the jsoo mechanism
20+
rather than a manual specification (#241 @jonludlam)
21+
1922
- Use computed versions in opam files to ensure that dependent
2023
opam packages such as cstruct-async get the same base version
2124
of cstruct to avoid mismatches. (@avsm)

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ This repository provides several packages that can be installed via the
1212
[OPAM](https://opam.ocaml.org) package manager:
1313

1414
- `cstruct`: the core Cstruct library
15+
- `cstruct-sexp`: serialisers into s-expression format of Cstructs
16+
- `cstruct-unix`: provide Unix variations of the read/write functions using file descriptors
1517
- `cstruct-async`: provide [Async](https://github.com/janestreet/async) Pipe and Bigstring support
1618
- `cstruct-lwt`: provide [Lwt](https://ocsigen.org/lwt) variants of read/write functions
1719
- `ppx_cstruct`: a [PPX](https://caml.inria.fr/pub/docs/manual-ocaml/extn.html#sec248) syntax extension (see below)
@@ -20,7 +22,7 @@ The libraries depend on OCaml version 4.02.3 and later, since it provides a
2022
[ppx](http://whitequark.org/blog/2014/04/16/a-guide-to-extension-points-in-ocaml/)
2123
extension point. The old
2224
[camlp4](http://caml.inria.fr/pub/docs/manual-camlp4/manual002.html)
23-
syntax extension is nolonger available; the last version which contained it
25+
syntax extension is nolonger available; the last cstruct release which contained it
2426
was v1.9.0.
2527

2628
### Local development
@@ -192,6 +194,10 @@ type foo64 =
192194
And `sexp_of_foo64` and `foo64_of_sexp` functions will also be available.
193195
The representation of the Sexp is the string representation of the enum.
194196

197+
If you do use the sexp decorator, then you will also need to add
198+
`sexplib` to the dependency list for your package (both in the
199+
`dune` file and the `opam` file).
200+
195201
Please see the `ppx_test/` directory for more in-depth examples.
196202

197203
[![Build Status](https://travis-ci.org/mirage/ocaml-cstruct.svg)](https://travis-ci.org/mirage/ocaml-cstruct)

0 commit comments

Comments
 (0)