Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

prime and stage key reference should be fleshed out #921

Open
lengau opened this issue Dec 3, 2024 · 2 comments
Open

prime and stage key reference should be fleshed out #921

lengau opened this issue Dec 3, 2024 · 2 comments
Assignees
Labels
Documentation Improvements or additions to documentation Enhancement New feature or request Triaged

Comments

@lengau
Copy link
Contributor

lengau commented Dec 3, 2024

What needs to get done

https://canonical-craft-parts.readthedocs-hosted.com/en/latest/common/craft-parts/reference/part_properties.html#stage

This should at least include an example or two of including only certain files or including some files.

Why it needs to get done

@tmihoc pointed this out due to some user questions on Charmcraft

@lengau lengau added Documentation Improvements or additions to documentation Enhancement New feature or request labels Dec 3, 2024
@lengau lengau added the Triaged label Dec 3, 2024
Copy link

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-3767.

This message was autogenerated

@tmihoc
Copy link
Member

tmihoc commented Dec 4, 2024

Thanks for filing this, @lengau ! I feel the description for each property should also include comments on the value, not just the type. E.g., for prime or stage it should say not just that the type is a string of a certain form but also that it's a path and that you can specify not just paths to be included but also paths to be excluded -- the latter using the symbol -.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation Enhancement New feature or request Triaged
Projects
None yet
Development

No branches or pull requests

3 participants