From 14162847c8337ca2a4b1b36691be9c0a945fe4b2 Mon Sep 17 00:00:00 2001 From: xijing <84754181+xijing21@users.noreply.github.com> Date: Tue, 12 Mar 2024 21:05:40 +0800 Subject: [PATCH] update docs --- docs/.vitepress/config.mts | 19 +++---------- docs/zh/devices/index.md | 17 ++++++----- docs/zh/ruyi/getstarted/index.md | 40 ++++++++++++++++++++------ docs/zh/ruyi/index.md | 49 +++++++++++++++++++++++--------- docs/zh/ruyi/mirrors/index.md | 20 ------------- 5 files changed, 79 insertions(+), 66 deletions(-) delete mode 100644 docs/zh/ruyi/mirrors/index.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index aed031fb..3f09853c 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -36,9 +36,8 @@ export default defineConfig({ { text: '准备RISC-V运行环境', link: '/zh/usedirection/operationside/' }, ] }, - { text: '使用案例', + { text: '使用案例', link: '/zh/usecase/' , items: [ - { text: '简介', link: '/zh/usecase/' }, { text: 'amd上编译并模拟运行', link: '/zh/usecase/x86pc/' }, { text: '为RISC-V开发板安装系统镜像', link: '/zh/usecase/setupos/' }, { text: '在Licheepi4A上编译运行', link: '/zh/usecase/rvbook/' }, @@ -49,11 +48,9 @@ export default defineConfig({ { text: '工具', items: [ { - text: 'RUYI 包管理器', + text: 'RUYI 包管理器', link: '/zh/ruyi/' , items: [ - { text: '介绍', link: '/zh/ruyi/' }, { text: '开始', link: '/zh/ruyi/getstarted/' }, - { text: '用户软件源搭建', link: '/zh/ruyi/mirrors/' }, { text: '版本更新', collapsed: true, @@ -70,18 +67,10 @@ export default defineConfig({ { text: 'RuyiSDK', items: [ { - text: 'GNU', - link: '/zh/sdk/gnu/', - items: [ - { text: 'GNU Upstream', link: '/zh/sdk/gnu/' }, - ] + text: 'GNU', link: '/zh/sdk/gnu/', }, { - text: 'LLVM', - link: '/zh/sdk/llvm/', - items: [ - { text: 'LLVM Upstream', link: '/zh/sdk/llvm/' }, - ] + text: 'LLVM', link: '/zh/sdk/llvm/', } ] } diff --git a/docs/zh/devices/index.md b/docs/zh/devices/index.md index 2f14fcec..524f99aa 100644 --- a/docs/zh/devices/index.md +++ b/docs/zh/devices/index.md @@ -1,5 +1,12 @@ # 如意SDK集成的RISC-V设备 +如意SDK对RISC-V设备的集成和支持主要包括以下几个方面： + +1. 提供RISC-V 开发板适用镜像信息维护与下载、开发板系统安装引导程序，方便 RISC-V 开发者获取指定开发板可用的OS并可方便的安装OS的安装。如意SDK集成了多种可用的操作系统供用户选择。 +2. 提供RISC-V 开发板对应的演示程序、开发资料和相关工具（含适用的编译工具链、模拟器等）的信息维护和下载，方便 RISC-V 开发者快速上手。 +3. 在集成开发环境中增加RISC-V设备专有向导页面、实现开发环境和运行环境的文件传输、支持在RISC-V设备上调试应用程序等。 + + ## 支持的RISC-V设备 目前已经集成的RISC-V设备有： @@ -20,16 +27,8 @@ 可以通过下载安装最新的如意包管理器工具并执行以下命令为设备安装系统： -``` -bash +```bash $ ruyi device provision ``` 按照引导信息一步步执行即可。 - - -> 如意SDK对RISC-V设备的集成和支持主要包括以下几个方面： -> -> 1. 提供RISC-V 开发板适用镜像信息维护与下载、开发板系统安装引导程序，方便 RISC-V 开发者获取指定开发板可用的OS并可方便的安装OS的安装。如意SDK集成了多种可用的操作系统供用户选择。 -> 2. 提供RISC-V 开发板对应的演示程序、开发资料和相关工具（含适用的编译工具链、模拟器等）的信息维护和下载，方便 RISC-V 开发者快速上手。 -> 3. 在集成开发环境中增加RISC-V设备专有向导页面、实现开发环境和运行环境的文件传输、支持在RISC-V设备上调试应用程序等。 diff --git a/docs/zh/ruyi/getstarted/index.md b/docs/zh/ruyi/getstarted/index.md index 094e4421..21c597f4 100644 --- a/docs/zh/ruyi/getstarted/index.md +++ b/docs/zh/ruyi/getstarted/index.md @@ -18,13 +18,7 @@ $ sudo apt-get install wget git tar bzip2 xz zstd ## 安装 RUYI 包管理器 -从发布[镜像](https://mirror.iscas.ac.cn/ruyisdk/ruyi/testing/)中选择合适架构的预编译二进制下载，当前 RUYI 包管理支持 amd64 和 riscv64 架构编译环境。 - -v0.2 版本的稳定二进制为 0.2.0-beta.20231211 版本。 - -**注意： v0.5.0 版本已经发布，查看 [v0.5.0 版本新增特性](/zh/ruyi/updates/0.5.0)** - -**除了 RuyiSDK mirror 下载，亦可以从 [Github Release](https://github.com/ruyisdk/ruyi/releases) 下载** +从 [GitHub Releases](https://github.com/ruyisdk/ruyi/releases/) 或 [ISCAS 镜像源](https://mirror.iscas.ac.cn/ruyisdk/ruyi/releases)下载最新版本，选择合适架构的预编译二进制下载，当前 RUYI 包管理支持 amd64 、arm64、 riscv64 架构编译环境。 这里以 amd64 架构环境为例进行安装： @@ -39,7 +33,7 @@ All rights reserved. License: Apache-2.0 ``` -``ruyi version`` 应当可以正常打印版本信息。注意二进制的文件名必须为 ``ruyi`` 。 +``ruyi version`` 应当可以正常打印版本信息。**注意二进制的文件名必须为** ``ruyi``。 列出帮助信息： @@ -75,6 +69,8 @@ $ ruyi update 软件包缓存将存放在用户目录中，通常为 ``~/.cache/ruyi`` ；在 ``XDG_CACHE_HOME`` 环境变量被设置时，目录为 ``$XDG_CACHE_HOME/ruyi`` 。 在本文档中家目录为 ``/home/myon`` 。 +### 查询可用软件包 + 查看可用的软件包，该命令将列出所有可用的软件包： ```bash @@ -103,7 +99,7 @@ List of available packages: - 17.0.5-ruyi.20231121 (latest) slug: llvm-upstream-20231121 ``` -从输出可以看到软件包共分为三种，其中 ``source`` 代表了软件源码包， ``toolchain`` 代表了工具链二进制包， ``emulator`` 代表了模拟器二进制包。 +软件包前缀表示分类，其中 ``source`` 代表软件源码包， ``toolchain`` 代表工具链二进制包， ``emulator`` 代表模拟器二进制包，`board-image` 代表开发板镜像，`analyzer` 代表分析工具。 如果软件包显示 “no binary for current host” 则该软件包的当前版本不支持本机架构。 @@ -113,6 +109,21 @@ List of available packages: $ ruyi list -v ``` +### 查询可用编译环境 + +与python 的虚拟环境类似，RUYI 包管理器工具使用 ``venv`` 命令应用配置到指定的工具链以建立编译环境。 + +RUYI 包管理预置的配置可以使用 ``ruyi list profiles`` 命令查看： + +```bash +$ ruyi list profiles +generic +baremetal-rv64ilp32 (needs flavor(s): {'rv64ilp32'}) +sipeed-lpi4a (needs flavor(s): {'xthead'}) +milkv-duo +``` + + ### 安装软件包 使用 ``install`` 命令安装软件包，如 GNU 上游工具链： @@ -121,6 +132,17 @@ $ ruyi list -v $ ruyi install gnu-upstream ``` +上述通过指定软件包名安装的方式默认会安装 latest 的 gnu-upstream，如果想安装某个历史版本的gnu-upstream，则可以通过指定版本来安装： + +```bash +$ ruyi install 'gnu-upstream(0.20231118.0)' +$ ruyi install 'gnu-upstream(==0.20231118.0)' + +# match_expr parameter should be in format ``, where `` is one of ['<', '>', '==', '<=', '>=', '!=']. +``` + + + 若希望重装一个软件包，则可以加上 ``--reinstall`` 参数： ```bash diff --git a/docs/zh/ruyi/index.md b/docs/zh/ruyi/index.md index 5fee1a2a..c5d1e3db 100644 --- a/docs/zh/ruyi/index.md +++ b/docs/zh/ruyi/index.md @@ -1,10 +1,14 @@ # RUYI 包管理器 -RUYI 包管理是 RuyiSDK 开发中的包管理器。用于管理工具链、模拟器、源码等各种二进制软件包和源码包。 +RUYI 包管理是 RuyiSDK中负责管理RUYISDK各种软件源的工具，用于管理工具链、模拟器、源码等各种二进制软件包和源码包。 + +- 官方仓库：https://github.com/ruyisdk/ruyi +- 下载地址：可在 [GitHub Releases](https://github.com/ruyisdk/ruyi/releases/) 或 [ISCAS 镜像源](https://mirror.iscas.ac.cn/ruyisdk/ruyi/releases)下载最新版本体验 +- 需求与问题：如意包管理器的问题和需求可以通过[仓库issue](https://github.com/ruyisdk/ruyi/issues)反馈 ## 支持的发行版平台 -当前 RUYI 包管理器 v0.2 版本在以下平台进行了测试 +当前 RUYI 包管理器具有良好的平台兼容性以及多发行版兼容性，目前经过测试可用的环境有（仅限验证过的）： + x86_64 Fedora 38 + x86_64 Ubuntu 22.04 LTS @@ -12,30 +16,49 @@ RUYI 包管理是 RuyiSDK 开发中的包管理器。用于管理工具链、模 + riscv64 RevyOS 20231210 + riscv64 openEuler 23.09 +上述操作系统链接参考本文文末的“附:外部链接”章节。 + ## 命令 RUYI 目前支持的命令如下： ```bash -ruyi list -# 从本地软件包缓存中列出可用软件包 -ruyi list profiles -# 列出已安装的配置 -ruyi update # 从配置的软件源更新本地软件包缓存 -ruyi install +ruyi update + +# 从本地软件包缓存中列出可用软件包 +ruyi list + # 下载并安装指定的软件包 -ruyi venv +ruyi install + +# 列出已安装的配置 +ruyi list profiles + # 由指定的工具链和配置建立 RUYI 虚拟环境 -ruyi extract +ruyi venv + # 下载并解包指定的源码包 -ruyi admin +ruyi extract + +# 获取并查看更新信息 +ruyi news + +# 镜像信息的维护与下载、开发板系统的安装引导 +ruyi device + # ruyi 镜像搭建工具（完善中） -ruyi self uninstall +ruyi admin + # 卸载 RUYI 包管理器 +ruyi self uninstall + ``` -## 外部链接 +功能持续更新中，可以通过 `ruyi -h` 查看 ruyi 支持的命令。 + + +## 附:外部链接 + [Fedora38 Workstation](https://download.fedoraproject.org/pub/fedora/linux/releases/38/Workstation/x86_64/iso/) + [RevyOS 20231210](https://mirror.iscas.ac.cn/revyos/extra/images/lpi4a/20231210/) diff --git a/docs/zh/ruyi/mirrors/index.md b/docs/zh/ruyi/mirrors/index.md deleted file mode 100644 index ecd60b7b..00000000 --- a/docs/zh/ruyi/mirrors/index.md +++ /dev/null @@ -1,20 +0,0 @@ -# 用户软件源搭建 - -软件源搭建功能在 v0.2 尚未开发完全，仅有建立 manifest 的功能。 - -建立 manifest ： - -```bash -$ ruyi admin manifest ./source/zlib-ng-2.1.5.tar.gz -[ - { - "name": "zlib-ng-2.1.5.tar.gz", - "size": 2410601, - "checksums": { - "sha512": "9212d87c63a2da4e5355a7a1c75380aeba40fbd0ea3d71d3784cb3eac94237f9bea2a1b7993a08f39d4197725c4c133087d3a9d213d3944aa48a7559de2be920", - "sha256": "3f6576971397b379d4205ae5451ff5a68edf6c103b2f03c4188ed7075fbb5f04" - } - } -] -``` -