CCSMB-9: Disabling Automatic Updating and Dependency Installation in Lua Programs #25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tomodachi94
added
classification: proposal
DVD-DAVIDE
reviewed
Sep 10, 2023
scmcgowen
suggested changes
Nov 27, 2023
tomodachi94
added
status: response from author needed
tomodachi94
added
status: reviews needed
DVD-DAVIDE
requested changes
Mar 24, 2024
tomodachi94
removed
the
status: work in progress
EmmaKnijn
requested changes
Mar 28, 2024
| # CCSMB 9: Disabling Automatic Updating and Dependency Installation in Lua Programs | ||
|
|
||
| *Author: Tomodachi94 <@tomodachi94>* | ||
|
|
There was a problem hiding this comment.
I think we should add the text referring to RFC 2119 at the top here if we're gonna use the keywords
|
|
||
| ### Global variable | ||
|
|
||
| Compliant programs MUST allow disabling autoupdating through the `CCSMB_ENABLE_AUTOUPDATING` global variable. If the global is set to `false`, autoupdating MUST be disabled. If the variable is unset, compliant programs MAY choose to enable or disable autoupdating for itself. |
There was a problem hiding this comment.
And what if the global variable is true? I think this should also be defined
| Programs implementing autoinstallation of dependencies MUST implement all options listed below in order to be considered compliant. | ||
|
|
||
| ### `settings` API setting | ||
| Compliant programs MUST allow disabling dependency installation through the `ccsmb.dependencyInstallation.enable` setting. If the option is set to `true`, autoinstallation of dependencies MUST be disabled. If the option is unset, compliant programs MAY choose to enable or disable dependency installation for itself. |
There was a problem hiding this comment.
And if its false?
I may be annoying about this but I think all options should be clearly defined
|
|
||
| ### Global variable | ||
|
|
||
| Compliant programs MUST allow disabling autoinstallation of dependencies through the `CCSMB_ENABLE_DEPENDENCY_INSTALLATION` global variable. If the global is set to `false`, autoupdating MUST be disabled. If the option is unset, compliant programs MAY choose to enable or disable dependency installation for itself. |
There was a problem hiding this comment.
And here too, if its set to true the behaviour should be defined.
| Programs implementing an autoupdater MUST implement all options listed below in order to be considered compliant. | ||
|
|
||
| ### `settings` API setting | ||
| Compliant programs MUST allow disabling autoupdating through the `ccsmb.autoupdate.enable` setting. If the option is set to `false`, autoupdating MUST be disabled. If the option is unset, compliant programs MAY choose to enable or disable autoupdating for itself. |
There was a problem hiding this comment.
Here too we should probably define what happens if its true
| Programs implementing autoinstallation of dependencies MUST implement all options listed below in order to be considered compliant. | ||
|
|
||
| ### `settings` API setting | ||
| Compliant programs MUST allow disabling dependency installation through the `ccsmb.dependencyInstallation.enable` setting. If the option is set to `true`, autoinstallation of dependencies MUST be disabled. If the option is unset, compliant programs MAY choose to enable or disable dependency installation for itself. |
There was a problem hiding this comment.
If its set to true, it should be enabled, not disabled, its way more clear
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The title says it all. (I hope?)
See the Rationale section for rationale.