summaryrefslogtreecommitdiffhomepage
path: root/RELEASE_NOTE.md
diff options
context:
space:
mode:
Diffstat (limited to 'RELEASE_NOTE.md')
-rw-r--r--RELEASE_NOTE.md24
1 files changed, 15 insertions, 9 deletions
diff --git a/RELEASE_NOTE.md b/RELEASE_NOTE.md
index fcd38d6..56e843d 100644
--- a/RELEASE_NOTE.md
+++ b/RELEASE_NOTE.md
@@ -1,8 +1,14 @@
-Maintenance release, due to winget release on windows.
+Mostly fixes and internal stabilization.
-- Windows: wait for keypress before exit on `--help'
-- Fix `-D` deprecation warning never firing (was checking wrong condition)
-- Linux: drain AF_PACKET rx ring before nfqueue in the poll loop to reduce the race window where HopTab lookup could miss a hop value whose SYN/ACK had already arrived in the same wakeup
+On Windows, to make `WinDivert64.sys` available for deletion after the program terminates, the WinDivert service is now stopped on dpibreak termination. This prevents the [error](https://github.com/dilluti0n/dpibreak/issues/29) during `winget update --all`. (#21, #30)
+
+On Linux, there was a lot of internal refactoring, including possible fixes for memory ordering and packet buffer offset calculation in the rxring module.
+
+Other fixes:
+- Windows: keep the console window open on error so the message stays readable.
+- Windows: race condition and dangling pointer in the `windivert` crate. (#30)
+- Linux: iptables rules were not cleaned up on startup.
+- Linux: signal handling now uses signalfd integrated into the existing poll loop instead of a handler and a global flag.
## Installation
### Windows
@@ -11,14 +17,14 @@ Via winget:
winget install dpibreak
```
(Full package ID: `Dilluti0n.DPIBreak`)
-Run `dpibreak` on powershell or start (`Windows+R`).
+Run `dpibreak` on powershell or start (`Windows+R`). If error occurs on update, see [#29](https://github.com/dilluti0n/dpibreak/issues/29).
Portable download:
1. Download the `.zip` from the below and extract it.
-2. Double-click `dpibreak.exe` to run, or `start_fake.bat` for [fake](https://github.com/Dilluti0n/DPIBreak#fake) mode.
+2. Double-click `dpibreak.exe` to run, or `start_fake.bat` for [fake](https://github.com/dilluti0n/dpibreak#fake) mode.
3. To run automatically on boot, run `service_install.bat` as administrator.
-See `WINDOWS_GUIDE.txt` in the zip for more details. If you have trouble deleting the previous version's folder when updating, see [#21](https://github.com/Dilluti0n/DPIBreak/issues/21).
+See `WINDOWS_GUIDE.txt` in the zip for more details. If you have trouble deleting the previous version's folder when updating, see [#21](https://github.com/dilluti0n/dpibreak/issues/21).
> [!NOTE]
> On first run, Windows SmartScreen may block the binary. Double-click `dpibreak.exe` (or run it from `cmd`), then click **More info -> Run anyway**. After that, `dpibreak` works from any terminal including PowerShell. See [#25](https://github.com/dilluti0n/dpibreak/issues/25) for details.
@@ -31,8 +37,8 @@ curl -fsSL https://raw.githubusercontent.com/dilluti0n/dpibreak/master/install.s
Or download the tarball from the assets below:
```
-tar -xf DPIBreak-*.tar.gz
-cd DPIBreak-*/
+tar -xf dpibreak-*.tar.gz
+cd dpibreak-*/
sudo make install
```