New release 0.18.0

=== Breaking changes - MASSIVE changes to API in order to 1.0 preparation. Please check document or code for detail. Sorry for the inconvenience. === New features - Support HSR interface. (37f9c5c) === Bug fixes - vxlan: Do not fail on unknown option. (2457bdf) - bond: Do not fail on unknown option. (acac109) - vlan: Do not fail on unknown option. (1617948) Signed-off-by: Gris Ge <[email protected]>
rust-netlink · Dec 4, 2023 · 0eb2ae9 · 0eb2ae9
1 parent 07e3e54
commit 0eb2ae9
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 4 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,4 +1,18 @@
 # Changelog
+## [0.18.0] - 2023-12-04
+### Breaking changes
+
+ - MASSIVE changes to API in order to 1.0 preparation. Please check
+   document or code for detail. Sorry for the inconvenience.
+
+### New features
+ - Support HSR interface. (37f9c5c)
+
+### Bug fixes
+ - vxlan: Do not fail on unknown option. (2457bdf)
+ - bond: Do not fail on unknown option. (acac109)
+ - vlan: Do not fail on unknown option. (1617948)
+
 ## [0.17.1] - 2023-08-30
 ### Breaking changes
  - N/A

diff --git a/README.md b/README.md
@@ -40,16 +40,21 @@ crate directly.
    changed netlink attribute. To capture the netlink raw bytes, you may use
    tcpdump/wireshark again the `nlmon` interface. For example:
 
- * The integration test(play with linux kernel netlink interface) should be
-   placed into `rtnetlink` crate. Current(netlink-packet-route) crate should
-   only unit test case only.
-
 ```bash
 modprobe nlmon
 ip link add nl0 type nlmon
 ip link set nl0 up
 tcpdump -i nl0 -w netlink_capture_file.cap
+# Then use wireshark to open this `netlink_capture_file.cap`
+# Find out the packet you are interested,
+# right click -> "Copy" -> "...as Hex Dump".
+# You may use https://github.com/cathay4t/hex_to_rust to convert this
+# hexdump to rust u8 array
 ```
+ * The integration test(play with linux kernel netlink interface) should be
+   placed into `rtnetlink` crate. Current(netlink-packet-route) crate should
+   only unit test case only.
+
 
  * For certain netlink message which cannot captured by nlmon, please use
    Rust Debug and explain every bits in comment.

diff --git a/TODO.md b/TODO.md
@@ -0,0 +1,4 @@
+ * Only tc has unparsed `Vec<u8>` left.
+ * Still has many flags not converted into `Vec<enum>`.
+ * Many place holders in `link::InfoData`.
+ * Missing unit test cases.