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

Environment dir ext #29

Merged
merged 3 commits into from Aug 3, 2018
Merged

Environment dir ext #29

merged 3 commits into from Aug 3, 2018

Conversation

Shinmera
Copy link
Member

This fixes #28 but causes both compatibility and setup breakage.

Please advise.

The new system allows administrators to still control the storage of environment files, although now by supplying additional methods on a common function rather than merely controlling a special variable for the root. The new system also allows further kinds of files, such as generic runtime data and template overrides.

Unfortunately since the locations need to be changed in order to implement useful default locations for the newly distributed systems, we also end up breaking existing setups alongside the backwards compatibility that we lose due to the removal of *environment-root*.

[Compatibility Breaking] [Setup Breaking]
Copy link
Contributor

@jorams jorams left a comment

Choose a reason for hiding this comment

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

This seems like a good solution to the problem. The breakage is regrettable, but long term unavoidable. Maybe for #30 you could have a way to warn the user that they need to make some changes?

(To conform to semantic versioning, this change would be part of Radiance 2.0, but I don't know if you care about that.)

@@ -683,14 +683,6 @@ See DOCUMENTABLE"))

;; environment.lisp
(docs:define-docs
(variable *environment-root*
Copy link
Contributor

@jorams jorams Aug 2, 2018

Choose a reason for hiding this comment

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

Perhaps you could keep *environment-root* as a symbol macro call to keep some existing code working? It would still cause setup breakage though.

Copy link
Member Author

Choose a reason for hiding this comment

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

That sounds very gross. I'd rather just force reliant code to migrate, though I heavily doubt anything except for radiance's bootstrap/launcher scripts has touched this variable.

@Shinmera
Copy link
Member Author

Shinmera commented Aug 2, 2018

I was actually going to use the migration facility to automatically move over configuration files from the previous location to the new one, and inform users to change modules to put data files in the new location, in case they stored any in the config directory.

@Shinmera Shinmera merged commit e52e0fc into master Aug 3, 2018
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.

Data Storage Directory
3 participants