update: add CI, Example, Test and ReadmeTag by Lfan-ke · Pull Request #2 · arceos-org/axio

Lfan-ke · 2025-06-19T17:09:44Z

No description provided.

Copilot

Pull Request Overview

This PR introduces updated documentation, enhanced tests, CI configuration improvements, and modernizes various project files. Key updates include:

Added detailed examples and extensive tests for I/O traits and buffered reading.
Updated CI workflows and toolchain configuration for improved build/testing.
Refined documentation and re-exports across modules, and updated Cargo.toml metadata.

Reviewed Changes

Copilot reviewed 10 out of 11 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/prelude.rs	Added a doc comment for re-exported I/O traits.
src/lib.rs	Introduced new examples in docs and comprehensive tests.
src/impls.rs	Added documentation and tests for Read trait implementations.
src/error.rs	Documented re-export of error types.
src/buffered/mod.rs	Added module-level documentation.
src/buffered/bufreader.rs	Enhanced doc comments and added extensive tests for BufReader.
rust-toolchain	Updated toolchain configuration (nightly 2025-06-18).
README.md	Revamped layout with additional badges and examples.
Cargo.toml	Bumped version, updated edition, author list and dependency version.
.github/workflows/ci.yml	Improved CI configuration with updated actions and flags.

Azure-stars · 2025-06-22T08:56:42Z

Cargo.toml


 [dependencies]
-axerrno = "0.1"
+axerrno = { version = "0.1.0" }


Why we can't set axerrno = "0.1"?

is updated now

Azure-stars · 2025-06-22T08:57:46Z

Cargo.toml

-edition = "2021"
-authors = ["Yuekai Jia <equation618@gmail.com>"]
+version = "0.1.2"
+edition = "2024"


keep it as 2021 to make it compatible with more toolchain versions?

the task of os camp is to make it run on the latest toolchain

The bootcamp missions are not entirely correct. We prioritize the usability of the modules.

Azure-stars · 2025-06-22T08:58:28Z

.github/workflows/ci.yml


-on: [push, pull_request]
+on:
+  push:


Why we don't trigger CI for other branch?

gh-page? ci auto dispathch ci.
is updated now:
branches-ignore:
- 'gh-pages'

i ignored if: ${{ github.ref == env.default-branch }} before commit and i have deleted on: push: now

Azure-stars · 2025-06-22T08:59:45Z

.github/workflows/ci.yml

+  pull_request:
+    branches: [ main, master ]
+
+  workflow_dispatch: {}


Any need to add workflow_dispatch option?

manually triggering online debugging is a very convenient feature

Here is only for debug. But in the real condition maybe we doesn't need it?

deleted currently

Azure-stars · 2025-06-22T09:02:18Z

src/buffered/mod.rs

+//!
+//! ```
+//! # #![allow(unused_imports)]
+//! use std::io::BufReader;


Why here is std::io? And what does this comment mean?

Azure-stars · 2025-06-22T09:02:48Z

src/impls.rs

+        let mut slice = &data[..];
+        let mut buf = [0u8; 5];
+
+        // 测试正常读取


Use English comment.

Azure-stars · 2025-06-22T09:04:13Z

.github/workflows/ci.yml

      matrix:
-        rust-toolchain: [nightly]
-        targets: [x86_64-unknown-linux-gnu, x86_64-unknown-none, riscv64gc-unknown-none-elf, aarch64-unknown-none-softfloat]
+        targets: [ x86_64-unknown-linux-gnu, x86_64-unknown-none, riscv64gc-unknown-none-elf, aarch64-unknown-none-softfloat ]


remove the extra spaces.

Azure-stars · 2025-06-22T09:08:24Z

src/buffered/bufreader.rs

        Ok(nread)
    }

+    /// Reads exactly enough bytes to fill the buffer, using buffered data first


Maybe we should not mix the LINE_COMMENT and DOC_COMMENT?

Azure-stars · 2025-06-22T09:09:13Z

src/buffered/bufreader.rs

+    }
+
+    #[test]
+    fn test_new() {


I think some test may be not necessary, like test_new?

deleted now

Lfan-ke added 14 commits June 19, 2025 23:49

update: add test and docs

07a7d5a

update: add workflow_dispatch

ab477cf

fixed: fixed the rust version of nightly

414dc55

fixed: some error

d4c4a1e

fixed: some error

2e32b1c

fixed: some error

2501b48

fmt: readme

4b355ca

fmt: readme

d75bf14

fmt: readme

4d643de

fmt: readme

0b53842

fmt: readme

fe4ec78

fmt: readme

75de54f

fmt: readme

6a7b016

fmt: readme

affb464

chyyuu requested review from Azure-stars, aarkegz, Copilot and equation314 June 22, 2025 08:50

Copilot AI reviewed Jun 22, 2025

View reviewed changes

Azure-stars reviewed Jun 22, 2025

View reviewed changes

Lfan-ke added 6 commits June 22, 2025 17:37

fixed: docs and ci

5621d79

fixed: toolchain 0618 to 0512

1770ff1

fixed: rust edition 2024 to 2021

d5a27fc

remove: the minimum supported version 1.87

6070251

remove: ci - workflow_dispatch

76c7e6f

style: run cargo fmt

3ea3b8b

Lfan-ke closed this by deleting the head repository Jan 11, 2026

Comments

Conversation

Lfan-ke commented Jun 19, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants