-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
chore(config): Document all configuration options #4579
Conversation
Let me know if I missed any setting |
force-update: Force apps updating to bucket's version
shim: Choose scoop shim builds
rootPath: Root path of scoop, default '$env:USERPROFILE\scoop'
globalPath: Global root path of scoop, default '$env:ProgramData\scoop'
cachePath: Cache path of scoop, default '$rootPath\cache' |
Can we actually use variables in the config values? Will scoop do a string substitution on them? |
Environment Variables could be used, but other local variables should not. |
Then |
Yes, it is the default value, but user cannot set as is. |
Right.
in the help doc, users will think it's okay to use variables. So we should either leave it empty (and write default value in description), or write an example valid path here. |
Use |
@niheaven done |
Should we also document environment variables used by scoop? Like SCOOP and SCOOP_CHECKVER_TOKEN. Are there any more? |
In wiki or homepage, IMO.
|
Updated the Readme 👍 |
Related PRs: - #4531 @filmor - ac71fcc @niheaven - #4535 @rashil2000 - #4522 @pratikpc - #4550 @niheaven - #4528 @niheaven - #4532 @MrNuggelz - #4155 @MrNuggelz Co-authored-by: @rashil2000 - #4581 @niheaven - fb496c4 @rashil2000 - #4543 @rashil2000 Co-authored-by: @niheaven - #4555 @rashil2000 - 3c90d1a @rashil2000 - 2ec00d5 @rashil2000 - #4567 @rashil2000 - cbe29ed @rashil2000 - #4570 @niheaven - #4582 @niheaven - #4571 @niheaven - #3244 @nickbudi - #3821 @jfastnacht Co-authored-by: @rasa - #4578 @tukanos - #4579 @rashil2000 Co-authored-by: Hsiao-nan Cheung <niheaven@gmail.com> Co-authored-by: Rashil Gandhi <46838874+rashil2000@users.noreply.github.com> Co-authored-by: Jakub Čábera <cabera.jakub@gmail.com> Co-authored-by: Ross Smith II <ross@smithii.com> Co-authored-by: Benedikt Reinartz <filmor@gmail.com> Co-authored-by: Joris <MrNuggelz@users.noreply.github.com> Co-authored-by: Pratik Chowdhury <pratikc@live.co.uk> Co-authored-by: Rashil Gandhi <rashil2000@gmail.com> Co-authored-by: nickbudi <nickbudi@users.noreply.github.com> Co-authored-by: Julian <github@fastnacht.consulting> Co-authored-by: tukanos <patrik.svestka@gmail.com>
* chore(config): Document all configuration options * Update README.md * Update scoop-config.ps1 * Update scoop-config.ps1 * Update scoop-config.ps1 * Add env vars
Related PRs: - ScoopInstaller#4531 @filmor - ac71fcc @niheaven - ScoopInstaller#4535 @rashil2000 - ScoopInstaller#4522 @pratikpc - ScoopInstaller#4550 @niheaven - ScoopInstaller#4528 @niheaven - ScoopInstaller#4532 @MrNuggelz - ScoopInstaller#4155 @MrNuggelz Co-authored-by: @rashil2000 - ScoopInstaller#4581 @niheaven - fb496c4 @rashil2000 - ScoopInstaller#4543 @rashil2000 Co-authored-by: @niheaven - ScoopInstaller#4555 @rashil2000 - 3c90d1a @rashil2000 - 2ec00d5 @rashil2000 - ScoopInstaller#4567 @rashil2000 - cbe29ed @rashil2000 - ScoopInstaller#4570 @niheaven - ScoopInstaller#4582 @niheaven - ScoopInstaller#4571 @niheaven - ScoopInstaller#3244 @nickbudi - ScoopInstaller#3821 @jfastnacht Co-authored-by: @rasa - ScoopInstaller#4578 @tukanos - ScoopInstaller#4579 @rashil2000 Co-authored-by: Hsiao-nan Cheung <niheaven@gmail.com> Co-authored-by: Rashil Gandhi <46838874+rashil2000@users.noreply.github.com> Co-authored-by: Jakub Čábera <cabera.jakub@gmail.com> Co-authored-by: Ross Smith II <ross@smithii.com> Co-authored-by: Benedikt Reinartz <filmor@gmail.com> Co-authored-by: Joris <MrNuggelz@users.noreply.github.com> Co-authored-by: Pratik Chowdhury <pratikc@live.co.uk> Co-authored-by: Rashil Gandhi <rashil2000@gmail.com> Co-authored-by: nickbudi <nickbudi@users.noreply.github.com> Co-authored-by: Julian <github@fastnacht.consulting> Co-authored-by: tukanos <patrik.svestka@gmail.com>
Description
Motivation and Context
Closes #2270
How Has This Been Tested?
Checklist: