Skip to content

Commit c1e58cb

Browse files
committed
doc: bump svgbobdoc to 0.3.0
1 parent ace42a1 commit c1e58cb

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

crates/rlsf/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ categories = ["embedded", "no-std", "wasm", "memory-management", "web-programmin
1111
repository = "https://github.com/yvt/rlsf"
1212

1313
[features]
14-
doc_cfg = []
14+
doc_cfg = ["svgbobdoc/enable"]
1515
std = []
1616
unstable = []
1717

1818
[dependencies]
19-
svgbobdoc = { version = "0.2.2" }
19+
svgbobdoc = { version = "0.3.0" }
2020
cfg-if = "1.0.0"
2121
const_default1 = { version = "1", package = "const-default" }
2222

crates/rlsf/src/tlsf.rs

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ use crate::{
1515
utils::{nonnull_slice_from_raw_parts, nonnull_slice_len, nonnull_slice_start},
1616
};
1717

18-
#[cfg_attr(doc, svgbobdoc::transform)]
18+
#[doc = svgbobdoc::transform!(
1919
/// The TLSF header (top-level) data structure.
2020
///
2121
/// # Data Structure Overview
@@ -24,16 +24,16 @@ use crate::{
2424
/// ```svgbob
2525
/// First level
2626
/// FLLEN = 8
27-
/// ,-----+-----+-----+-----+-----+-----+-----+-----,
27+
/// ,-----+-----+-----+-----+-----+-----+-----+-----.
2828
/// fl_bitmap: FLBitmap = | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 |
2929
/// +-----+-----+-----+-----+-----+-----+-----+-----+
3030
/// min size | 2¹¹ | 2¹⁰ | 2⁹ | 2⁸ | 2⁷ | 2⁶ | 2⁵ | 2⁴ |
3131
/// '-----+-----+-----+--+--+-----+-----+-----+-----'
3232
/// |
33-
/// ╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶|╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶
33+
/// ---------------------------------------------------|-----------------------------------------
3434
/// Second Level |
3535
/// v SLLEN = 8
36-
/// ,-----+-----+-----+-----+-----+-----+-----+-----,
36+
/// ,-----+-----+-----+-----+-----+-----+-----+-----.
3737
/// "sl_bitmap[4]: SLBitmap"= | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 |
3838
/// +-----+-----+-----+-----+-----+-----+-----+-----+
3939
/// min size 2⁸(1+n/8) | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
@@ -43,12 +43,12 @@ use crate::{
4343
/// |
4444
/// | size = 416..448
4545
/// |
46-
/// ╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶|╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶╶
46+
/// ------------------------------------------------|--------------------------------------------
4747
/// Free blocks |
4848
/// |
4949
/// ,-----------------------------------'
50-
/// | ,---+---+-------, ,---+---+-------, ,---+---+-------,
51-
/// '-+>O | O-+-------+----+>O | O-+-------+----+>O | | |
50+
/// | ,---+---+-------. ,---+---+-------. ,---+---+-------.
51+
/// '->-O | O-+-------+---->-O | O-+-------+---->-O | | |
5252
/// +---+---' | +---+---' | +---+---' |
5353
/// | | | | | |
5454
/// | | | | | |
@@ -64,6 +64,7 @@ use crate::{
6464
///
6565
/// The maximum block size is `(GRANULARITY << FLLEN) - GRANULARITY`.
6666
///
67+
)]
6768
#[derive(Debug)]
6869
pub struct Tlsf<'pool, FLBitmap, SLBitmap, const FLLEN: usize, const SLLEN: usize> {
6970
fl_bitmap: FLBitmap,

0 commit comments

Comments
 (0)