feat: rename crate to hermit-kernel

mkroening · mkroening · commit ccfbb3f35685 · 2023-08-25T17:49:51.000+02:00
Signed-off-by: Martin Kröning &lt;martin.kroening@eonerc.rwth-aachen.de&gt;
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -26,7 +26,7 @@ jobs:
       - uses: mkroening/rust-toolchain-toml@main
       - uses: Swatinem/rust-cache@v2
       - name: Check each feature
-        run: cargo hack check --package libhermit-rs --each-feature --no-dev-deps --target x86_64-unknown-none
+        run: cargo hack check --package hermit-kernel --each-feature --no-dev-deps --target x86_64-unknown-none
         env:
           RUSTFLAGS:
 
@@ -67,8 +67,8 @@ jobs:
       - uses: Swatinem/rust-cache@v2
       - name: Check docs
         run: |
-          cargo doc --package libhermit-rs --no-deps --document-private-items --target x86_64-unknown-none
-          cargo doc --package libhermit-rs --no-deps --document-private-items --target aarch64-unknown-none-softfloat --no-default-features
+          cargo doc --package hermit-kernel --no-deps --document-private-items --target x86_64-unknown-none
+          cargo doc --package hermit-kernel --no-deps --document-private-items --target aarch64-unknown-none-softfloat --no-default-features
 
   build:
     name: Build
@@ -124,9 +124,9 @@ jobs:
         with:
           repository: hermitcore/rusty-hermit
           submodules: true
-      - name: Remove libhermit-rs submodule
+      - name: Remove hermit-kernel submodule
         run: git rm -r libhermit-rs
-      - name: Checkout libhermit-rs
+      - name: Checkout hermit-kernel
         uses: actions/checkout@v3
         with:
           path: libhermit-rs
@@ -249,9 +249,9 @@ jobs:
         with:
           repository: hermitcore/rusty-hermit
           submodules: true
-      - name: Remove libhermit-rs submodule
+      - name: Remove hermit-kernel submodule
         run: git rm -r libhermit-rs
-      - name: Checkout libhermit-rs
+      - name: Checkout hermit-kernel
         uses: actions/checkout@v3
         with:
           path: libhermit-rs
diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml
@@ -21,18 +21,18 @@ jobs:
           sudo apt-get update
           sudo apt-get install nasm
       - name: Generate documentation
-        run: cargo doc --target x86_64-unknown-none --package libhermit-rs
+        run: cargo doc --target x86_64-unknown-none --package hermit-kernel
       - name: Generate index.html
         run: |
           cat > target/x86_64-unknown-none/doc/index.html <<EOL
           <!doctype html>
           <html>
             <head>
               <title>Redirect!</title>
-              <meta http-equiv="refresh" content="0; url=https://hermitcore.github.io/libhermit-rs/hermit/" />
+              <meta http-equiv="refresh" content="0; url=https://hermitcore.github.io/kernel/hermit/" />
             </head>
             <body>
