Help documentation for source-subdir is out of date
Metadata
Current evaluation
Updated source-subdir help text to explain that all source is copied and the plugin builddir points to the selected subdirectory in PR #1177 (commit 06275c2b6).
Resolution: closed resolved
Reason: Maintainer kyrofa linked PR snapcore/snapcraft#1177 as the fix; commit 06275c2b6 updated the source-subdir documentation to match the implemented behavior.
Evaluated by: mr-cal-bot
No scores available.
Issue body
`snapcraft help sources` shows the following (snipped for clarity):
source-subdir: path
Snapcraft will checkout the repository or unpack the archive referred
to by the 'source' keyword into parts/<part-name>/src/ but it will only
copy the specified subdirectory into parts/<part-name>/build/
That's not actually true nowadays. It copies the entire parts/<part-name>/src/ into parts/<part-name>/build/ but then sets the plugin's builddir to parts/<part-name>/build/<subdir>. This was changed to fix #1549676, but the documentation was never updated.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Updated source-subdir help text to explain that all source is copied and the plugin builddir points to the selected subdirectory in PR #1177 (commit 06275c2b6). | |
| stealth/space-bunny-alpha | — | closed resolved | Updated source-subdir help to explain that all of src is copied and builddir points to the specified subdirectory; merged in snapcore/snapcraft#1177. | |
| stealth/space-bunny-alpha | — | closed resolved | Updated source-subdir help to describe the full-source copy and builddir subdirectory; merged in canonical/snapcraft#1177 (commit 06275c2b6). | |
| stealth/space-bunny-alpha | — | closed resolved | Updated source-subdir help text in merged PR #1177 (commit 06275c2b6) to describe copying all of src/ and building in build/<subdir>. | |
| qwen/qwen3.6-35b-a3b | — | — | Documentation was updated to reflect the actual source-subdir behavior, correcting the outdated help text. The issue was closed as resolved. | |
| qwen/qwen3.6-35b-a3b | — | — | Abandoned. Documentation for source-subdir remains outdated, failing to reflect that the entire source directory is copied to build/ with the plugin builddir set to the specified subdirectory. |
Update history
| Date | Change |
|---|---|
| created |
Related work
-
Likely Fixed By:
snapcore/snapcraft#1177
(confidence 100%)
The maintainer's closing comment identifies this PR as the documentation fix.
-
Related To:
snapcraft (launchpad)#1549676
(confidence 98%)
That earlier fix changed source-subdir handling but left the help text outdated.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1177 sources: update documentation for source-subdir | snapcraft | merged | Merged docs-only PR #1177 (commit 06275c2b6) by kyrofa corrected the stale source-subdir help text, closing Launchpad bug #1596554. | |
| #427 Using `source-subdir` results in `No such file or directory` | craft-parts | open | Documented behavior: source-subdir sets the plugin build location, but override-build runs from the build root; callers must cd into the subdirectory themselves. |