CLKS拆分:第二步

This commit is contained in:
2026-04-23 19:41:24 +08:00
parent 3ed3f6acfe
commit 0d39b5ff59
3 changed files with 185 additions and 0 deletions

51
clks/License Normal file
View File

@@ -0,0 +1,51 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
You must give any other recipients of the Work or Derivative Works a copy of this License; and
You must cause any modified files to carry prominent notices stating that You changed the files; and
You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS

67
clks/README.md Normal file
View File

@@ -0,0 +1,67 @@
# CLKS Kernel
[English](README.md) | [简体中文](README.zh-CN.md)
CLKS is the kernel component of the CLeonOS project.
It includes architecture startup code, interrupt handling, memory management, scheduler, syscall layer, storage, TTY/console, and core runtime services.
## Status
CLKS can be built in kernel-only mode from the current mono-repo, but it is not yet a fully independent repository build system.
- Kernel-only mode is available.
- Userland/ISO targets are optional and can be disabled.
- Some build scripts are still shared at repository root (`cmake/`, `configs/`, `scripts/`).
## Directory Layout
```text
clks/
|- arch/ # Architecture-specific startup and low-level code
|- include/ # Public kernel headers
|- kernel/ # Core kernel subsystems
|- rust/ # Rust staticlib used by kernel
|- third_party/ # Embedded third-party sources used by kernel
|- CMakeLists.txt # Kernel build rules
|- Makefile # Kernel-focused wrapper (delegates to root build)
```
## Build (Kernel-Only)
From repository root:
```bash
make kernel CLEONOS_ENABLE=OFF
```
or via CLKS wrapper:
```bash
make -C clks kernel
```
## Menuconfig (CLKS Scope)
```bash
make menuconfig-clks
```
or:
```bash
make -C clks menuconfig
```
This updates CLKS-focused config outputs under `configs/menuconfig/` (including `config.clks.cmake`).
## Notes for Future Split
To make CLKS a standalone repo, the next required step is moving shared build assets into `clks/` (or vendoring equivalents), especially:
- `cmake/` helper scripts (`log.cmake`, symbol generation, tool checks)
- boot config and image packaging pieces currently under `configs/`
- menuconfig launcher and feature metadata currently under `scripts/` and `configs/menuconfig/`
## License
Apache-2.0 (same as project root).

67
clks/README.zh-CN.md Normal file
View File

@@ -0,0 +1,67 @@
# CLKS 内核
[English](README.md) | [简体中文](README.zh-CN.md)
CLKS 是 CLeonOS 项目的内核部分。
它包含架构启动代码、中断处理、内存管理、调度器、syscall 层、存储、TTY/控制台与核心运行时服务。
## 当前状态
CLKS 目前可以在单仓库中以仅内核模式构建,但还不是完全独立仓库形态的构建系统。
- 已支持仅内核构建模式。
- 用户态/ISO 目标是可选项,可以关闭。
- 仍有部分构建脚本与根目录共享(`cmake/``configs/``scripts/`)。
## 目录结构
```text
clks/
|- arch/ # 架构相关启动与底层代码
|- include/ # 对外内核头文件
|- kernel/ # 内核核心子系统
|- rust/ # 内核使用的 Rust staticlib
|- third_party/ # 内核使用的第三方源码
|- CMakeLists.txt # 内核构建规则
|- Makefile # 面向内核的包装入口(委托到根构建)
```
## 构建(仅内核)
在仓库根目录执行:
```bash
make kernel CLEONOS_ENABLE=OFF
```
或通过 CLKS 包装入口:
```bash
make -C clks kernel
```
## MenuconfigCLKS 作用域)
```bash
make menuconfig-clks
```
或:
```bash
make -C clks menuconfig
```
以上命令会更新 `configs/menuconfig/` 下的 CLKS 相关配置输出(包含 `config.clks.cmake`)。
## 后续独立拆分建议
若要将 CLKS 拆成独立仓库,下一步关键工作是把共享构建资产迁移到 `clks/`(或引入等价副本),重点包括:
- `cmake/` 工具脚本(`log.cmake`、符号化生成、工具检查)
- 当前位于 `configs/` 下的启动配置与镜像打包相关内容
- 当前位于 `scripts/``configs/menuconfig/` 下的 menuconfig 启动器与特性元数据
## 许可证
Apache-2.0(与项目根目录一致)。