Skip to content

docs: 优化根目录下 make help 表现 #1828

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mistcoversmyeyes wants to merge 1 commit into
base: master
Choose a base branch
from
+19 −10
Open

docs: 优化根目录下 make help 表现 #1828

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 19 additions & 10 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,16 +348,22 @@ help:
@echo " make docker - Docker编译，并写入磁盘镜像"
@echo ""
@echo "编译并运行:"
@echo " make run-docker - Docker编译，写入磁盘镜像，并在QEMU中运行"
@echo " make run - 本地编译，写入磁盘镜像，并在QEMU中运行"
@echo " make run-nographic - 本地编译，写入磁盘镜像，以nographic方式运行"
@echo " make run-docker - Docker编译，写入磁盘镜像，并在QEMU中运行"
@echo " make run-uefi - 以uefi方式启动运行"
@echo ""
@echo "运行:"
@echo " make qemu - 不编译，直接从已有的磁盘镜像启动运行"
@echo " make qemu-virtiofs-nographic - 不编译，以nographic方式启动并启用virtiofs设备"
@echo " make qemu-nographic - 不编译，以nographic方式启动运行"
@echo " make qemu-uefi - 不编译，直接从已有的磁盘镜像以UEFI启动运行"
@echo " make qemu-virtiofs-nographic - 不编译，以nographic方式启动并启用virtiofs设备"
@echo " make virtiofsd - 启动virtiofsd（读取tools/virtiofs/env.sh）"
@echo ""
@echo "磁盘镜像:"
@echo " make write_diskimage - 写入磁盘镜像（Legacy BIOS）"
@echo " make write_diskimage-uefi - 写入磁盘镜像（UEFI）"
@echo " make rootfs - 使用Nix构建RootFS磁盘镜像"
@echo ""
@echo "注: 对于上述的run, run-uefi, qemu, qemu-uefi命令可以在命令后加上-vnc后缀,来通过vnc连接到DragonOS, 默认会在5900端口运行vnc服务器。如：make run-vnc "
@echo ""
Expand All @@ -367,21 +373,24 @@ help:
@echo "调试:"
@echo " make gdb - 启动GDB调试"
@echo ""
@echo "测试:"
@echo " make test-syscall - 构建运行并执行syscall测试"
@echo " - 可通过DISK_SAVE_MODE=1启用磁盘节省模式"
@echo " make test-dunit - 构建运行并执行dunitest测试"
@echo " - 可通过DISK_SAVE_MODE=1启用磁盘节省模式"
@echo " make test-dunit-local - 本地运行 dunitest 测例"
@echo ""
@echo "其他:"
@echo " make clean - 清理编译产生的文件"
@echo " make fmt - 格式化代码"
@echo " make log-monitor - 启动日志监控"
@echo " make docs - 生成文档"
@echo " make clean-docs - 清理文档"
@echo " make test-syscall - 构建运行并执行syscall测试"
@echo " - 可通过DISK_SAVE_MODE=1启用磁盘节省模式"
@echo " make test-dunit - 构建运行并执行dunitest测试"
@echo " - 可通过DISK_SAVE_MODE=1启用磁盘节省模式"
@echo " make test-dunit-local - 本地运行 dunitest 测例"
@echo " make update-submodules - 更新子模块"
@echo " make update-submodules-by-mirror - 从镜像更新子模块"
@echo ""
@echo "环境变量:"
@echo " ARCH=<arch> - 目标架构（默认见env.mk）"
@echo " DISK_SAVE_MODE=1 - 启用磁盘节省模式，在写入磁盘镜像前清理构建缓存"
@echo " ROOTFS_MANIFEST=name - 选择 config/rootfs-manifests 下的清单（默认 default）"
@echo ""
@echo " make update-submodules - 更新子模块"
@echo " make update-submodules-by-mirror - 从镜像更新子模块"
@echo " SKIP_GRUB=1 - 跳过grub自动安装（CI环境或nographic模式）"
Loading