Add build-package description to docs/snapcraft-sytax.md #246

Merged
merged 1 commit into from Jan 21, 2016

Conversation

Projects
None yet
2 participants
Member

kyrofa commented Jan 21, 2016

This PR resolves LP: #1536659 by adding a description of build-packages to docs/snapcraft-syntax.md.

@kyrofa kyrofa changed the title from docs/snapcraft-sytax.md needs to include build-packages. to Add build-package description to docs/snapcraft-sytax.md Jan 21, 2016

docs/snapcraft-syntax.md
+ A list of Ubuntu packages to use that would support the part creation.
+ * `build-packages` (list of strings)
+ A list of Ubuntu packages to be installed on the host to aid in building
+ the part but not going into the final snap.
@elopio

elopio Jan 21, 2016

Member

I think this sentence is a little to long. Maybe a period after "to aid in building the part", and "These packages will not go into the final snap." as a separate sentence.

@kyrofa

kyrofa Jan 21, 2016

Member

Agreed. Fixed here and from where I stole it ;) .

Member

elopio commented Jan 21, 2016

👍 just one suggestion to split the sentence added.

Add build-package description to docs/snapcraft-sytax.md
Currently docs/snapcraft-syntax.md only discusses stage-packages,
which makes it difficult to determine what build-packages does.

LP: #1536659

Signed-off-by: Kyle Fazzari <kyle@canonical.com>
Member

kyrofa commented Jan 21, 2016

Fixed, thanks @elopio!

kyrofa added a commit that referenced this pull request Jan 21, 2016

Merge pull request #246 from kyrofa/bugfix/1536659/mention_build_pack…
…ages_in_docs

Add build-package description to docs/snapcraft-sytax.md

@kyrofa kyrofa merged commit 4999cfe into snapcore:master Jan 21, 2016

1 of 2 checks passed

coverage/coveralls Coverage decreased (-0.0%) to 90.522%
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@kyrofa kyrofa deleted the kyrofa:bugfix/1536659/mention_build_packages_in_docs branch Jan 21, 2016

kalikiana pushed a commit to kalikiana/snapcraft that referenced this pull request Apr 6, 2017

Merge pull request #246 from kyrofa/bugfix/1536659/mention_build_pack…
…ages_in_docs

Add build-package description to docs/snapcraft-sytax.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment