Skip to content

Commit a1ae524

Browse files
robjtederobjtede
committed
docs: clean changelog
1 parent 8883335 commit a1ae524

File tree

2 files changed

+83
-172
lines changed

2 files changed

+83
-172
lines changed

‎actix-rt/CHANGES.md

Lines changed: 46 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -10,150 +10,105 @@
1010

1111
## 2.8.0
1212

13-
- Add `#[track_caller]` attribute to `spawn` functions and methods. [#454]
14-
- Update `tokio-uring` dependency to `0.4`. [#473]
13+
- Add `#[track_caller]` attribute to `spawn` functions and methods.
14+
- Update `tokio-uring` dependency to `0.4`.
1515
- Minimum supported Rust version (MSRV) is now 1.59.
1616

17-
[#454]: https://github.com/actix/actix-net/pull/454
18-
[#473]: https://github.com/actix/actix-net/pull/473
19-
2017
## 2.7.0
2118

22-
- Update `tokio-uring` dependency to `0.3`. [#448]
19+
- Update `tokio-uring` dependency to `0.3`.
2320
- Minimum supported Rust version (MSRV) is now 1.49.
2421

25-
[#448]: https://github.com/actix/actix-net/pull/448
26-
2722
## 2.6.0
2823

29-
- Update `tokio-uring` dependency to `0.2`. [#436]
30-
31-
[#436]: https://github.com/actix/actix-net/pull/436
24+
- Update `tokio-uring` dependency to `0.2`.
3225

3326
## 2.5.1
3427

35-
- Expose `System::with_tokio_rt` and `Arbiter::with_tokio_rt`. [#430]
36-
37-
[#430]: https://github.com/actix/actix-net/pull/430
28+
- Expose `System::with_tokio_rt` and `Arbiter::with_tokio_rt`.
3829

3930
## 2.5.0
4031

41-
- Add `System::run_with_code` to allow retrieving the exit code on stop. [#411]
42-
43-
[#411]: https://github.com/actix/actix-net/pull/411
32+
- Add `System::run_with_code` to allow retrieving the exit code on stop.
4433

4534
## 2.4.0
4635

47-
- Add `Arbiter::try_current` for situations where thread may or may not have Arbiter context. [#408]
48-
- Start io-uring with `System::new` when feature is enabled. [#395]
49-
50-
[#395]: https://github.com/actix/actix-net/pull/395
51-
[#408]: https://github.com/actix/actix-net/pull/408
36+
- Add `Arbiter::try_current` for situations where thread may or may not have Arbiter context.
37+
- Start io-uring with `System::new` when feature is enabled.
5238

5339
## 2.3.0
5440

55-
- The `spawn` method can now resolve with non-unit outputs. [#369]
56-
- Add experimental (semver-exempt) `io-uring` feature for enabling async file I/O on linux. [#374]
57-
58-
[#369]: https://github.com/actix/actix-net/pull/369
59-
[#374]: https://github.com/actix/actix-net/pull/374
41+
- The `spawn` method can now resolve with non-unit outputs.
42+
- Add experimental (semver-exempt) `io-uring` feature for enabling async file I/O on linux.
6043

6144
## 2.2.0
6245

63-
- **BREAKING** `ActixStream::{poll_read_ready, poll_write_ready}` methods now return `Ready` object in ok variant. [#293]
46+
- **BREAKING** `ActixStream::{poll_read_ready, poll_write_ready}` methods now return `Ready` object in ok variant.
6447
- Breakage is acceptable since `ActixStream` was not intended to be public.
6548

66-
[#293]: https://github.com/actix/actix-net/pull/293
67-
6849
## 2.1.0
6950

70-
- Add `ActixStream` extension trait to include readiness methods. [#276]
71-
- Re-export `tokio::net::TcpSocket` in `net` module [#282]
72-
73-
[#276]: https://github.com/actix/actix-net/pull/276
74-
[#282]: https://github.com/actix/actix-net/pull/282
51+
- Add `ActixStream` extension trait to include readiness methods.
52+
- Re-export `tokio::net::TcpSocket` in `net` module
7553

7654
## 2.0.2
7755

78-
- Add `Arbiter::handle` to get a handle of an owned Arbiter. [#274]
79-
- Add `System::try_current` for situations where actix may or may not be running a System. [#275]
80-
81-
[#274]: https://github.com/actix/actix-net/pull/274
82-
[#275]: https://github.com/actix/actix-net/pull/275
56+
- Add `Arbiter::handle` to get a handle of an owned Arbiter.
57+
- Add `System::try_current` for situations where actix may or may not be running a System.
8358

8459
## 2.0.1
8560

86-
- Expose `JoinError` from Tokio. [#271]
87-
88-
[#271]: https://github.com/actix/actix-net/pull/271
61+
- Expose `JoinError` from Tokio.
8962

9063
## 2.0.0
9164

92-
- Remove all Arbiter-local storage methods. [#262]
93-
- Re-export `tokio::pin`. [#262]
94-
95-
[#262]: https://github.com/actix/actix-net/pull/262
65+
- Remove all Arbiter-local storage methods.
66+
- Re-export `tokio::pin`.
9667

9768
## 2.0.0-beta.3
9869

99-
- Remove `run_in_tokio`, `attach_to_tokio` and `AsyncSystemRunner`. [#253]
100-
- Return `JoinHandle` from `actix_rt::spawn`. [#253]
101-
- Remove old `Arbiter::spawn`. Implementation is now inlined into `actix_rt::spawn`. [#253]
102-
- Rename `Arbiter::{send => spawn}` and `Arbiter::{exec_fn => spawn_fn}`. [#253]
103-
- Remove `Arbiter::exec`. [#253]
104-
- Remove deprecated `Arbiter::local_join` and `Arbiter::is_running`. [#253]
105-
- `Arbiter::spawn` now accepts !Unpin futures. [#256]
106-
- `System::new` no longer takes arguments. [#257]
107-
- Remove `System::with_current`. [#257]
108-
- Remove `Builder`. [#257]
109-
- Add `System::with_init` as replacement for `Builder::run`. [#257]
110-
- Rename `System::{is_set => is_registered}`. [#257]
111-
- Add `ArbiterHandle` for sending messages to non-current-thread arbiters. [#257].
112-
- `System::arbiter` now returns an `&ArbiterHandle`. [#257]
113-
- `Arbiter::current` now returns an `ArbiterHandle` instead. [#257]
114-
- `Arbiter::join` now takes self by value. [#257]
115-
116-
[#253]: https://github.com/actix/actix-net/pull/253
117-
[#254]: https://github.com/actix/actix-net/pull/254
118-
[#256]: https://github.com/actix/actix-net/pull/256
119-
[#257]: https://github.com/actix/actix-net/pull/257
70+
- Remove `run_in_tokio`, `attach_to_tokio` and `AsyncSystemRunner`.
71+
- Return `JoinHandle` from `actix_rt::spawn`.
72+
- Remove old `Arbiter::spawn`. Implementation is now inlined into `actix_rt::spawn`.
73+
- Rename `Arbiter::{send => spawn}` and `Arbiter::{exec_fn => spawn_fn}`.
74+
- Remove `Arbiter::exec`.
75+
- Remove deprecated `Arbiter::local_join` and `Arbiter::is_running`.
76+
- `Arbiter::spawn` now accepts !Unpin futures.
77+
- `System::new` no longer takes arguments.
78+
- Remove `System::with_current`.
79+
- Remove `Builder`.
80+
- Add `System::with_init` as replacement for `Builder::run`.
81+
- Rename `System::{is_set => is_registered}`.
82+
- Add `ArbiterHandle` for sending messages to non-current-thread arbiters.
83+
- `System::arbiter` now returns an `&ArbiterHandle`.
84+
- `Arbiter::current` now returns an `ArbiterHandle` instead.
85+
- `Arbiter::join` now takes self by value.
12086

12187
## 2.0.0-beta.2
12288

123-
- Add `task` mod with re-export of `tokio::task::{spawn_blocking, yield_now, JoinHandle}` [#245]
89+
- Add `task` mod with re-export of `tokio::task::{spawn_blocking, yield_now, JoinHandle}`
12490
- Add default "macros" feature to allow faster compile times when using `default-features=false`.
12591

126-
[#245]: https://github.com/actix/actix-net/pull/245
127-
12892
## 2.0.0-beta.1
12993

130-
- Add `System::attach_to_tokio` method. [#173]
131-
- Update `tokio` dependency to `1.0`. [#236]
132-
- Rename `time` module `delay_for` to `sleep`, `delay_until` to `sleep_until`, `Delay` to `Sleep` to stay aligned with Tokio's naming. [#236]
94+
- Add `System::attach_to_tokio` method.
95+
- Update `tokio` dependency to `1.0`.
96+
- Rename `time` module `delay_for` to `sleep`, `delay_until` to `sleep_until`, `Delay` to `Sleep` to stay aligned with Tokio's naming.
13397
- Remove `'static` lifetime requirement for `Runtime::block_on` and `SystemRunner::block_on`.
134-
- These methods now accept `&self` when calling. [#236]
135-
- Remove `'static` lifetime requirement for `System::run` and `Builder::run`. [#236]
136-
- `Arbiter::spawn` now panics when `System` is not in scope. [#207]
137-
- Fix work load issue by removing `PENDING` thread local. [#207]
138-
139-
[#207]: https://github.com/actix/actix-net/pull/207
140-
[#236]: https://github.com/actix/actix-net/pull/236
98+
- These methods now accept `&self` when calling.
99+
- Remove `'static` lifetime requirement for `System::run` and `Builder::run`.
100+
- `Arbiter::spawn` now panics when `System` is not in scope.
101+
- Fix work load issue by removing `PENDING` thread local.
141102

142103
## 1.1.1
143104

144-
- Fix memory leak due to [#94] (see [#129] for more detail)
145-
146-
[#129]: https://github.com/actix/actix-net/issues/129
105+
- Fix memory leak due to
147106

148107
## 1.1.0 _(YANKED)_
149108

150-
- Expose `System::is_set` to check if current system has ben started [#99]
151-
- Add `Arbiter::is_running` to check if event loop is running [#124]
152-
- Add `Arbiter::local_join` associated function to get be able to `await` for spawned futures [#94]
153-
154-
[#94]: https://github.com/actix/actix-net/pull/94
155-
[#99]: https://github.com/actix/actix-net/pull/99
156-
[#124]: https://github.com/actix/actix-net/pull/124
109+
- Expose `System::is_set` to check if current system has ben started
110+
- Add `Arbiter::is_running` to check if event loop is running
111+
- Add `Arbiter::local_join` associated function to get be able to `await` for spawned futures
157112

158113
## 1.0.0
159114

‎actix-server/CHANGES.md

Lines changed: 37 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -10,150 +10,106 @@
1010
## 2.2.0
1111

1212
- Minimum supported Rust version (MSRV) is now 1.59.
13-
- Update `tokio-uring` dependency to `0.4`. [#473]
14-
15-
[#473]: https://github.com/actix/actix-net/pull/473
13+
- Update `tokio-uring` dependency to `0.4`.
1614

1715
## 2.1.1
1816

1917
- No significant changes since `2.1.0`.
2018

2119
## 2.1.0
2220

23-
- Update `tokio-uring` dependency to `0.3`. [#448]
24-
- Logs emitted now use the `tracing` crate with `log` compatibility. [#448]
25-
- Wait for accept thread to stop before sending completion signal. [#443]
26-
27-
[#443]: https://github.com/actix/actix-net/pull/443
28-
[#448]: https://github.com/actix/actix-net/pull/448
21+
- Update `tokio-uring` dependency to `0.3`.
22+
- Logs emitted now use the `tracing` crate with `log` compatibility.
23+
- Wait for accept thread to stop before sending completion signal.
2924

3025
## 2.0.0
3126

3227
- No significant changes since `2.0.0-rc.4`.
3328

3429
## 2.0.0-rc.4
3530

36-
- Update `tokio-uring` dependency to `0.2`. [#436]
37-
38-
[#436]: https://github.com/actix/actix-net/pull/436
31+
- Update `tokio-uring` dependency to `0.2`.
3932

4033
## 2.0.0-rc.3
4134

4235
- No significant changes since `2.0.0-rc.2`.
4336

4437
## 2.0.0-rc.2
4538

46-
- Simplify `TestServer`. [#431]
47-
48-
[#431]: https://github.com/actix/actix-net/pull/431
39+
- Simplify `TestServer`.
4940

5041
## 2.0.0-rc.1
5142

52-
- Hide implementation details of `Server`. [#424]
53-
- `Server` now runs only after awaiting it. [#425]
54-
55-
[#424]: https://github.com/actix/actix-net/pull/424
56-
[#425]: https://github.com/actix/actix-net/pull/425
43+
- Hide implementation details of `Server`.
44+
- `Server` now runs only after awaiting it.
5745

5846
## 2.0.0-beta.9
5947

60-
- Restore `Arbiter` support lost in `beta.8`. [#417]
61-
62-
[#417]: https://github.com/actix/actix-net/pull/417
48+
- Restore `Arbiter` support lost in `beta.8`.
6349

6450
## 2.0.0-beta.8
6551

66-
- Fix non-unix signal handler. [#410]
67-
68-
[#410]: https://github.com/actix/actix-net/pull/410
52+
- Fix non-unix signal handler.
6953

7054
## 2.0.0-beta.7
7155

72-
- Server can be started in regular Tokio runtime. [#408]
73-
- Expose new `Server` type whose `Future` impl resolves when server stops. [#408]
74-
- Rename `Server` to `ServerHandle`. [#407]
75-
- Add `Server::handle` to obtain handle to server. [#408]
76-
- Rename `ServerBuilder::{maxconn => max_concurrent_connections}`. [#407]
77-
- Deprecate crate-level `new` shortcut for server builder. [#408]
56+
- Server can be started in regular Tokio runtime.
57+
- Expose new `Server` type whose `Future` impl resolves when server stops.
58+
- Rename `Server` to `ServerHandle`.
59+
- Add `Server::handle` to obtain handle to server.
60+
- Rename `ServerBuilder::{maxconn => max_concurrent_connections}`.
61+
- Deprecate crate-level `new` shortcut for server builder.
7862
- Minimum supported Rust version (MSRV) is now 1.52.
7963

80-
[#407]: https://github.com/actix/actix-net/pull/407
81-
[#408]: https://github.com/actix/actix-net/pull/408
82-
8364
## 2.0.0-beta.6
8465

85-
- Add experimental (semver-exempt) `io-uring` feature for enabling async file I/O on linux. [#374]
86-
- Server no long listens to `SIGHUP` signal. Previously, the received was not used but did block subsequent exit signals from working. [#389]
87-
- Remove `config` module. `ServiceConfig`, `ServiceRuntime` public types are removed due to this change. [#349]
88-
- Remove `ServerBuilder::configure` [#349]
89-
90-
[#374]: https://github.com/actix/actix-net/pull/374
91-
[#349]: https://github.com/actix/actix-net/pull/349
92-
[#389]: https://github.com/actix/actix-net/pull/389
66+
- Add experimental (semver-exempt) `io-uring` feature for enabling async file I/O on linux.
67+
- Server no long listens to `SIGHUP` signal. Previously, the received was not used but did block subsequent exit signals from working.
68+
- Remove `config` module. `ServiceConfig`, `ServiceRuntime` public types are removed due to this change.
69+
- Remove `ServerBuilder::configure`.
9370

9471
## 2.0.0-beta.5
9572

96-
- Server shutdown notifies all workers to exit regardless if shutdown is graceful. This causes all workers to shutdown immediately in force shutdown case. [#333]
97-
98-
[#333]: https://github.com/actix/actix-net/pull/333
73+
- Server shutdown notifies all workers to exit regardless if shutdown is graceful. This causes all workers to shutdown immediately in force shutdown case.
9974

10075
## 2.0.0-beta.4
10176

10277
- Prevent panic when `shutdown_timeout` is very large. [f9262db]
10378

104-
[f9262db]: https://github.com/actix/actix-net/commit/f9262db
105-
10679
## 2.0.0-beta.3
10780

108-
- Hidden `ServerBuilder::start` method has been removed. Use `ServerBuilder::run`. [#246]
109-
- Add retry for EINTR signal (`io::Interrupted`) in `Accept`'s poll loop. [#264]
110-
- Add `ServerBuilder::worker_max_blocking_threads` to customize blocking thread pool size. [#265]
111-
- Update `actix-rt` to `2.0.0`. [#273]
112-
113-
[#246]: https://github.com/actix/actix-net/pull/246
114-
[#264]: https://github.com/actix/actix-net/pull/264
115-
[#265]: https://github.com/actix/actix-net/pull/265
116-
[#273]: https://github.com/actix/actix-net/pull/273
81+
- Hidden `ServerBuilder::start` method has been removed. Use `ServerBuilder::run`.
82+
- Add retry for EINTR signal (`io::Interrupted`) in `Accept`'s poll loop.
83+
- Add `ServerBuilder::worker_max_blocking_threads` to customize blocking thread pool size.
84+
- Update `actix-rt` to `2.0.0`.
11785

11886
## 2.0.0-beta.2
11987

120-
- Merge `actix-testing` to `actix-server` as `test_server` mod. [#242]
121-
122-
[#242]: https://github.com/actix/actix-net/pull/242
88+
- Merge `actix-testing` to `actix-server` as `test_server` mod.
12389

12490
## 2.0.0-beta.1
12591

126-
- Added explicit info log message on accept queue pause. [#215]
127-
- Prevent double registration of sockets when back-pressure is resolved. [#223]
128-
- Update `mio` dependency to `0.7.3`. [#239]
129-
- Remove `socket2` dependency. [#239]
130-
- `ServerBuilder::backlog` now accepts `u32` instead of `i32`. [#239]
131-
- Remove `AcceptNotify` type and pass `WakerQueue` to `Worker` to wake up `Accept`'s `Poll`. [#239]
132-
- Convert `mio::net::TcpStream` to `actix_rt::net::TcpStream`(`UnixStream` for uds) using `FromRawFd` and `IntoRawFd`(`FromRawSocket` and `IntoRawSocket` on windows). [#239]
133-
- Remove `AsyncRead` and `AsyncWrite` trait bound for `socket::FromStream` trait. [#239]
134-
135-
[#215]: https://github.com/actix/actix-net/pull/215
136-
[#223]: https://github.com/actix/actix-net/pull/223
137-
[#239]: https://github.com/actix/actix-net/pull/239
92+
- Added explicit info log message on accept queue pause.
93+
- Prevent double registration of sockets when back-pressure is resolved.
94+
- Update `mio` dependency to `0.7.3`.
95+
- Remove `socket2` dependency.
96+
- `ServerBuilder::backlog` now accepts `u32` instead of `i32`.
97+
- Remove `AcceptNotify` type and pass `WakerQueue` to `Worker` to wake up `Accept`'s `Poll`.
98+
- Convert `mio::net::TcpStream` to `actix_rt::net::TcpStream`(`UnixStream` for uds) using `FromRawFd` and `IntoRawFd`(`FromRawSocket` and `IntoRawSocket` on windows).
99+
- Remove `AsyncRead` and `AsyncWrite` trait bound for `socket::FromStream` trait.
138100

139101
## 1.0.4
140102

141103
- Update actix-codec to 0.3.0.
142-
- Workers must be greater than 0. [#167]
143-
144-
[#167]: https://github.com/actix/actix-net/pull/167
104+
- Workers must be greater than 0.
145105

146106
## 1.0.3
147107

148-
- Replace deprecated `net2` crate with `socket2` [#140]
149-
150-
[#140]: https://github.com/actix/actix-net/pull/140
108+
- Replace deprecated `net2` crate with `socket2`.
151109

152110
## 1.0.2
153111

154-
- Avoid error by calling `reregister()` on Windows [#103]
155-
156-
[#103]: https://github.com/actix/actix-net/pull/103
112+
- Avoid error by calling `reregister()` on Windows.
157113

158114
## 1.0.1
159115

0 commit comments

Comments
 (0)