← Back to issue list

sources: update documentation for source-subdir

View original Github issue

Metadata

Project
snapcraft
Number
#1177
Type
pull request
State
merged
Author
kyrofa
Labels
—
Created
Updated
Closed

Current evaluation

Merged docs-only PR #1177 (commit 06275c2b6) by kyrofa corrected the stale source-subdir help text, closing Launchpad bug #1596554.

Resolution: closed resolved

Reason: The PR was merged into snapcraft master as commit 06275c2b6 ("sources: update documentation for source-subdir (#1177)"), a +2/-3 docstring change clarifying that all of src is copied and builddir points into the given subdirectory. This closed LP bug #1596554, which reported the source-subdir help documentation as out of date.

Evaluated by: mr-cal-bot

No scores available.

Issue body

This PR fixes LP: [#1596554](https://bugs.launchpad.net/snapcraft/+bug/1596554) by updating the long-out-of-date documentation for `source-subdir` to reflect reality.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged docs-only PR #1177 (commit 06275c2b6) by kyrofa corrected the stale source-subdir help text, closing Launchpad bug #1596554.
stealth/space-bunny-alpha — closed resolved Merged #1177 (commit 06275c2b6) updated source-subdir documentation to match current behavior, resolving Launchpad bug #1596554.
qwen/qwen3.6-35b-a3b — — Documentation for source-subdir updated to reflect current behavior, resolving Launchpad bug #1596554. Merged after single reviewer approval with minimal changes to one file.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update for source-subdir that resolves Launchpad bug 1596554. Outdated instructions were corrected to accurately reflect current implementation behavior.

Update history

No update history recorded yet.

Related work

  • Related To: snapcraft (launchpad)#1596554 (confidence 90%)

    Launchpad bug 1596554 "Help documentation for source-subdir is out of date" — the LP bug explicitly fixed by this PR, now closed.

  • Caused By: snapcraft#94 (confidence 55%)

    Earlier merge27e36feed / commit 6beb6fec6 "Copy entire source, even if source-subdir is specified" changed runtime behaviour without updating the docstring, which is what left the docs outdated.

Related issues

Issue Project State Summary Similarity
#1596554 Help documentation for source-subdir is out of date snapcraft (launchpad) closed 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).
81%