Merge pull request #86 from phip1611/preparing-cargo-workspace

prepared cargo workspace, as discussed in PR #79

Cargo.toml

@@ -1,35 +1,7 @@
-[package]
-name = "multiboot2"
-description = """
-Library that helps you to parse the multiboot information structure (mbi) from
-Multiboot2-compliant bootloaders, like GRUB. It supports all tags from the specification
-including full support for the sections of ELF-64. This library is `no_std` and can be
-used in a Multiboot2-kernel.
-"""
-version = "0.12.1"
-authors = [
-    "Philipp Oppermann <dev@phil-opp.com>",
-    "Calvin Lee <cyrus296@gmail.com>",
-    "Isaac Woods",
-    "Philipp Schuster <phip1611@gmail.com>"
+[workspace]
+members = [
+    # Multiboot2 Information Structure (MBI)
+    "multiboot2",
+    # Multiboot2 headers
+    "multiboot2-header",
 ]
-license = "MIT/Apache-2.0"
-edition = "2018"
-categories = [
-    "no-std",
-    "parsing",
-]
-keywords = [
-    "Multiboot2",
-    "kernel",
-    "boot",
-]
-# without this, sometimes crates.io doesn't show the preview of the README
-# I expeciended this multiple times in the past
-readme = "README.md"
-homepage = "https://github.com/rust-osdev/multiboot2"
-repository = "https://github.com/rust-osdev/multiboot2"
-documentation = "https://docs.rs/multiboot2"
-
-[dependencies]
-bitflags = "1"

Changelog.md

@@ -1,36 +1,3 @@
-# TODO 0.12.2 / 0.13
-- internal improvements
-  - code formatting/style
-  - sensible style checks as optional CI job
-  - `.editorconfig` file
-
-# 0.12.1
-- `TagType`-enum introduced in `v0.11` is now actually public
-- internal code improvements
-
-# 0.12.0
-
-- **breaking:** `load()` and `load_with_offset` now returns a result
-- added public constant `MULTIBOOT2_BOOTLOADER_MAGIC`
-- Rust edition 2018 (instead of 2015)
-- internal code improvements
-
-# 0.11.0
-
-- lib now contains `TagType`-enum that contains
-  all possible mbi tags that are specified (taken from spec)
-- much improved debug-formatting of `BootInformation`
-- internal code improvements / formatting
-
-# 0.10.0
-- allow access to all memory regions (MemoryMap-Tag)
-- internal code improvements
-
-# 0.9.0
-
-- Add a `checksum_is_valid` method to the RSDP tags ([#64](https://github.com/rust-osdev/multiboot2/pull/64))
-
-# 0.8.2
-
-- Add some basic documentation ([#62](https://github.com/rust-osdev/multiboot2/pull/62))
-- Add MemoryAreaType, to allow users to access memory area types in a type-safe way ([#61](https://github.com/rust-osdev/multiboot2/pull/61))
+Please see:
+- [multiboot2/Changelog.md](multiboot2/Changelog.md)
+- [multiboot2-header/Changelog.md](multiboot2-header/Changelog.md)

multiboot2-header/Cargo.toml

@@ -0,0 +1,29 @@
+[package]
+name = "multiboot2-header"
+description = """
+Library with type definitions and parsing functions for Multiboot2 headers.
+This library is `no_std` and can be used in bootloaders.
+"""
+version = "0.0.0"
+authors = [
+    "Philipp Schuster <phip1611@gmail.com>"
+]
+license = "MIT/Apache-2.0"
+edition = "2018"
+categories = [
+    "parsing",
+]
+keywords = [
+    "Multiboot2",
+    "kernel",
+    "boot",
+    "bootloader",
+]
+# without this, sometimes crates.io doesn't show the preview of the README
+# I expeciended this multiple times in the past
+readme = "README.md"
+homepage = "https://github.com/rust-osdev/multiboot2-header"
+repository = "https://github.com/rust-osdev/multiboot2"
+documentation = "https://docs.rs/multiboot2-header"
+
+[dependencies]

multiboot2-header/Changelog.md

@@ -0,0 +1,4 @@
+# CHANGELOG for crate `multiboot2-header`
+
+## v0.0.0
+Empty release to save to name on crates.io

multiboot2-header/src/lib.rs

@@ -0,0 +1 @@
+//! TODO

multiboot2/Cargo.toml

@@ -0,0 +1,35 @@
+[package]
+name = "multiboot2"
+description = """
+Library that helps you to parse the multiboot information structure (mbi) from
+Multiboot2-compliant bootloaders, like GRUB. It supports all tags from the specification
+including full support for the sections of ELF-64. This library is `no_std` and can be
+used in a Multiboot2-kernel.
+"""
+version = "0.12.1"
+authors = [
+    "Philipp Oppermann <dev@phil-opp.com>",
+    "Calvin Lee <cyrus296@gmail.com>",
+    "Isaac Woods",
+    "Philipp Schuster <phip1611@gmail.com>"
+]
+license = "MIT/Apache-2.0"
+edition = "2018"
+categories = [
+    "no-std",
+    "parsing",
+]
+keywords = [
+    "Multiboot2",
+    "kernel",
+    "boot",
+]
+# without this, sometimes crates.io doesn't show the preview of the README
+# I expeciended this multiple times in the past
+readme = "README.md"
+homepage = "https://github.com/rust-osdev/multiboot2"
+repository = "https://github.com/rust-osdev/multiboot2"
+documentation = "https://docs.rs/multiboot2"
+
+[dependencies]
+bitflags = "1"

multiboot2/Changelog.md

@@ -0,0 +1,40 @@
+# CHANGELOG for crate `multiboot2`
+
+## TODO 0.12.2 / 0.13
+- internal improvements
+  - code formatting/style
+  - sensible style checks as optional CI job
+  - `.editorconfig` file
+  - prepared co-existence of crates `multiboot2` and `multiboot2-header`
+    in a Cargo workspace inside the same repository
+
+## 0.12.1
+- `TagType`-enum introduced in `v0.11` is now actually public
+- internal code improvements
+
+## 0.12.0
+
+- **breaking:** `load()` and `load_with_offset` now returns a result
+- added public constant `MULTIBOOT2_BOOTLOADER_MAGIC`
+- Rust edition 2018 (instead of 2015)
+- internal code improvements
+
+## 0.11.0
+
+- lib now contains `TagType`-enum that contains
+  all possible mbi tags that are specified (taken from spec)
+- much improved debug-formatting of `BootInformation`
+- internal code improvements / formatting
+
+## 0.10.0
+- allow access to all memory regions (MemoryMap-Tag)
+- internal code improvements
+
+## 0.9.0
+
+- Add a `checksum_is_valid` method to the RSDP tags ([#64](https://github.com/rust-osdev/multiboot2/pull/64))
+
+## 0.8.2
+
+- Add some basic documentation ([#62](https://github.com/rust-osdev/multiboot2/pull/62))
+- Add MemoryAreaType, to allow users to access memory area types in a type-safe way ([#61](https://github.com/rust-osdev/multiboot2/pull/61))