Skip to content

Docs: local Modules requested with path: in modules.yaml - #33

Open
Jiu-xiao wants to merge 1 commit into
devfrom
docs/local-modules-20261110
Open

Jiu-xiao wants to merge 1 commit into
devfrom
docs/local-modules-20261110

Conversation

@Jiu-xiao

Copy link
Copy Markdown
Member

Adds a "本地模块 / Local Modules" section to the module requests page (proj_man/setup.md, Chinese and English) for the local Modules of XRobot 1.0.2 (xrobot-org/XRobot#115).

  • How a folder is requested with path: in modules.yaml, its id local/<folder name>, which paths are rejected, and xrobot module add --path / xrobot module remove local/<Name>.
  • Committing an in-tree local Module: the .gitignore check and the !/Modules/local/ line after /Modules/*/; the warnings for a nested .git and for a folder outside the BSP.
  • Dependencies of a local Module, the local section of xrobot.lock, the generated Modules/CMakeLists.txt, and what --frozen, --offline, --update, --leave-local and --release-ref do with local Modules.

The command output on the page was produced with the XRobot branch of #115 on a BSP copy. The site builds in both locales without broken links or anchors.

The page describes 1.0.2 behavior, so this should merge when XRobot 1.0.2 is released.

This branch has not been deployed

No deployments
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