kevin/asdf
1
Fork 0
mirror of https://github.com/asdf-vm/asdf.git synced 2024-11-15 01:28:17 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: further notes on disabling plugin repo (#1282)

Browse Source
This commit is contained in:
James Hegedus 2022-06-30 11:06:41 +10:00 committed by GitHub
parent 18caea3eb7
commit 624aede7f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
defaults
View File

@ -1,2 +1,7 @@
# enables the use of .ruby-version like files used by other version managers # See the docs for explanations: https://asdf-vm.com/manage/configuration.html
legacy_version_file = no legacy_version_file = no
use_release_candidates = no
always_keep_download = no
plugin_repository_last_check_duration = 60
disable_plugin_short_name_repository = no

18
docs/manage/configuration.md
View File

@ -54,13 +54,7 @@ Edit the file directly or use `asdf local` (or `asdf global`) which updates it.
Add an `.asdfrc` file to your home directory and asdf will use the settings specified in the file. The file below shows the required format with the default values to demonstrate: Add an `.asdfrc` file to your home directory and asdf will use the settings specified in the file. The file below shows the required format with the default values to demonstrate:
```:no-line-numbers @[code :no-line-numbers](../../defaults)
legacy_version_file = no
use_release_candidates = no
always_keep_download = no
plugin_repository_last_check_duration = 60
disable_plugin_short_name_repository = no
```
### `legacy_version_file` ### `legacy_version_file`
@ -106,6 +100,12 @@ Sync events occur when the following commands are executed:
`asdf plugin add <name> <git-url>` does NOT trigger a plugin sync. `asdf plugin add <name> <git-url>` does NOT trigger a plugin sync.
::: warning Note
Setting the value to `never` does not stop the plugin repository from being initially synced, for that behaviour see `disable_plugin_short_name_repository`.
:::
### `disable_plugin_short_name_repository` ### `disable_plugin_short_name_repository`
Disable synchronization of the asdf plugin short-name repository. Sync events will exit early if the short-name repository is disabled. Disable synchronization of the asdf plugin short-name repository. Sync events will exit early if the short-name repository is disabled.
@ -113,7 +113,7 @@ Disable synchronization of the asdf plugin short-name repository. Sync events wi
| Options | Description | | Options | Description |
| :--------------------------------------------------------- | :-------------------------------------------------------- | | :--------------------------------------------------------- | :-------------------------------------------------------- |
| `no` <Badge type="tip" text="default" vertical="middle" /> | Clone or update the asdf plugin repository on sync events | | `no` <Badge type="tip" text="default" vertical="middle" /> | Clone or update the asdf plugin repository on sync events |
| `yes` | Disable short-name plugin repository | | `yes` | Disable the plugin short-name repository |
Sync events occur when the following commands are executed: Sync events occur when the following commands are executed:
@ -124,6 +124,8 @@ Sync events occur when the following commands are executed:
::: warning Note ::: warning Note
Disabling the plugin short-name repository does not remove the repository if it has already synced. Remove the plugin repo with `rm --recursive --trash $ASDF_DATA_DIR/repository`.
Disabling the plugin short-name repository does not remove plugins previously installed from this source. Plugins can be removed with `asdf plugin remove <name>`. Removing a plugin will remove all installed versions of the managed tool. Disabling the plugin short-name repository does not remove plugins previously installed from this source. Plugins can be removed with `asdf plugin remove <name>`. Removing a plugin will remove all installed versions of the managed tool.
::: :::