From 624aede7f3480cd6a8817d5a73b72227e87fa668 Mon Sep 17 00:00:00 2001 From: James Hegedus Date: Thu, 30 Jun 2022 11:06:41 +1000 Subject: [PATCH] docs: further notes on disabling plugin repo (#1282) --- defaults | 7 ++++++- docs/manage/configuration.md | 18 ++++++++++-------- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/defaults b/defaults index 0b0964f5..38227805 100644 --- a/defaults +++ b/defaults @@ -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 +use_release_candidates = no +always_keep_download = no +plugin_repository_last_check_duration = 60 +disable_plugin_short_name_repository = no diff --git a/docs/manage/configuration.md b/docs/manage/configuration.md index 4130c992..c5b8f9ab 100644 --- a/docs/manage/configuration.md +++ b/docs/manage/configuration.md @@ -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: -```:no-line-numbers -legacy_version_file = no -use_release_candidates = no -always_keep_download = no -plugin_repository_last_check_duration = 60 -disable_plugin_short_name_repository = no -``` +@[code :no-line-numbers](../../defaults) ### `legacy_version_file` @@ -106,6 +100,12 @@ Sync events occur when the following commands are executed: `asdf plugin add ` 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 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 | | :--------------------------------------------------------- | :-------------------------------------------------------- | | `no` | 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: @@ -124,6 +124,8 @@ Sync events occur when the following commands are executed: ::: 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 `. Removing a plugin will remove all installed versions of the managed tool. :::