Skip to content

Commit a8a72ac

Browse files
d-e-s-odanielocfb
authored andcommitted
Replace warning with semantic versioning notice
The warning in the README is arguably unnecessary and causing more confusion than necessary. For one, it references [Semantic versioning](https://semver.org/) but that differs from Cargo's treatment of versions in subtle ways (in that it declares a free-for-all for anything below 1.0). Let's just state that we follow Cargo's semantic versioning rules and leave it at that. Signed-off-by: Daniel Müller <[email protected]>
1 parent 2b43b28 commit a8a72ac

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

libbpf-cargo/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
![CI](https://github.com/libbpf/libbpf-rs/workflows/Rust/badge.svg?branch=master)
22
[![rustc](https://img.shields.io/badge/rustc-1.63+-blue.svg)](https://blog.rust-lang.org/2022/08/11/Rust-1.63.0.html)
33

4-
WARNING: The API is not stable and is subject to breakage. Any breakage will
5-
include a minor version bump pre-1.0 and a major version bump post-1.0.
6-
[Semantic versioning](https://semver.org/) will be followed post-1.0 release.
7-
84
# libbpf-cargo
95

106
[![crates.io badge](https://img.shields.io/crates/v/libbpf-cargo.svg)](https://crates.io/crates/libbpf-cargo)
@@ -21,7 +17,11 @@ libbpf-cargo = "0.20"
2117

2218
See [full documentation here](https://docs.rs/libbpf-cargo).
2319

20+
This crate adheres to Cargo's [semantic versioning rules][cargo-semver].
21+
2422
## Contributing
2523

2624
We welcome all contributions! Please see the [contributor's
2725
guide](../CONTRIBUTING.md) for more information.
26+
27+
[cargo-semver]: https://doc.rust-lang.org/cargo/reference/resolver.html#semver-compatibility

libbpf-rs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
![CI](https://github.com/libbpf/libbpf-rs/workflows/Rust/badge.svg?branch=master)
22
[![rustc](https://img.shields.io/badge/rustc-1.63+-blue.svg)](https://blog.rust-lang.org/2022/08/11/Rust-1.63.0.html)
33

4-
WARNING: The API is not stable and is subject to breakage. Any breakage will
5-
include a minor version bump pre-1.0 and a major version bump post-1.0.
6-
[Semantic versioning](https://semver.org/) will be followed post-1.0 release.
7-
84
# libbpf-rs
95

106
[![crates.io badge](https://img.shields.io/crates/v/libbpf-rs.svg)](https://crates.io/crates/libbpf-rs)
@@ -21,7 +17,11 @@ libbpf-rs = "0.20"
2117

2218
See [full documentation here](https://docs.rs/libbpf-rs).
2319

20+
This crate adheres to Cargo's [semantic versioning rules][cargo-semver].
21+
2422
## Contributing
2523

2624
We welcome all contributions! Please see the [contributor's
2725
guide](../CONTRIBUTING.md) for more information.
26+
27+
[cargo-semver]: https://doc.rust-lang.org/cargo/reference/resolver.html#semver-compatibility

0 commit comments

Comments
 (0)