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

[Docs] Clarify that write_files creates parent folders #330

Merged
merged 2 commits into from
Apr 28, 2020
Merged

[Docs] Clarify that write_files creates parent folders #330

merged 2 commits into from
Apr 28, 2020

Conversation

awilkins
Copy link
Contributor

Clarify in documentation that write_files will create parent folders
for paths that do not already exist.

This obfuscates what the problem is when people erroneously create
files in /tmp despite the warnings in the documentation not to do so.
People naturally assume that their file is absent because the parent folder
did not exist for it to be created in, causing them to add a runcmd block
to create the folder, even though execution order means that this will not
occur until after write_files have all finished.

Might also consider adding an actual warning in log output if a write_files
block does this.

@OddBloke OddBloke self-assigned this Apr 27, 2020
Copy link
Collaborator

@OddBloke OddBloke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a clear improvement, thank you!

@OddBloke
Copy link
Collaborator

Single line doc change, so not blocking on CLA signature.

@OddBloke OddBloke merged commit b70f110 into canonical:master Apr 28, 2020
@awilkins awilkins deleted the docs/write-files-creates-folders branch July 27, 2020 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants