update readme and prepare for release 0.0.34 (#199)

Update the readme and changelog to prepare for release 0.0.34
rust-bpf · Oct 25, 2023 · 52e29c6 · 52e29c6
1 parent 639cead
commit 52e29c6
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # [Unreleased]
 
+# [0.0.34] - 2023-10-25
+## Changed
+- Update readme to indicate that crate is not actively maintained and that users
+  should consider libbpf-rs instead
+
+## Fixed
+- Bugfix (byte ordering) in the tcpretrans example
+
 # [0.0.33] - 2022-09-09
 ## Added
 - Support to dump BPF program instructions. (#181)
@@ -230,7 +238,8 @@
 
 Initial release.
 
-[Unreleased]: https://github.com/rust-bpf/rust-bcc/compare/v0.0.33...HEAD
+[Unreleased]: https://github.com/rust-bpf/rust-bcc/compare/v0.0.34...HEAD
+[0.0.34]: https://github.com/rust-bpf/rust-bcc/compare/v0.0.33...v0.0.34
 [0.0.33]: https://github.com/rust-bpf/rust-bcc/compare/v0.0.32...v0.0.33
 [0.0.32]: https://github.com/rust-bpf/rust-bcc/compare/v0.0.31...v0.0.32
 [0.0.31]: https://github.com/rust-bpf/rust-bcc/compare/v0.0.30...v0.0.31

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "bcc"
-version = "0.0.34-alpha.0"
+version = "0.0.34"
 authors = ["Julia Evans <julia@jvns.ca>", "Brian Martin <bmartin@twitter.com>"]
 description = "Idiomatic Rust bindings for BPF Compiler Collection (BCC)"
 keywords = ["bpf", "bindings", "bcc"]

diff --git a/README.md b/README.md
@@ -1,5 +1,12 @@
 # rust-bcc
 
+**Warning! Unmaintained!**
+
+With the advances in other BPF crates in the Rust ecosystem, this crate is no
+longer actively maintained. We recommend adopting [libbpf-rs](https://crates.io/crates/libbpf-rs)
+
+## About
+
 Idiomatic Rust bindings for the BPF compiler collection. The goal is to mimic the
 Python BCC bindings in https://github.com/iovisor/bcc in a Rusty way.
 

diff --git a/examples/tcpretrans.rs b/examples/tcpretrans.rs
@@ -104,9 +104,17 @@ fn print_ipv4_event() -> Box<dyn FnMut(&[u8]) + Send> {
             get_datetime(),
             event.pid,
             event.ip,
-            format!("{}:{}", Ipv4Addr::from(u32::from_be(event.saddr)), event.lport),
+            format!(
+                "{}:{}",
+                Ipv4Addr::from(u32::from_be(event.saddr)),
+                event.lport
+            ),
             event.type_,
-            format!("{}:{}", Ipv4Addr::from(u32::from_be(event.daddr)), event.dport),
+            format!(
+                "{}:{}",
+                Ipv4Addr::from(u32::from_be(event.daddr)),
+                event.dport
+            ),
             event.state,
         );
     })
@@ -120,9 +128,17 @@ fn print_ipv6_event() -> Box<dyn FnMut(&[u8]) + Send> {
             get_datetime(),
             event.pid,
             event.ip,
-            format!("{}:{}", Ipv6Addr::from(u128::from_be(event.saddr)), event.lport),
+            format!(
+                "{}:{}",
+                Ipv6Addr::from(u128::from_be(event.saddr)),
+                event.lport
+            ),
             event.type_,
-            format!("{}:{}", Ipv6Addr::from(u128::from_be(event.daddr)), event.dport),
+            format!(
+                "{}:{}",
+                Ipv6Addr::from(u128::from_be(event.daddr)),
+                event.dport
+            ),
             event.state,
         );
     })