Skip to content

Commit 6d27281

Browse files
d-e-s-odanielocfb
authored andcommitted
capi: Add section about versioning guarantees to README
While it is possible that our forward/backward compatibility story is sufficient to cover incompatible versions, we won't officially endorse incompatible version combinations (e.g., using a blazesym 0.3 shared object from a program having linked against blazesym 0.2). Signed-off-by: Daniel Müller <deso@posteo.net>
1 parent 3b47031 commit 6d27281

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

capi/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ blazesym-c
1010
**blazesym-c** provides C language bindings for the [**blazesym**][blazesym]
1111
library.
1212

13+
Please note that this library adheres to Cargo's [semantic versioning
14+
rules][cargo-semver]. While it is likely that the ABI is sufficiently
15+
flexible to cover incompatible versions, you do so at your own risk.
16+
1317
## Build & Use
1418
**blazesym-c** requires a standard Rust toolchain and can be built using
1519
the Cargo project manager (e.g., `cargo build`).
@@ -36,3 +40,4 @@ is available as part of the Rust documentation or can be generated locally from
3640
the current repository snapshot using `cargo doc`.
3741

3842
[blazesym]: https://crates.io/crates/blazesym
43+
[cargo-semver]: https://doc.rust-lang.org/cargo/reference/resolver.html#semver-compatibility

0 commit comments

Comments
 (0)