Hide OSDK installation if using Make

.github/workflows/kernel_test.yml

@@ -16,8 +16,6 @@ jobs:
 
       - uses: actions/checkout@v4
       
-      - run: make install_osdk
-
       - name: Check
         id: check
         run: make check
@@ -31,8 +29,6 @@ jobs:
 
       - uses: actions/checkout@v4
 
-      - run: make install_osdk
-
       - name: Usermode Unit test
         id: usermode_unit_test
         run: make test
@@ -52,8 +48,6 @@ jobs:
 
       - uses: actions/checkout@v4
 
-      - run: make install_osdk
-
       - name: Boot Test (Multiboot)
         id: boot_test_mb
         run: make run AUTO_TEST=boot ENABLE_KVM=0 BOOT_PROTOCOL=multiboot RELEASE_MODE=1

Makefile

@@ -98,14 +98,18 @@ OSDK_CRATES := \
 	kernel/comps/virtio \
 	kernel/libs/aster-util
 
-.PHONY: all install_osdk build tools run test docs check clean update_initramfs
+.PHONY: all build tools run test docs check clean update_initramfs
 
 all: build
 
-install_osdk:
+# Install or update OSDK from source
+# To uninstall, do `cargo uninstall cargo-osdk`
+install_osdk: osdk
 	@cargo install cargo-osdk --path osdk
 
-build:
+~/.cargo/bin/cargo-osdk: install_osdk
+
+build: install_osdk ~/.cargo/bin/cargo-osdk
 	@make --no-print-directory -C regression
 	@cd kernel && cargo osdk build $(CARGO_OSDK_ARGS)
 
@@ -120,7 +124,7 @@ test:
 		(cd $$dir && cargo test) || exit 1; \
 	done
 
-ktest:
+ktest: install_osdk ~/.cargo/bin/cargo-osdk
 	@# Exclude linux-bzimage-setup from ktest since it's hard to be unit tested
 	@for dir in $(OSDK_CRATES); do \
 		[ $$dir = "framework/libs/linux-bzimage/setup" ] && continue; \
@@ -135,7 +139,7 @@ docs:
 format:
 	@./tools/format_all.sh
 
-check:
+check: install_osdk ~/.cargo/bin/cargo-osdk
 	@./tools/format_all.sh --check   	# Check Rust format issues
 	@# Check if STD_CRATES and NOSTD_CRATES combined is the same as all workspace members
 	@sed -n '/^\[workspace\]/,/^\[.*\]/{/members = \[/,/\]/p}' Cargo.toml | grep -v "members = \[" | tr -d '", \]' | sort > /tmp/all_crates

README.md

@@ -1,11 +1,11 @@
 <p align="center">
     <img src="docs/src/images/logo_en.svg" alt="asterinas-logo" width="620"><br>
-    A secure, fast, and general-purpose OS kernel written in Rust and compatible with Linux
+    A secure, fast, and general-purpose OS kernel written in Rust and compatible with Linux<br/>
+    <a href="https://github.com/asterinas/asterinas/actions/workflows/osdk_test.yml"><img src="https://github.com/asterinas/asterinas/actions/workflows/osdk_test.yml/badge.svg" alt="OSDK Test" style="max-width: 100%;"></a>
+    <a href="https://github.com/asterinas/asterinas/actions/workflows/kernel_test.yml"><img src="https://github.com/asterinas/asterinas/actions/workflows/kernel_test.yml/badge.svg" alt="Kernel Test" style="max-width: 100%;"></a>
+    <br/>
 </p>
 
