comment: 将kernel代码注释国际化

Author: zhangxuan2011

kernel/src/drivers/char/serial.rs

@@ -24,8 +24,8 @@ impl SerialDevice {
         }
     }
 
-    /// 创建一个串口字符设备实例，并封装为通用的 `Device` 结构。
-    /// 用户需要手动指定 major/minor 号。
+    /// Create a serial char device object and uses [`Device`] sturct.
+    /// The user must specify major/minor number manually.
     pub fn create_device(major: u16, minor: u16, port_address: u16) -> Device {
         let serial = Arc::new(SerialDevice::new(port_address));
         Device::new(
@@ -36,7 +36,7 @@ impl SerialDevice {
         )
     }
 
-    /// 创建一个串口字符设备实例，并让 `DeviceManager` 自动分配 major/minor 号。
+    /// Create a serial char device object and let [`DeviceManager`] auto assign major/minor number.
     pub fn create_device_auto_assign(port_address: u16) -> Device {
         let serial = Arc::new(SerialDevice::new(port_address));
         Device::new_auto_assign(serial.name().to_string(), DeviceInner::Char(serial))

kernel/src/drivers/device.rs

@@ -40,11 +40,11 @@ pub enum DeviceError {
 
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct ScanInfo {
-    pub device_id: String,                                 // 设备唯一标识
-    pub protocol_type: String,                             // 通信协议类型（如USB/PCI/I2C）
-    pub vendor_id: Option<u16>,                            // 供应商ID
-    pub product_id: Option<u16>,                           // 产品ID
-    pub additional_data: Option<BTreeMap<String, String>>, // 附加数据
+    pub device_id: String,                                 // Device ID
+    pub protocol_type: String,                             // Communication protocol type (e.g. USB/PCI/I2C)
+    pub vendor_id: Option<u16>,                            // Vendor ID
+    pub product_id: Option<u16>,                           // Product ID
+    pub additional_data: Option<BTreeMap<String, String>>, // Additional data
 }
 
 pub trait SharedDeviceOps: Send + Sync {
@@ -81,7 +81,6 @@ pub trait BlockDevice: SharedDeviceOps {
         buf: &[u8],
     ) -> Result<usize, DeviceError>;
 
-    // 新增擦除块操作
     fn erase_blocks(&self, start_block: usize, num_blocks: usize) -> Result<usize, DeviceError> {
         let _ = (start_block, num_blocks);
         Err(DeviceError::NotSupported)

kernel/src/fs/fs_impl/kernfs.rs

@@ -15,19 +15,19 @@ pub type ReadCallback = Box<dyn Fn(u64, &mut [u8]) -> Result<usize, VfsError> +
 pub type WriteCallback = Box<dyn Fn(u64, &[u8]) -> Result<usize, VfsError> + Send + Sync>;
 
 pub enum KernNodeContent {
-    /// 目录
+    /// Directory node
     Dir(RwLock<BTreeMap<String, Arc<KernInode>>>),
-    /// 读写函数
+    /// Read-write function node
     File {
         read: Option<ReadCallback>,
         write: Option<WriteCallback>,
         size: u64,
     },
-    /// 设备映射
+    /// Device mapping
     Device { device: Arc<Device> },
 }
 
-/// 内核文件系统节点
+/// Kernel file system node
 pub struct KernInode {
     node_type: VNodeType,
     content: KernNodeContent,
@@ -42,15 +42,15 @@ impl core::fmt::Debug for KernInode {
 }
 
 impl KernInode {
-    /// 创建目录节点
+    /// Create dir node
     pub fn new_dir() -> Arc<Self> {
         Arc::new(Self {
             node_type: VNodeType::Dir,
             content: KernNodeContent::Dir(RwLock::new(BTreeMap::new())),
         })
     }
 
-    /// 创建文件节点
+    /// Create file node
     pub fn new_file(read: Option<ReadCallback>, write: Option<WriteCallback>) -> Arc<Self> {
         Arc::new(Self {
             node_type: VNodeType::File,
@@ -61,15 +61,15 @@ impl KernInode {
             },
         })
     }
-    /// 创建设备节点
+    /// Create device node
     pub fn new_device(device: Arc<Device>) -> Arc<Self> {
         Arc::new(Self {
             node_type: VNodeType::Device,
             content: KernNodeContent::Device { device },
         })
     }
 
-    /// 添加子节点（仅目录节点可用）
+    /// Add child node to directory
     pub fn add_child(&self, name: &str, child: Arc<KernInode>) -> Result<(), VfsError> {
         match &self.content {
             KernNodeContent::Dir(entries) => {

kernel/src/fs/vfs.rs

@@ -18,31 +18,31 @@ lazy_static! {
 
 #[derive(Debug, PartialEq, Eq, Clone, Copy)]
 pub enum VfsError {
-    /// 文件或目录不存在
+    /// Directory/File not exist
     NotFound,
-    /// 文件或目录已存在
+    /// File/Directory already exists
     AlreadyExists,
-    /// 路径不是目录
+    /// Path is not directory
     NotADirectory,
-    /// 路径不是文件
+    /// Path is not file
     NotAFile,
-    /// 权限不足
+    /// Permission denied
     PermissionDenied,
-    /// 设备错误
+    /// Device error
     DeviceError(DeviceError),
-    /// 无效的参数
+    /// Invalid argument
     InvalidArgument,
-    /// IO 错误
+    /// IO error
     IoError,
-    /// 符号链接深度过深
+    /// Symlink too deep
     MaxSymlinkDepth,
-    /// 文件系统类型不支持
+    /// File system type not supported
     FsTypeNotSupported,
-    /// 路径为空
+    /// Path is empty
     EmptyPath,
-    /// 功能未实现
+    /// Function not implemented
     NotImplemented,
-    /// 目录非空
+    /// Directory is not empty
     DirectoryNotEmpty,
 }
 
@@ -54,34 +54,34 @@ impl From<DeviceError> for VfsError {
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum VNodeType {
-    /// 文件
+    /// File
     File,
-    /// 目录
+    /// Directory
     Dir,
-    /// 符号链接
+    /// Symbol link
     SymLink,
-    /// 设备
+    /// Device
     Device,
 }
 
-/// 文件或目录的元数据
+/// File/Directory's metadata
 #[derive(Debug, Clone, Eq, PartialEq, Default)]
 pub struct Metadata {
-    /// 文件大小
+    /// File size
     pub size: u64,
-    /// UNIX权限位，如0o755
+    /// UNIX permission, such as 0o755
     pub permissions: u32,
-    /// 用户ID
+    /// User ID
     pub uid: u32,
-    /// 组ID
+    /// Group ID
     pub gid: u32,
-    /// 创建时间 (秒)
+    /// Create time (s)
     pub ctime: u64,
-    /// 最后修改时间 (秒)
+    /// Last edited time ()
     pub mtime: u64,
-    /// 占用的块数
+    /// Used blocks
     pub blocks: u64,
-    /// 硬链接数量
+    /// Hard link numbers
     pub nlinks: u64,
 }