Skip to content

Commit ef110a3

Browse files
committed
Improve docs of BootConfig struct
1 parent 5f4677b commit ef110a3

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

common/config/src/lib.rs

+8-6
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,29 @@
22

33
use serde::{Deserialize, Serialize};
44

5+
/// Configures the boot behavior of the bootloader.
56
#[derive(Serialize, Deserialize)]
67
#[serde(default)]
78
pub struct BootConfig {
8-
/// Configuration for the frame buffer that can be used by the kernel to display pixels
9-
/// on the screen.
9+
/// Configuration for the frame buffer setup.
1010
pub frame_buffer: FrameBuffer,
1111

12-
/// Configuration for changing the level of the filter of the messages that are shown in the
13-
/// screen when booting. The default is 'Trace'.
12+
/// The minimum log level that is printed to the screen during boot.
13+
///
14+
/// The default is [`LevelFilter::Trace`].
1415
pub log_level: LevelFilter,
1516

16-
/// Whether the bootloader should print log messages to the framebuffer when booting.
17+
/// Whether the bootloader should print log messages to the framebuffer during boot.
1718
///
1819
/// Enabled by default.
1920
pub frame_buffer_logging: bool,
2021

21-
/// Whether the bootloader should print log messages to the serial port when booting.
22+
/// Whether the bootloader should print log messages to the serial port during boot.
2223
///
2324
/// Enabled by default.
2425
pub serial_logging: bool,
2526

27+
#[doc(hidden)]
2628
pub _test_sentinel: u64,
2729
}
2830

0 commit comments

Comments
 (0)