Skip to content

docs: document --region option for ll-builder repo enable-mirror - #1970

Open
muzimu217 wants to merge 1 commit into
OpenAtom-Linyaps:masterfrom
muzimu217:docs/ll-builder-repo-region
Open

muzimu217 wants to merge 1 commit into
OpenAtom-Linyaps:masterfrom
muzimu217:docs/ll-builder-repo-region

Conversation

@muzimu217

Copy link
Copy Markdown
Contributor

问题

ll-builder repo enable-mirror 的手册页(中英文)只记录了 alias 位置参数,缺少 --region 选项的说明。而 ll-cli 与 ll-builder 共用同一份 repo 子命令实现(libs/linglong/src/linglong/common/cli/repo.cpp,通过 apps/ll-builder/src/command_options.h 引入 linglong/common/cli/repo.h),代码中 enable-mirror 已注册 --region REGION 选项(repo.cpp:118-122),且 ll-cli-repo(1) 的中英文文档均已记载该选项(docs/pages/guide/reference/commands/ll-cli/repo.md:122),导致 ll-builder 文档与实际 CLI 能力不一致。

修改

  • docs/pages/guide/reference/commands/ll-builder/repo.md:enable-mirror 子命令补充 --region REGION 选项说明,并新增 ll-builder repo enable-mirror myalias --region CN 示例
  • docs/pages/en/guide/reference/commands/ll-builder/repo.md:同步英文页面

验证证据

  1. 代码侧:libs/linglong/src/linglong/common/cli/repo.cpp:118 处 repoEnableMirror->add_option("--region", ...);apps/ll-builder/src/command_options.h 包含 linglong/common/cli/repo.h,证明 ll-builder 复用该共享实现
  2. 文档侧:修改前 grep 确认 docs/pages/{,en/}guide/reference/commands/ll-builder/repo.md 中 enable-mirror 条目无 --region,而 ll-cli/repo.md 已有对应记载
  3. 占坑排查:遍历当前全部 open PR(fix(package-manager): prevent app removal after extra module failure #1905-fix(cli): preserve --exec after the command separator #1969)的 files 列表,无任何 PR 触碰 ll-builder/repo.md;open issue 中亦无相关报告

Signed-off-by: muzimu217 1278844978@qq.com

The shared repo command implementation (libs/linglong/src/linglong/common/cli/repo.cpp,
used by both ll-cli and ll-builder) registers a --region option on
enable-mirror, and ll-cli-repo(1) already documents it, but
ll-builder-repo(1) omitted it in both Chinese and English pages.

Add the --region option and a --region CN example to both pages.

Signed-off-by: muzimu217 <1278844978@qq.com>
@muzimu217

Copy link
Copy Markdown
Contributor Author

Hi @dengbo11 @ComixHe,昨天提过 #1952 的 triage 请求,还有两个同批的 docs 小修一并挂起数日,麻烦方便时一起看一下:本单是 ll-builder repo 缺 --region 选项的文档说明;另外 #1971 是 gen_deb_source 脚本里的失效仓库链接替换。内容如需调整随时提出,谢谢!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant