Skip to content

Commit f4be782

Browse files
phip1611phip1611
authored
Merge pull request #86 from phip1611/preparing-cargo-workspace
prepared cargo workspace, as discussed in PR #79
2 parents aea1672 + 78b8a51 commit f4be782

19 files changed

+118
-70
lines changed

‎Cargo.toml

Lines changed: 6 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,7 @@
1-
[package]
2-
name = "multiboot2"
3-
description = """
4-
Library that helps you to parse the multiboot information structure (mbi) from
5-
Multiboot2-compliant bootloaders, like GRUB. It supports all tags from the specification
6-
including full support for the sections of ELF-64. This library is `no_std` and can be
7-
used in a Multiboot2-kernel.
8-
"""
9-
version = "0.12.1"
10-
authors = [
11-
"Philipp Oppermann <[email protected]>",
12-
"Calvin Lee <[email protected]>",
13-
"Isaac Woods",
14-
"Philipp Schuster <[email protected]>"
1+
[workspace]
2+
members = [
3+
# Multiboot2 Information Structure (MBI)
4+
"multiboot2",
5+
# Multiboot2 headers
6+
"multiboot2-header",
157
]
16-
license = "MIT/Apache-2.0"
17-
edition = "2018"
18-
categories = [
19-
"no-std",
20-
"parsing",
21-
]
22-
keywords = [
23-
"Multiboot2",
24-
"kernel",
25-
"boot",
26-
]
27-
# without this, sometimes crates.io doesn't show the preview of the README
28-
# I expeciended this multiple times in the past
29-
readme = "README.md"
30-
homepage = "https://github.com/rust-osdev/multiboot2"
31-
repository = "https://github.com/rust-osdev/multiboot2"
32-
documentation = "https://docs.rs/multiboot2"
33-
34-
[dependencies]
35-
bitflags = "1"

‎Changelog.md

Lines changed: 3 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,3 @@
1-
# TODO 0.12.2 / 0.13
2-
- internal improvements
3-
- code formatting/style
4-
- sensible style checks as optional CI job
5-
- `.editorconfig` file
6-
7-
# 0.12.1
8-
- `TagType`-enum introduced in `v0.11` is now actually public
9-
- internal code improvements
10-
11-
# 0.12.0
12-
13-
- **breaking:** `load()` and `load_with_offset` now returns a result
14-
- added public constant `MULTIBOOT2_BOOTLOADER_MAGIC`
15-
- Rust edition 2018 (instead of 2015)
16-
- internal code improvements
17-
18-
# 0.11.0
19-
20-
- lib now contains `TagType`-enum that contains
21-
all possible mbi tags that are specified (taken from spec)
22-
- much improved debug-formatting of `BootInformation`
23-
- internal code improvements / formatting
24-
25-
# 0.10.0
26-
- allow access to all memory regions (MemoryMap-Tag)
27-
- internal code improvements
28-
29-
# 0.9.0
30-
31-
- Add a `checksum_is_valid` method to the RSDP tags ([#64](https://github.com/rust-osdev/multiboot2/pull/64))
32-
33-
# 0.8.2
34-
35-
- Add some basic documentation ([#62](https://github.com/rust-osdev/multiboot2/pull/62))
36-
- Add MemoryAreaType, to allow users to access memory area types in a type-safe way ([#61](https://github.com/rust-osdev/multiboot2/pull/61))
1+
Please see:
2+
- [multiboot2/Changelog.md](multiboot2/Changelog.md)
3+
- [multiboot2-header/Changelog.md](multiboot2-header/Changelog.md)

‎multiboot2-header/Cargo.toml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[package]
2+
name = "multiboot2-header"
3+
description = """
4+
Library with type definitions and parsing functions for Multiboot2 headers.
5+
This library is `no_std` and can be used in bootloaders.
6+
"""
7+
version = "0.0.0"
8+
authors = [
9+
"Philipp Schuster <[email protected]>"
10+
]
11+
license = "MIT/Apache-2.0"
12+
edition = "2018"
13+
categories = [
14+
"parsing",
15+
]
16+
keywords = [
17+
"Multiboot2",
18+
"kernel",
19+
"boot",
20+
"bootloader",
21+
]
22+
# without this, sometimes crates.io doesn't show the preview of the README
23+
# I expeciended this multiple times in the past
24+
readme = "README.md"
25+
homepage = "https://github.com/rust-osdev/multiboot2-header"
26+
repository = "https://github.com/rust-osdev/multiboot2"
27+
documentation = "https://docs.rs/multiboot2-header"
28+
29+
[dependencies]

‎multiboot2-header/Changelog.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# CHANGELOG for crate `multiboot2-header`
2+
3+
## v0.0.0
4+
Empty release to save to name on crates.io

‎multiboot2-header/src/lib.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
//! TODO

‎multiboot2/Cargo.toml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
[package]
2+
name = "multiboot2"
3+
description = """
4+
Library that helps you to parse the multiboot information structure (mbi) from
5+
Multiboot2-compliant bootloaders, like GRUB. It supports all tags from the specification
6+
including full support for the sections of ELF-64. This library is `no_std` and can be
7+
used in a Multiboot2-kernel.
8+
"""
9+
version = "0.12.1"
10+
authors = [
11+
"Philipp Oppermann <[email protected]>",
12+
"Calvin Lee <[email protected]>",
13+
"Isaac Woods",
14+
"Philipp Schuster <[email protected]>"
15+
]
16+
license = "MIT/Apache-2.0"
17+
edition = "2018"
18+
categories = [
19+
"no-std",
20+
"parsing",
21+
]
22+
keywords = [
23+
"Multiboot2",
24+
"kernel",
25+
"boot",
26+
]
27+
# without this, sometimes crates.io doesn't show the preview of the README
28+
# I expeciended this multiple times in the past
29+
readme = "README.md"
30+
homepage = "https://github.com/rust-osdev/multiboot2"
31+
repository = "https://github.com/rust-osdev/multiboot2"
32+
documentation = "https://docs.rs/multiboot2"
33+
34+
[dependencies]
35+
bitflags = "1"

‎multiboot2/Changelog.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# CHANGELOG for crate `multiboot2`
2+
3+
## TODO 0.12.2 / 0.13
4+
- internal improvements
5+
- code formatting/style
6+
- sensible style checks as optional CI job
7+
- `.editorconfig` file
8+
- prepared co-existence of crates `multiboot2` and `multiboot2-header`
9+
in a Cargo workspace inside the same repository
10+
11+
## 0.12.1
12+
- `TagType`-enum introduced in `v0.11` is now actually public
13+
- internal code improvements
14+
15+
## 0.12.0
16+
17+
- **breaking:** `load()` and `load_with_offset` now returns a result
18+
- added public constant `MULTIBOOT2_BOOTLOADER_MAGIC`
19+
- Rust edition 2018 (instead of 2015)
20+
- internal code improvements
21+
22+
## 0.11.0
23+
24+
- lib now contains `TagType`-enum that contains
25+
all possible mbi tags that are specified (taken from spec)
26+
- much improved debug-formatting of `BootInformation`
27+
- internal code improvements / formatting
28+
29+
## 0.10.0
30+
- allow access to all memory regions (MemoryMap-Tag)
31+
- internal code improvements
32+
33+
## 0.9.0
34+
35+
- Add a `checksum_is_valid` method to the RSDP tags ([#64](https://github.com/rust-osdev/multiboot2/pull/64))
36+
37+
## 0.8.2
38+
39+
- Add some basic documentation ([#62](https://github.com/rust-osdev/multiboot2/pull/62))
40+
- Add MemoryAreaType, to allow users to access memory area types in a type-safe way ([#61](https://github.com/rust-osdev/multiboot2/pull/61))

‎src/boot_loader_name.rs renamed to ‎multiboot2/src/boot_loader_name.rs

File renamed without changes.

‎src/command_line.rs renamed to ‎multiboot2/src/command_line.rs

File renamed without changes.

‎src/efi.rs renamed to ‎multiboot2/src/efi.rs

File renamed without changes.

0 commit comments

Comments
 (0)