Skip to content

docs(contest2026): add --git-lfs flag to repo init command in contest docs - #644

Open
yanxingyu17 wants to merge 1 commit into
open-vela:dev-ai-contest-2026from
yanxingyu17:docs/contest-fix-lfs-git-lfs-flag
Open

docs(contest2026): add --git-lfs flag to repo init command in contest docs#644
yanxingyu17 wants to merge 1 commit into
open-vela:dev-ai-contest-2026from
yanxingyu17:docs/contest-fix-lfs-git-lfs-flag

Conversation

@yanxingyu17

@yanxingyu17 yanxingyu17 commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Background

A contestant reported a build failure: after following the contest code submission guide (repo init + repo sync), compilation failed with libgui_wrapper.a missing / link error.

Root cause: The libs_openvela_vela repository (manifest entry vendor/openvela/boards/vela/libs) hosts 5 prebuilt libraries (libgui_wrapper.a x3, libquickapp.a x2, ~708MB total) via Git LFS. When repo init is run without --git-lfs, repo writes filter.lfs.smudge=git-lfs smudge --skip into each project, so LFS files are checked out as 134-byte pointer files instead of the real binaries -> link failure.

The quickstart guide (zh-cn/quickstart/openvela_ubuntu_quick_start.md) already includes --git-lfs in its repo init command, but the contest submission guide and contest overview omitted it, so contestants following the contest docs hit the issue.

Changes

File Change
zh-cn/contest_2026/code_submission_guide.md Add --git-lfs flag to the repo init command
zh-cn/contest_2026/contest_overview.md Add a note in the "Fetch the project" step about the required --git-lfs flag and why

Verification

  • libs_openvela_vela .gitattributes confirms the 5 files are LFS-tracked (verified locally)
  • Correct LFS object URL returns HTTP 200 (197MB real binary exists)
  • In non-TTY environments git lfs pull prints no output but does download (708MB @ ~90KB/s takes 1-2 hours)

… docs

The libs_openvela_vela repo stores prebuilt libraries (e.g. libgui_wrapper.a,
~197MB each, 5 files totaling ~708MB) via Git LFS. Without the --git-lfs flag,
repo disables LFS smudge (filter.lfs.smudge=--skip) and only fetches 134-byte
pointer files, causing link failures like 'libgui_wrapper.a' missing during
build. The quickstart guide already includes --git-lfs; align the contest
submission guide and contest overview with it.

Signed-off-by: v-yanxingyu <v-yanxingyu@xiaomi.com>
@yanxingyu17
yanxingyu17 requested review from a team as code owners August 12, 2026 12:19
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