skills/qcom-flash-qdl: do not guess EDL entry for unlisted boards - #31
Conversation
EDL entry differs per board and there is no universal switch, but the skill's EDL step only pointed to the per-board reference without stating that an unlisted board must not be flashed using another board's sequence. A user flashing an Arduino or third-party board (ventuno-q, uno-q, rubikpi3) could copy an EVK's DIP-switch label and fail to enter EDL. Make the "do not guess" rule explicit in the EDL step and direct users of unlisted boards to the board's own Quick Start Guide (docs.qualcomm.com / dragonwingdocs.qualcomm.com). Add an "Arduino / third-party boards" section to references/entering-edl.md pointing at the meta-qcom-arduino and meta-qcom-3rdparty layers and the vendor documentation. Bump skill metadata version to 0.2. Assisted-by: Claude Code:claude-opus-4-8 Signed-off-by: Raul Munoz <raulrm@qti.qualcomm.com>
Qualcomm AI ReviewClick to expand Deep Code ReviewQualcomm AI Deep Code Review AssistantKey Findings SummaryTotal Issues Found: 1 Severity Breakdown:
Issue Categories:
Quick Statistics:
Detailed AnalysisDocumentation Inconsistency Between SKILL.md and Reference GuideSeverity: Medium Problem DescriptionThe main skill documentation contains contradictory information about Arduino and third-party board coverage. SKILL.md explicitly states that these boards are "not listed" in the reference documentation: If your board is not listed there — including Arduino and other third-party
boards (`ventuno-q`, `uno-q`, `rubikpi3`, …) — follow the 'flash images'
section of its Quick Start Guide...However, the reference document Impact Analysis
Recommended FixRemove the misleading parenthetical clause that incorrectly categorizes Arduino and third-party boards as "not listed." This simplifies the guidance while eliminating the contradiction: Before: If your board is not listed there — including Arduino and other third-party
boards (`ventuno-q`, `uno-q`, `rubikpi3`, …) — follow the 'flash images'
section of its Quick Start Guide...After: If your board is not listed there, follow the 'flash images' section of its
Quick Start Guide...Rationale:
Additional ContextThis issue arose during a documentation update that added safety warnings about EDL entry methods. The new Arduino/third-party section was correctly added to the reference guide, but the corresponding mention in the main documentation wasn't updated to reflect this change. This is a common pattern in documentation maintenance where cross-references become stale after updates. Positive AspectsThe pull request demonstrates several documentation best practices: ✅ Clear Safety Guidance: Prominent warnings against guessing EDL entry methods SummaryThis documentation update successfully adds important safety guidance to prevent users from guessing EDL entry methods for unlisted boards. The single inconsistency identified has a straightforward resolution that improves documentation accuracy without changing the functional guidance provided to users. Once the recommended fix is applied, the documentation will provide a clear, consistent path for all users regardless of their board type. |
950b88d
into
qualcomm-linux:main
2 participants
EDL entry is board-specific and there is no universal switch. The EDL step now states "do not guess" explicitly and directs users of unlisted boards — including Arduino / third-party boards (ventuno-q, uno-q, rubikpi3) — to the board's own Quick Start Guide. Adds an "Arduino / third-party boards" section to references/entering-edl.md and bumps the skill version to 0.2.
Companion to #29 (which added those boards to qcom-yocto-build-image).