Skip to content

Commit eb7a6e7

Browse files
committed
workspace: init multiboot2-common member
1 parent b6dda27 commit eb7a6e7

File tree

6 files changed

+77
-0
lines changed

6 files changed

+77
-0
lines changed

Cargo.lock

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
resolver = "2"
33
members = [
44
"multiboot2",
5+
"multiboot2-common",
56
"multiboot2-header",
67
]
78
exclude = [

multiboot2-common/Cargo.toml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
[package]
2+
name = "multiboot2-common"
3+
description = """
4+
5+
"""
6+
version = "0.1.0"
7+
authors = [
8+
"Philipp Schuster <[email protected]>"
9+
]
10+
license = "MIT/Apache-2.0"
11+
edition = "2021"
12+
categories = [
13+
"no-std",
14+
"parsing",
15+
]
16+
keywords = [
17+
"Multiboot2",
18+
"kernel",
19+
"boot",
20+
"bootloader",
21+
]
22+
readme = "README.md"
23+
homepage = "https://github.com/rust-osdev/multiboot2"
24+
repository = "https://github.com/rust-osdev/multiboot2"
25+
documentation = "https://docs.rs/multiboot2-common"
26+
#rust-version = "1.70"
27+
28+
[features]
29+
30+
31+
[dependencies]
32+
33+
[package.metadata.docs.rs]
34+
all-features = true

multiboot2-common/Changelog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# CHANGELOG for crate `multiboot2`
2+
3+
## 0.1.0 (2024-08-20)
4+
5+
Initial release.

multiboot2-common/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# multiboot2-common

multiboot2-common/src/lib.rs

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
//! Common helpers for the `multiboot2` and `multiboot2-header` crates.
2+
//!
3+
//! The main objective here is to encapsulate the memory-sensible part of
4+
//! parsing and iterating Multiboot2 structures. This crate empowers
5+
//! `multiboot2` and `multiboot2-header` to use rusty types for the
6+
//! corresponding structures, such as non-trait DSTs (structs with a
7+
//! terminating `[u8]` field). The abstractions can be used for:
8+
//! - multiboot2:
9+
//! - boot information structure (whole)
10+
//! - boot information tags
11+
//! - multiboot2-header:
12+
//! - header structure (whole)
13+
//! - header tags
14+
//!
15+
//! Not meant as stable public API for others.
16+
17+
#![no_std]
18+
// --- BEGIN STYLE CHECKS ---
19+
#![deny(
20+
clippy::all,
21+
clippy::cargo,
22+
clippy::nursery,
23+
clippy::must_use_candidate,
24+
// clippy::restriction,
25+
// clippy::pedantic
26+
)]
27+
// now allow a few rules which are denied by the above statement
28+
// --> They are either ridiculous, not necessary, or we can't fix them.
29+
#![deny(missing_docs)]
30+
#![deny(missing_debug_implementations)]
31+
#![deny(rustdoc::all)]
32+
// --- END STYLE CHECKS ---

0 commit comments

Comments
 (0)