From a1ae524512f70ba36bd9b1f6f10ad38dae7b6baa Mon Sep 17 00:00:00 2001 From: Rob Ede Date: Thu, 1 Feb 2024 06:42:41 +0000 Subject: [PATCH] docs: clean changelog --- actix-rt/CHANGES.md | 137 ++++++++++++++-------------------------- actix-server/CHANGES.md | 118 +++++++++++----------------------- 2 files changed, 83 insertions(+), 172 deletions(-) diff --git a/actix-rt/CHANGES.md b/actix-rt/CHANGES.md index dc2d0fc3..6a6b18b4 100644 --- a/actix-rt/CHANGES.md +++ b/actix-rt/CHANGES.md @@ -10,150 +10,105 @@ ## 2.8.0 -- Add `#[track_caller]` attribute to `spawn` functions and methods. [#454] -- Update `tokio-uring` dependency to `0.4`. [#473] +- Add `#[track_caller]` attribute to `spawn` functions and methods. +- Update `tokio-uring` dependency to `0.4`. - Minimum supported Rust version (MSRV) is now 1.59. -[#454]: https://github.com/actix/actix-net/pull/454 -[#473]: https://github.com/actix/actix-net/pull/473 - ## 2.7.0 -- Update `tokio-uring` dependency to `0.3`. [#448] +- Update `tokio-uring` dependency to `0.3`. - Minimum supported Rust version (MSRV) is now 1.49. -[#448]: https://github.com/actix/actix-net/pull/448 - ## 2.6.0 -- Update `tokio-uring` dependency to `0.2`. [#436] - -[#436]: https://github.com/actix/actix-net/pull/436 +- Update `tokio-uring` dependency to `0.2`. ## 2.5.1 -- Expose `System::with_tokio_rt` and `Arbiter::with_tokio_rt`. [#430] - -[#430]: https://github.com/actix/actix-net/pull/430 +- Expose `System::with_tokio_rt` and `Arbiter::with_tokio_rt`. ## 2.5.0 -- Add `System::run_with_code` to allow retrieving the exit code on stop. [#411] - -[#411]: https://github.com/actix/actix-net/pull/411 +- Add `System::run_with_code` to allow retrieving the exit code on stop. ## 2.4.0 -- Add `Arbiter::try_current` for situations where thread may or may not have Arbiter context. [#408] -- Start io-uring with `System::new` when feature is enabled. [#395] - -[#395]: https://github.com/actix/actix-net/pull/395 -[#408]: https://github.com/actix/actix-net/pull/408 +- Add `Arbiter::try_current` for situations where thread may or may not have Arbiter context. +- Start io-uring with `System::new` when feature is enabled. ## 2.3.0 -- The `spawn` method can now resolve with non-unit outputs. [#369] -- Add experimental (semver-exempt) `io-uring` feature for enabling async file I/O on linux. [#374] - -[#369]: https://github.com/actix/actix-net/pull/369 -[#374]: https://github.com/actix/actix-net/pull/374 +- The `spawn` method can now resolve with non-unit outputs. +- Add experimental (semver-exempt) `io-uring` feature for enabling async file I/O on linux. ## 2.2.0 -- **BREAKING** `ActixStream::{poll_read_ready, poll_write_ready}` methods now return `Ready` object in ok variant. [#293] +- **BREAKING** `ActixStream::{poll_read_ready, poll_write_ready}` methods now return `Ready` object in ok variant. - Breakage is acceptable since `ActixStream` was not intended to be public. -[#293]: https://github.com/actix/actix-net/pull/293 - ## 2.1.0 -- Add `ActixStream` extension trait to include readiness methods. [#276] -- Re-export `tokio::net::TcpSocket` in `net` module [#282] - -[#276]: https://github.com/actix/actix-net/pull/276 -[#282]: https://github.com/actix/actix-net/pull/282 +- Add `ActixStream` extension trait to include readiness methods. +- Re-export `tokio::net::TcpSocket` in `net` module ## 2.0.2 -- Add `Arbiter::handle` to get a handle of an owned Arbiter. [#274] -- Add `System::try_current` for situations where actix may or may not be running a System. [#275] - -[#274]: https://github.com/actix/actix-net/pull/274 -[#275]: https://github.com/actix/actix-net/pull/275 +- Add `Arbiter::handle` to get a handle of an owned Arbiter. +- Add `System::try_current` for situations where actix may or may not be running a System. ## 2.0.1 -- Expose `JoinError` from Tokio. [#271] - -[#271]: https://github.com/actix/actix-net/pull/271 +- Expose `JoinError` from Tokio. ## 2.0.0 -- Remove all Arbiter-local storage methods. [#262] -- Re-export `tokio::pin`. [#262] - -[#262]: https://github.com/actix/actix-net/pull/262 +- Remove all Arbiter-local storage methods. +- Re-export `tokio::pin`. ## 2.0.0-beta.3 -- Remove `run_in_tokio`, `attach_to_tokio` and `AsyncSystemRunner`. [#253] -- Return `JoinHandle` from `actix_rt::spawn`. [#253] -- Remove old `Arbiter::spawn`. Implementation is now inlined into `actix_rt::spawn`. [#253] -- Rename `Arbiter::{send => spawn}` and `Arbiter::{exec_fn => spawn_fn}`. [#253] -- Remove `Arbiter::exec`. [#253] -- Remove deprecated `Arbiter::local_join` and `Arbiter::is_running`. [#253] -- `Arbiter::spawn` now accepts !Unpin futures. [#256] -- `System::new` no longer takes arguments. [#257] -- Remove `System::with_current`. [#257] -- Remove `Builder`. [#257] -- Add `System::with_init` as replacement for `Builder::run`. [#257] -- Rename `System::{is_set => is_registered}`. [#257] -- Add `ArbiterHandle` for sending messages to non-current-thread arbiters. [#257]. -- `System::arbiter` now returns an `&ArbiterHandle`. [#257] -- `Arbiter::current` now returns an `ArbiterHandle` instead. [#257] -- `Arbiter::join` now takes self by value. [#257] - -[#253]: https://github.com/actix/actix-net/pull/253 -[#254]: https://github.com/actix/actix-net/pull/254 -[#256]: https://github.com/actix/actix-net/pull/256 -[#257]: https://github.com/actix/actix-net/pull/257 +- Remove `run_in_tokio`, `attach_to_tokio` and `AsyncSystemRunner`. +- Return `JoinHandle` from `actix_rt::spawn`. +- Remove old `Arbiter::spawn`. Implementation is now inlined into `actix_rt::spawn`. +- Rename `Arbiter::{send => spawn}` and `Arbiter::{exec_fn => spawn_fn}`. +- Remove `Arbiter::exec`. +- Remove deprecated `Arbiter::local_join` and `Arbiter::is_running`. +- `Arbiter::spawn` now accepts !Unpin futures. +- `System::new` no longer takes arguments. +- Remove `System::with_current`. +- Remove `Builder`. +- Add `System::with_init` as replacement for `Builder::run`. +- Rename `System::{is_set => is_registered}`. +- Add `ArbiterHandle` for sending messages to non-current-thread arbiters. +- `System::arbiter` now returns an `&ArbiterHandle`. +- `Arbiter::current` now returns an `ArbiterHandle` instead. +- `Arbiter::join` now takes self by value. ## 2.0.0-beta.2 -- Add `task` mod with re-export of `tokio::task::{spawn_blocking, yield_now, JoinHandle}` [#245] +- Add `task` mod with re-export of `tokio::task::{spawn_blocking, yield_now, JoinHandle}` - Add default "macros" feature to allow faster compile times when using `default-features=false`. -[#245]: https://github.com/actix/actix-net/pull/245 - ## 2.0.0-beta.1 -- Add `System::attach_to_tokio` method. [#173] -- Update `tokio` dependency to `1.0`. [#236] -- Rename `time` module `delay_for` to `sleep`, `delay_until` to `sleep_until`, `Delay` to `Sleep` to stay aligned with Tokio's naming. [#236] +- Add `System::attach_to_tokio` method. +- Update `tokio` dependency to `1.0`. +- Rename `time` module `delay_for` to `sleep`, `delay_until` to `sleep_until`, `Delay` to `Sleep` to stay aligned with Tokio's naming. - Remove `'static` lifetime requirement for `Runtime::block_on` and `SystemRunner::block_on`. - - These methods now accept `&self` when calling. [#236] -- Remove `'static` lifetime requirement for `System::run` and `Builder::run`. [#236] -- `Arbiter::spawn` now panics when `System` is not in scope. [#207] -- Fix work load issue by removing `PENDING` thread local. [#207] - -[#207]: https://github.com/actix/actix-net/pull/207 -[#236]: https://github.com/actix/actix-net/pull/236 + - These methods now accept `&self` when calling. +- Remove `'static` lifetime requirement for `System::run` and `Builder::run`. +- `Arbiter::spawn` now panics when `System` is not in scope. +- Fix work load issue by removing `PENDING` thread local. ## 1.1.1 -- Fix memory leak due to [#94] (see [#129] for more detail) - -[#129]: https://github.com/actix/actix-net/issues/129 +- Fix memory leak due to ## 1.1.0 _(YANKED)_ -- Expose `System::is_set` to check if current system has ben started [#99] -- Add `Arbiter::is_running` to check if event loop is running [#124] -- Add `Arbiter::local_join` associated function to get be able to `await` for spawned futures [#94] - -[#94]: https://github.com/actix/actix-net/pull/94 -[#99]: https://github.com/actix/actix-net/pull/99 -[#124]: https://github.com/actix/actix-net/pull/124 +- Expose `System::is_set` to check if current system has ben started +- Add `Arbiter::is_running` to check if event loop is running +- Add `Arbiter::local_join` associated function to get be able to `await` for spawned futures ## 1.0.0 diff --git a/actix-server/CHANGES.md b/actix-server/CHANGES.md index 9150031e..4a0dd3d6 100644 --- a/actix-server/CHANGES.md +++ b/actix-server/CHANGES.md @@ -10,9 +10,7 @@ ## 2.2.0 - Minimum supported Rust version (MSRV) is now 1.59. -- Update `tokio-uring` dependency to `0.4`. [#473] - -[#473]: https://github.com/actix/actix-net/pull/473 +- Update `tokio-uring` dependency to `0.4`. ## 2.1.1 @@ -20,12 +18,9 @@ ## 2.1.0 -- Update `tokio-uring` dependency to `0.3`. [#448] -- Logs emitted now use the `tracing` crate with `log` compatibility. [#448] -- Wait for accept thread to stop before sending completion signal. [#443] - -[#443]: https://github.com/actix/actix-net/pull/443 -[#448]: https://github.com/actix/actix-net/pull/448 +- Update `tokio-uring` dependency to `0.3`. +- Logs emitted now use the `tracing` crate with `log` compatibility. +- Wait for accept thread to stop before sending completion signal. ## 2.0.0 @@ -33,9 +28,7 @@ ## 2.0.0-rc.4 -- Update `tokio-uring` dependency to `0.2`. [#436] - -[#436]: https://github.com/actix/actix-net/pull/436 +- Update `tokio-uring` dependency to `0.2`. ## 2.0.0-rc.3 @@ -43,117 +36,80 @@ ## 2.0.0-rc.2 -- Simplify `TestServer`. [#431] - -[#431]: https://github.com/actix/actix-net/pull/431 +- Simplify `TestServer`. ## 2.0.0-rc.1 -- Hide implementation details of `Server`. [#424] -- `Server` now runs only after awaiting it. [#425] - -[#424]: https://github.com/actix/actix-net/pull/424 -[#425]: https://github.com/actix/actix-net/pull/425 +- Hide implementation details of `Server`. +- `Server` now runs only after awaiting it. ## 2.0.0-beta.9 -- Restore `Arbiter` support lost in `beta.8`. [#417] - -[#417]: https://github.com/actix/actix-net/pull/417 +- Restore `Arbiter` support lost in `beta.8`. ## 2.0.0-beta.8 -- Fix non-unix signal handler. [#410] - -[#410]: https://github.com/actix/actix-net/pull/410 +- Fix non-unix signal handler. ## 2.0.0-beta.7 -- Server can be started in regular Tokio runtime. [#408] -- Expose new `Server` type whose `Future` impl resolves when server stops. [#408] -- Rename `Server` to `ServerHandle`. [#407] -- Add `Server::handle` to obtain handle to server. [#408] -- Rename `ServerBuilder::{maxconn => max_concurrent_connections}`. [#407] -- Deprecate crate-level `new` shortcut for server builder. [#408] +- Server can be started in regular Tokio runtime. +- Expose new `Server` type whose `Future` impl resolves when server stops. +- Rename `Server` to `ServerHandle`. +- Add `Server::handle` to obtain handle to server. +- Rename `ServerBuilder::{maxconn => max_concurrent_connections}`. +- Deprecate crate-level `new` shortcut for server builder. - Minimum supported Rust version (MSRV) is now 1.52. -[#407]: https://github.com/actix/actix-net/pull/407 -[#408]: https://github.com/actix/actix-net/pull/408 - ## 2.0.0-beta.6 -- Add experimental (semver-exempt) `io-uring` feature for enabling async file I/O on linux. [#374] -- Server no long listens to `SIGHUP` signal. Previously, the received was not used but did block subsequent exit signals from working. [#389] -- Remove `config` module. `ServiceConfig`, `ServiceRuntime` public types are removed due to this change. [#349] -- Remove `ServerBuilder::configure` [#349] - -[#374]: https://github.com/actix/actix-net/pull/374 -[#349]: https://github.com/actix/actix-net/pull/349 -[#389]: https://github.com/actix/actix-net/pull/389 +- Add experimental (semver-exempt) `io-uring` feature for enabling async file I/O on linux. +- Server no long listens to `SIGHUP` signal. Previously, the received was not used but did block subsequent exit signals from working. +- Remove `config` module. `ServiceConfig`, `ServiceRuntime` public types are removed due to this change. +- Remove `ServerBuilder::configure`. ## 2.0.0-beta.5 -- Server shutdown notifies all workers to exit regardless if shutdown is graceful. This causes all workers to shutdown immediately in force shutdown case. [#333] - -[#333]: https://github.com/actix/actix-net/pull/333 +- Server shutdown notifies all workers to exit regardless if shutdown is graceful. This causes all workers to shutdown immediately in force shutdown case. ## 2.0.0-beta.4 - Prevent panic when `shutdown_timeout` is very large. [f9262db] -[f9262db]: https://github.com/actix/actix-net/commit/f9262db - ## 2.0.0-beta.3 -- Hidden `ServerBuilder::start` method has been removed. Use `ServerBuilder::run`. [#246] -- Add retry for EINTR signal (`io::Interrupted`) in `Accept`'s poll loop. [#264] -- Add `ServerBuilder::worker_max_blocking_threads` to customize blocking thread pool size. [#265] -- Update `actix-rt` to `2.0.0`. [#273] - -[#246]: https://github.com/actix/actix-net/pull/246 -[#264]: https://github.com/actix/actix-net/pull/264 -[#265]: https://github.com/actix/actix-net/pull/265 -[#273]: https://github.com/actix/actix-net/pull/273 +- Hidden `ServerBuilder::start` method has been removed. Use `ServerBuilder::run`. +- Add retry for EINTR signal (`io::Interrupted`) in `Accept`'s poll loop. +- Add `ServerBuilder::worker_max_blocking_threads` to customize blocking thread pool size. +- Update `actix-rt` to `2.0.0`. ## 2.0.0-beta.2 -- Merge `actix-testing` to `actix-server` as `test_server` mod. [#242] - -[#242]: https://github.com/actix/actix-net/pull/242 +- Merge `actix-testing` to `actix-server` as `test_server` mod. ## 2.0.0-beta.1 -- Added explicit info log message on accept queue pause. [#215] -- Prevent double registration of sockets when back-pressure is resolved. [#223] -- Update `mio` dependency to `0.7.3`. [#239] -- Remove `socket2` dependency. [#239] -- `ServerBuilder::backlog` now accepts `u32` instead of `i32`. [#239] -- Remove `AcceptNotify` type and pass `WakerQueue` to `Worker` to wake up `Accept`'s `Poll`. [#239] -- Convert `mio::net::TcpStream` to `actix_rt::net::TcpStream`(`UnixStream` for uds) using `FromRawFd` and `IntoRawFd`(`FromRawSocket` and `IntoRawSocket` on windows). [#239] -- Remove `AsyncRead` and `AsyncWrite` trait bound for `socket::FromStream` trait. [#239] - -[#215]: https://github.com/actix/actix-net/pull/215 -[#223]: https://github.com/actix/actix-net/pull/223 -[#239]: https://github.com/actix/actix-net/pull/239 +- Added explicit info log message on accept queue pause. +- Prevent double registration of sockets when back-pressure is resolved. +- Update `mio` dependency to `0.7.3`. +- Remove `socket2` dependency. +- `ServerBuilder::backlog` now accepts `u32` instead of `i32`. +- Remove `AcceptNotify` type and pass `WakerQueue` to `Worker` to wake up `Accept`'s `Poll`. +- Convert `mio::net::TcpStream` to `actix_rt::net::TcpStream`(`UnixStream` for uds) using `FromRawFd` and `IntoRawFd`(`FromRawSocket` and `IntoRawSocket` on windows). +- Remove `AsyncRead` and `AsyncWrite` trait bound for `socket::FromStream` trait. ## 1.0.4 - Update actix-codec to 0.3.0. -- Workers must be greater than 0. [#167] - -[#167]: https://github.com/actix/actix-net/pull/167 +- Workers must be greater than 0. ## 1.0.3 -- Replace deprecated `net2` crate with `socket2` [#140] - -[#140]: https://github.com/actix/actix-net/pull/140 +- Replace deprecated `net2` crate with `socket2`. ## 1.0.2 -- Avoid error by calling `reregister()` on Windows [#103] - -[#103]: https://github.com/actix/actix-net/pull/103 +- Avoid error by calling `reregister()` on Windows. ## 1.0.1