-              <p><a href="https://hermitcore.github.io/libhermit-rs/hermit/">Redirect</a></p>
+              <p><a href="https://hermitcore.github.io/kernel/hermit/">Redirect</a></p>
             </body>
           </html>
           EOL
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "libhermit-rs"
+name = "hermit-kernel"
 version = "0.6.4"
 authors = [
 	"Stefan Lankes <slankes@eonerc.rwth-aachen.de>",
@@ -16,8 +16,8 @@ license = "MIT OR Apache-2.0"
 readme = "README.md"
 keywords = ["unikernel", "libos"]
 categories = ["os"]
-repository = "https://github.com/hermitcore/libhermit-rs"
-documentation = "https://hermitcore.github.io/libhermit-rs/hermit/"
+repository = "https://github.com/hermitcore/kernel"
+documentation = "https://hermitcore.github.io/kernel/hermit/"
 edition = "2021"
 description = "A Rust-based library operating system"
 exclude = [
diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
 <img width="100" align="right" src="img/hermitcore_logo.png" />
 
-# RustyHermit: libhermit-rs
+# Hermit Kernel
 
-[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://hermitcore.github.io/libhermit-rs/hermit/)
+[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://hermitcore.github.io/kernel/hermit/)
 ![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue)
 [![Zulip Badge](https://img.shields.io/badge/chat-hermit-57A37C?logo=zulip)](https://hermit.zulipchat.com/)
 
-_libhermit-rs_ is the kernel of the [RustyHermit](https://github.com/hermitcore/rusty-hermit) unikernel project.
+This is the kernel of the [Hermit](https://github.com/hermitcore) unikernel project.
 
 ## Requirements
 
@@ -28,11 +28,11 @@ cargo xtask build --arch x86_64
 ```
 
 On completion, the script will print the path of `libhermit.a`.
-If you want to build _libhermit-rs_ for aarch64, please replace `x86_64` by `aarch64`.
+If you want to build the kernel for aarch64, please replace `x86_64` by `aarch64`.
 
 ### Control the kernel messages verbosity
 
-_libhermit-rs_ uses the lightweight logging crate [log](https://github.com/rust-lang/log) to print kernel messages.
+This kernel uses the lightweight logging crate [log](https://github.com/rust-lang/log) to print kernel messages.
 The environment variable `HERMIT_LOG_LEVEL_FILTER` controls the verbosity. 
 You can change it by setting it at compile time to a string matching the name of a [LevelFilter](https://docs.rs/log/0.4.8/log/enum.LevelFilter.html).
 If the variable is not set, or the name doesn't match, then `LevelFilter::Info` is used by default.
@@ -43,7 +43,7 @@ $ HERMIT_LOG_LEVEL_FILTER=Debug cargo xtask build --arch x86_64
 
 ## Credits
 
-_libhermit-rs_ is derived from following tutorials and software distributions:
+This kernel is derived from following tutorials and software distributions:
 
 1. Philipp Oppermann's [excellent series of blog posts][opp].
 2. Erik Kidd's [toyos-rs][kidd], which is an extension of Philipp Opermann's kernel.
@@ -68,5 +68,5 @@ at your option.
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
 
-libhermit-rs is being developed on [GitHub](https://github.com/hermitcore/libhermit-rs).
+The kernel is being developed on [hermitcore/kernel](https://github.com/hermitcore/kernel).
 Create your own fork, send us a pull request, and chat with us on [Zulip](https://hermit.zulipchat.com/).
diff --git a/src/arch/aarch64/mm/paging.rs b/src/arch/aarch64/mm/paging.rs
@@ -510,7 +510,7 @@ where
 	/// Returns the next subtable for the given page in the page table hierarchy.
 	///
 	/// Must only be called if a page of this size is mapped in a subtable!
-	// FIXME: https://github.com/hermitcore/libhermit-rs/issues/771
+	// FIXME: https://github.com/hermitcore/hermit-kernel/issues/771
 	#[allow(clippy::mut_from_ref)]
 	fn subtable<S: PageSize>(&self, page: Page<S>) -> &mut PageTable<L::SubtableLevel> {
 		assert!(L::LEVEL < S::MAP_LEVEL);
diff --git a/src/macros.rs b/src/macros.rs
@@ -104,7 +104,7 @@ macro_rules! kernel_function {
 }
 
 // TODO: Properly switch kernel stack with newlib
-// https://github.com/hermitcore/libhermit-rs/issues/471
+// https://github.com/hermitcore/hermit-kernel/issues/471
 #[cfg(all(target_arch = "x86_64", feature = "newlib"))]
 macro_rules! kernel_function {
 	($f:ident($($x:tt)*)) => {{
diff --git a/xtask/src/main.rs b/xtask/src/main.rs
@@ -87,7 +87,7 @@ impl flags::Build {
 			.unwrap_or_default();
 
 		// TODO: Re-enable mutable-noalias
-		// https://github.com/hermitcore/libhermit-rs/issues/200
+		// https://github.com/hermitcore/hermit-kernel/issues/200
 		rustflags.push("-Zmutable-noalias=no");
 
 		if self.instrument_mcount {
@@ -198,7 +198,7 @@ impl flags::Clippy {
 		let sh = sh()?;
 
 		// TODO: Enable clippy for aarch64
-		// https://github.com/hermitcore/libhermit-rs/issues/381
+		// https://github.com/hermitcore/hermit-kernel/issues/381
 		for target in [Arch::X86_64, Arch::AArch64] {
 			let target_args = target.cargo_args();
 			cmd!(sh, "cargo clippy {target_args...}").run()?;
@@ -210,7 +210,7 @@ impl flags::Clippy {
 				.arg("--features=acpi,fsgsbase,pci,smp,vga")
 				.run()?;
 			// TODO: Enable clippy for newlib
-			// https://github.com/hermitcore/libhermit-rs/issues/470
+			// https://github.com/hermitcore/hermit-kernel/issues/470
 			// cmd!(sh, "cargo clippy {target_args...}")
 			// 	.arg("--no-default-features")
 			// 	.arg("--features=acpi,fsgsbase,newlib,smp,vga")

Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ macro_rules! kernel_function {`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`// TODO: Properly switch kernel stack with newlib`
`107`		`-// https://github.com/hermitcore/libhermit-rs/issues/471`
	`107`	`+// https://github.com/hermitcore/hermit-kernel/issues/471`
`108`	`108`	`#[cfg(all(target_arch = "x86_64", feature = "newlib"))]`
`109`	`109`	`macro_rules! kernel_function {`
`110`	`110`	`($f:ident($($x:tt)*)) => {{`