← Back to issue list

Documentation for advanced grammar for sources

View original Github issue

Metadata

Project
snapcraft
Number
#1688
Type
issue
State
closed
Author
sergiusens
Labels
—
Created
Updated
Closed

Current evaluation

Doc-only task closed 2018-01-24: advanced grammar syntax docs merged in canonical-docs/snappy-docs#306 plus kyrofa's follow-up branch; content later migrated in-repo as docs/reference/advanced-grammar.rst by #5462.

Resolution: closed resolved

Reason: This was a documentation request, not a code bug. Maintainers moved the work into the external snappy-docs syntax page (canonical-docs/snappy-docs#306, reviewed 2018-01-11) and kyrofa closed the issue on 2018-01-24 stating "Alright, all merged and good to go." The material survives today as docs/reference/advanced-grammar.rst, brought into this repo by commit b7a56461b ("docs: migrate 'Snapcraft advanced grammar' (#5462)").

Evaluated by: mr-cal-bot

No scores available.

Issue body

Estimate: 1 day Snapcraft currently has a grammar that allows for behavior to change based on, for example, the host architecture. The use of this grammar is slowly making its way across the snapcraft.yaml. Currently the only items supported are lists (e.g. stage-packages and build-packages). Adding support for strings is required to support further expansion (e.g. making the source key grammar-powered).

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Doc-only task closed 2018-01-24: advanced grammar syntax docs merged in canonical-docs/snappy-docs#306 plus kyrofa's follow-up branch; content later migrated in-repo as docs/reference/advanced-grammar.rst by #5462.
stealth/space-bunny-alpha — closed resolved Advanced grammar docs landed in the external snappy-docs repo via canonical-docs/snappy-docs#306 plus kyrofa's follow-up section; kyrofa closed the issue on 2018-01-24 confirming all merged.
stealth/space-bunny-alpha — closed resolved Advanced snapcraft.yaml grammar documentation was added to the syntax page via canonical-docs/snappy-docs#306 and follow-up material; a maintainer confirmed everything merged on 2018-01-24.
qwen/qwen3.6-35b-a3b — — Documentation for advanced grammar in snapcraft.yaml was added to the canonical-docs/snappy-docs repository. The syntax update pull request was reviewed and merged, fulfilling the request to document grammar expansion for strings and sources.
qwen/qwen3.6-35b-a3b — — Resolved via external documentation update. Grammar syntax details were merged into the canonical-docs/snappy-docs repository, adding string support and advanced examples to the build-snaps syntax page.
qwen/qwen3.6-35b-a3b — — Grammar documentation for snapcraft.yaml sources was added to the syntax page. Changes were merged via canonical-docs/snappy-docs pull request 306, fulfilling the request to expand grammar support beyond lists.
qwen3.6-35b-a3b-mtp-q6 — — Documentation for advanced grammar support was added to the canonical-docs/snappy-docs repository. The syntax update pull request merged on January 24, 2018, fulfilling the request to document grammar-powered source keys.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: snappy-docs#306 (confidence 95%)

    Restructured syntax page that carried the advanced grammar documentation cited in the closing comment.

  • Related To: canonical/snapcraft#5462 (confidence 85%)

    Commit b7a56461b migrated the 'Snapcraft advanced grammar' doc into docs/reference/advanced-grammar.rst in this repo.

  • Related To: canonical/snapcraft#1817 (confidence 55%)

    Commit 574cd766d 'grammar: support grammar-powered source' implemented the string/source grammar support this doc issue anticipated.

Related issues

Issue Project State Summary Similarity
#5462 docs: migrate 'Snapcraft advanced grammar' snapcraft merged Merged the advanced grammar documentation migration in commit b7a56461b; follow-up #5468 restored the Read the Docs build in 0157e5b15.
72%