partitions feature documentation #763
Conversation
mattculler
force-pushed
the
work/CRAFT-3030-document-partitions
branch
from
3b75ba9
to
9c559b5
Compare
Co-authored-by: Callahan <[email protected]>
mattculler
force-pushed
the
work/CRAFT-3030-document-partitions
branch
from
221bd37
to
2111397
Compare
| @@ -90,6 +90,22 @@ to the ``bin`` directory in the staging area and renamed to ``hello``: | |||
| organize: | |||
| hello.py: bin/hello | |||
|
|
|||
| If partitions are in use by the application, they may be referenced by prepending the partition name, surrounded by parentheses, to the destination path. Only the destination path may specify a partition; source paths always reference the ``default`` partition. Omitting the partition name in the destination path causes the file to be copied to the ``default`` partition. | |||
There was a problem hiding this comment.
Stuff that mentions partitions should have a way to ignore them when including the file (e.g. a header so we can have an end_before).
There was a problem hiding this comment.
@lengau I don't understand what you mean. I'm going to mark this resolved for now, I expect to make another pass on the docs as I implement partitions and we can address this then.
There was a problem hiding this comment.
The stuff that's in the common directory gets included in other projects. Rockcraft for example includes these files but doesn't have partitions enabled, so we should have a way to exclude the info about partitions from the Rockcraft docs.
There was a problem hiding this comment.
Ahh ok gotcha, thank you! I'll do this on the next round.
docs/common/craft-parts/reference/partition_specific_output_directory_variables.rst
Outdated
Show resolved
Hide resolved
…rectory_variables.rst Co-authored-by: Alex Lowe <[email protected]>
Write documentation for application developers who want to use partitions.
(CRAFT-3030)