Skip to content

Commit cfa9f05

Browse files
committed
doc: add a link to constance::sync::Mutex
1 parent 9bf607b commit cfa9f05

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/constance/src/lib.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ fn task_body(_: usize) {
203203
[`KernelCfg2`]: crate::kernel::KernelCfg2
204204
[`Task`]: crate::kernel::Task
205205

206-
Configuration functions are highly composable as they can call other configuration functions in turn. In some sense, this is a way to attribute a certain semantics to a group of kernel objects, making them behave in a meaningful way as a whole, and expose a whole new, higher-level interface. For example, a mutex object similar to `std::sync::Mutex` can be created by combining a low-level mutex object (not implemented yet) and a [`Hunk`]`<System, UnsafeCell<T>>`.
206+
Configuration functions are highly composable as they can call other configuration functions in turn. In some sense, this is a way to attribute a certain semantics to a group of kernel objects, making them behave in a meaningful way as a whole, and expose a whole new, higher-level interface. For example, a [mutex object] similar to `std::sync::Mutex` can be created by combining a low-level mutex object (not implemented yet) and a [`Hunk`]`<System, UnsafeCell<T>>`.
207207

208208
```rust
209209
# #![feature(const_fn)]
@@ -230,6 +230,7 @@ mod m {
230230
```
231231

232232
[`Hunk`]: crate::kernel::Hunk
233+
[mutex object]: crate::sync::Mutex
233234

234235
The constructors of kernel objects are configuration functions by themselves, but they are different from normal configuration functions in that they can actually mutate the contents of `CfgBuilder` (which `build!` will use to create kernel structures in the final form), ultimately shaping the outcome of the configuration process. Therefore, they are the smallest building blocks of configuration functions.
235236

0 commit comments

Comments
 (0)