Skip to content

Commit

Permalink
feat: rename crate to hermit-kernel
Browse files Browse the repository at this point in the history
Signed-off-by: Martin Kröning <[email protected]>
  • Loading branch information
mkroening committed Aug 25, 2023
1 parent 19f1d34 commit ccfbb3f
Show file tree
Hide file tree
Showing 8 changed files with 59 additions and 59 deletions.
14 changes: 7 additions & 7 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/publish_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
68 changes: 34 additions & 34 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[package]
name = "libhermit-rs"
name = "hermit-kernel"
version = "0.6.4"
authors = [
"Stefan Lankes <[email protected]>",
Expand All @@ -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 = [
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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/).
2 changes: 1 addition & 1 deletion src/arch/aarch64/mm/paging.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion src/macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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)*)) => {{
Expand Down
6 changes: 3 additions & 3 deletions xtask/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -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()?;
Expand All @@ -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")
Expand Down

0 comments on commit ccfbb3f

Please sign in to comment.