-[![Check License](https://github.com/asterinas/asterinas/actions/workflows/license_check.yml/badge.svg)](https://github.com/asterinas/asterinas/actions/workflows/license_check.yml)
-[![Kernel Test](https://github.com/asterinas/asterinas/actions/workflows/kernel_test.yml/badge.svg)](https://github.com/asterinas/asterinas/actions/workflows/kernel_test.yml)
-
 English | [中文版](README_CN.md)
 
 ## Introducing Asterinas
@@ -55,13 +55,7 @@ git clone https://github.com/asterinas/asterinas
 docker run -it --privileged --network=host --device=/dev/kvm -v ./asterinas:/root/asterinas asterinas/asterinas:0.4.0
 ```
 
-3. Install the Asterinas OSDK from source.
+3. Inside the container, go to the project folder to build and run Asterinas.
-
-```bash
-make install_osdk
-```
-
-4. Inside the container, go to the project folder to build and run Asterinas.
 
 ```bash
 make build

README_CN.md

@@ -1,10 +1,11 @@
 <p align="center">
     <img src="docs/src/images/logo_cn.svg" alt="asterinas-logo" width="620"><br>
-    一个安全、快速、通用的操作系统内核，使用Rust编写，并与Linux兼容
+    一个安全、快速、通用的操作系统内核，使用Rust编写，并与Linux兼容<br/>
+    <a href="https://github.com/asterinas/asterinas/actions/workflows/osdk_test.yml"><img src="https://github.com/asterinas/asterinas/actions/workflows/osdk_test.yml/badge.svg" alt="OSDK Test" style="max-width: 100%;"></a>
+    <a href="https://github.com/asterinas/asterinas/actions/workflows/kernel_test.yml"><img src="https://github.com/asterinas/asterinas/actions/workflows/kernel_test.yml/badge.svg" alt="Kernel Test" style="max-width: 100%;"></a>
+    <br/>
 </p>
 
-[![Asterinas CI](https://github.com/asterinas/asterinas/actions/workflows/aster_ci.yml/badge.svg)](https://github.com/asterinas/asterinas/actions/workflows/aster_ci.yml)
-
 [English](README.md) | 中文版
 
 ## 初见星绽
@@ -50,13 +51,7 @@ git clone https://github.com/asterinas/asterinas
 docker run -it --privileged --network=host --device=/dev/kvm -v ./asterinas:/root/asterinas asterinas/asterinas:0.4.0
 ```
 
-3. 从源码编译安装 Asterinas OSDK
+3. 在容器内，进入项目文件夹构建并运行星绽。
-
-```bash
-make install_osdk
-```
-
-4. 在容器内，进入项目文件夹构建并运行星绽。
 
 ```bash
 make build

osdk/README.md

@@ -1,7 +1,7 @@
 # Accelerate OS development with Asterinas OSDK
 
 [![Crates.io](https://img.shields.io/crates/v/cargo-osdk.svg)](https://crates.io/crates/cargo-osdk)
-[![OSDK CI](https://github.com/asterinas/asterinas/actions/workflows/osdk_ci.yml/badge.svg)](https://github.com/asterinas/asterinas/actions/workflows/osdk_ci.yml)
+[![OSDK Test](https://github.com/asterinas/asterinas/actions/workflows/osdk_test.yml/badge.svg)](https://github.com/asterinas/asterinas/actions/workflows/osdk_test.yml)
 
 ### What is it?
 

osdk/src/cli.rs

@@ -115,7 +115,7 @@ pub struct TestArgs {
 pub struct CargoArgs {
     #[arg(
         long,
-        help = "The Cargo build profile (built-in candidates are 'debug', 'release', 'dev' and 'bench')",
+        help = "The Cargo build profile (built-in candidates are 'dev', 'release', 'test' and 'bench')",
         default_value = "dev"
     )]
     pub profile: String,

osdk/src/config_manager/manifest.rs

@@ -150,7 +150,7 @@ fn check_args(arg_name: &str, args: &[String]) {
 /// Check cfg that is in the form that we can accept
 fn check_cfg(cfg: &str) {
     if SELECT_REGEX.captures(cfg).is_none() {
-        error_msg!("{} is not allowed to used after `qemu` in `OSDK.toml`. Currently we only allow cfgs like `cfg(select=\"foo\")`", cfg);
+        error_msg!("{} is not allowed to be used after `qemu` in `OSDK.toml`. Currently we only allow cfgs like `cfg(select=\"foo\")`", cfg);
         process::exit(Errno::ParseMetadata as _);
     }
 }