Skip to content

Commit 061218a

Browse files
committed
Doc: add change-log 0.9.6
1 parent 14d42e4 commit 061218a

File tree

2 files changed

+179
-0
lines changed

2 files changed

+179
-0
lines changed

change-log.md

+91
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,94 @@
1+
## v0.9.6
2+
3+
Summary:
4+
5+
- Added:
6+
- [5776139d](https://github.com/datafuselabs/openraft/commit/5776139d8ac15d94a800d1e0cf073dea5a7b216e) Add `#[since(version="1.0")]` to specify first version of a feature.
7+
- [b172dc8e](https://github.com/datafuselabs/openraft/commit/b172dc8e261f4f2b1149c3ada70524cdf520d5b3) Add macro `expand!()` to expand a template.
8+
- Improved:
9+
- [99596c75](https://github.com/datafuselabs/openraft/commit/99596c754e19792b97737105acea257d70d1d6b6) `declare_raft_types` allows the types in any order.
10+
- Fixed:
11+
- [14d42e4f](https://github.com/datafuselabs/openraft/commit/14d42e4f33581dc0ea9c4eeaf0ff00ebec85dbb2) Load mebmership since `last_applied`, not `last_membership.index` on startup.
12+
13+
Detail:
14+
15+
### Added:
16+
17+
- Added: [5776139d](https://github.com/datafuselabs/openraft/commit/5776139d8ac15d94a800d1e0cf073dea5a7b216e) Add `#[since(version="1.0")]` to specify first version of a feature; by 张炎泼; 2024-04-12
18+
19+
`#[since(version = "1.0.0")]` adds a doc line `/// Since: Version(1.0.0)`.
20+
21+
Example:
22+
23+
```rust,ignore
24+
/// Foo function
25+
///
26+
/// Does something.
27+
#[since(version = "1.0.0")]
28+
fn foo() {}
29+
```
30+
31+
The above code will be transformed into:
32+
33+
```rust,ignore
34+
/// Foo function
35+
///
36+
/// Does something.
37+
///
38+
/// Since: Version(1.0.0)
39+
fn foo() {}
40+
```
41+
42+
- Added: [b172dc8e](https://github.com/datafuselabs/openraft/commit/b172dc8e261f4f2b1149c3ada70524cdf520d5b3) Add macro `expand!()` to expand a template; by 张炎泼; 2024-04-13
43+
44+
`expand!()` renders a template with arguments multiple times.
45+
46+
### Example:
47+
48+
```rust,ignore
49+
expand!(KEYED, // ignore duplicate by `K`
50+
(K, T, V) => {let K: T = V;},
51+
(a, u64, 1),
52+
(a, u32, 2), // duplicate `a` will be ignored
53+
(c, Vec<u8>, vec![1,2])
54+
);
55+
```
56+
57+
The above code will be transformed into:
58+
59+
```rust,ignore
60+
let a: u64 = 1;
61+
let c: Vec<u8> = vec![1, 2];
62+
```
63+
64+
### Improved:
65+
66+
- Improved: [99596c75](https://github.com/datafuselabs/openraft/commit/99596c754e19792b97737105acea257d70d1d6b6) `declare_raft_types` allows the types in any order; by 张炎泼; 2024-04-13
67+
68+
By rewriting the template expanding part with a `#[proc_macro]`
69+
`expand!()` defined in `openraft_macros`, `declare_raft_types`
70+
does not require the types in fixed order:
71+
72+
Example:
73+
74+
```
75+
declare_raft_types!(All:
76+
D = (),
77+
NodeId = u64,
78+
R = (),
79+
Node = (),
80+
```
81+
82+
### Fixed:
83+
84+
- Fixed: [14d42e4f](https://github.com/datafuselabs/openraft/commit/14d42e4f33581dc0ea9c4eeaf0ff00ebec85dbb2) Load mebmership since `last_applied`, not `last_membership.index` on startup; by 张炎泼; 2024-04-25
85+
86+
Modify `StorageHelper::last_membership_in_log()` to scan the log
87+
starting from the last applied index rather than the index of the last
88+
applied membership log. This change reduces unnecessary I/O operations
89+
during startup, previously caused by scanning from an incorrect starting
90+
point.
91+
192
## v0.9.5
293
394
Summary:

change-log/v0.9.6.md

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
Summary:
2+
3+
- Added:
4+
- [5776139d](https://github.com/datafuselabs/openraft/commit/5776139d8ac15d94a800d1e0cf073dea5a7b216e) Add `#[since(version="1.0")]` to specify first version of a feature.
5+
- [b172dc8e](https://github.com/datafuselabs/openraft/commit/b172dc8e261f4f2b1149c3ada70524cdf520d5b3) Add macro `expand!()` to expand a template.
6+
- Improved:
7+
- [99596c75](https://github.com/datafuselabs/openraft/commit/99596c754e19792b97737105acea257d70d1d6b6) `declare_raft_types` allows the types in any order.
8+
- Fixed:
9+
- [14d42e4f](https://github.com/datafuselabs/openraft/commit/14d42e4f33581dc0ea9c4eeaf0ff00ebec85dbb2) Load mebmership since `last_applied`, not `last_membership.index` on startup.
10+
11+
Detail:
12+
13+
### Added:
14+
15+
- Added: [5776139d](https://github.com/datafuselabs/openraft/commit/5776139d8ac15d94a800d1e0cf073dea5a7b216e) Add `#[since(version="1.0")]` to specify first version of a feature; by 张炎泼; 2024-04-12
16+
17+
`#[since(version = "1.0.0")]` adds a doc line `/// Since: Version(1.0.0)`.
18+
19+
Example:
20+
21+
```rust,ignore
22+
/// Foo function
23+
///
24+
/// Does something.
25+
#[since(version = "1.0.0")]
26+
fn foo() {}
27+
```
28+
29+
The above code will be transformed into:
30+
31+
```rust,ignore
32+
/// Foo function
33+
///
34+
/// Does something.
35+
///
36+
/// Since: Version(1.0.0)
37+
fn foo() {}
38+
```
39+
40+
- Added: [b172dc8e](https://github.com/datafuselabs/openraft/commit/b172dc8e261f4f2b1149c3ada70524cdf520d5b3) Add macro `expand!()` to expand a template; by 张炎泼; 2024-04-13
41+
42+
`expand!()` renders a template with arguments multiple times.
43+
44+
### Example:
45+
46+
```rust,ignore
47+
expand!(KEYED, // ignore duplicate by `K`
48+
(K, T, V) => {let K: T = V;},
49+
(a, u64, 1),
50+
(a, u32, 2), // duplicate `a` will be ignored
51+
(c, Vec<u8>, vec![1,2])
52+
);
53+
```
54+
55+
The above code will be transformed into:
56+
57+
```rust,ignore
58+
let a: u64 = 1;
59+
let c: Vec<u8> = vec![1, 2];
60+
```
61+
62+
### Improved:
63+
64+
- Improved: [99596c75](https://github.com/datafuselabs/openraft/commit/99596c754e19792b97737105acea257d70d1d6b6) `declare_raft_types` allows the types in any order; by 张炎泼; 2024-04-13
65+
66+
By rewriting the template expanding part with a `#[proc_macro]`
67+
`expand!()` defined in `openraft_macros`, `declare_raft_types`
68+
does not require the types in fixed order:
69+
70+
Example:
71+
72+
```
73+
declare_raft_types!(All:
74+
D = (),
75+
NodeId = u64,
76+
R = (),
77+
Node = (),
78+
```
79+
80+
### Fixed:
81+
82+
- Fixed: [14d42e4f](https://github.com/datafuselabs/openraft/commit/14d42e4f33581dc0ea9c4eeaf0ff00ebec85dbb2) Load mebmership since `last_applied`, not `last_membership.index` on startup; by 张炎泼; 2024-04-25
83+
84+
Modify `StorageHelper::last_membership_in_log()` to scan the log
85+
starting from the last applied index rather than the index of the last
86+
applied membership log. This change reduces unnecessary I/O operations
87+
during startup, previously caused by scanning from an incorrect starting
88+
point.

0 commit comments

Comments
 (0)