diff options
| author | Evgeni Chasnovski <evgeni.chasnovski@gmail.com> | 2025-08-22 13:41:36 +0300 |
|---|---|---|
| committer | Evgeni Chasnovski <evgeni.chasnovski@gmail.com> | 2025-08-22 13:41:36 +0300 |
| commit | 1ffaaa06c5529b26a97d57caf349eaed02233795 (patch) | |
| tree | 636116fb8184bbb5c98a3dd4671e333d63fc5e3e /runtime/lua/vim/pack.lua | |
| parent | 7acfad226dac148cdf9950684afd35c5d65e6e14 (diff) | |
| download | rneovim-1ffaaa06c5529b26a97d57caf349eaed02233795.tar.gz rneovim-1ffaaa06c5529b26a97d57caf349eaed02233795.tar.bz2 rneovim-1ffaaa06c5529b26a97d57caf349eaed02233795.zip | |
docs(pack): document `$XDG_DATA_HOME/nvim/site` presence in 'packpath'
Problem: Some use cases might lead to `vim.pack.add()` failing to
`:packadd` a plugin because of missing entry in 'packpath'. Like with
`nvim --clean` or manually setting `$XDG_DATA_HOME` during startup.
Solution: Document it. A more proactive approach can be ensuring correct
'packpath' entry, but it is currently somewhat verbose to do (due to
having to adjust for Windows using `\` in 'packpath' entries).
Diffstat (limited to 'runtime/lua/vim/pack.lua')
| -rw-r--r-- | runtime/lua/vim/pack.lua | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/runtime/lua/vim/pack.lua b/runtime/lua/vim/pack.lua index ea3007731d..279d8a1d66 100644 --- a/runtime/lua/vim/pack.lua +++ b/runtime/lua/vim/pack.lua @@ -4,7 +4,9 @@ ---is appreciated, but expect breaking changes without notice. --- ---Manages plugins only in a dedicated [vim.pack-directory]() (see |packages|): ----`$XDG_DATA_HOME/nvim/site/pack/core/opt`. +---`$XDG_DATA_HOME/nvim/site/pack/core/opt`. `$XDG_DATA_HOME/nvim/site` needs to +---be part of 'packpath'. It usually is, but might not be in cases like |--clean| or +---setting |$XDG_DATA_HOME| during startup. ---Plugin's subdirectory name matches plugin's name in specification. ---It is assumed that all plugins in the directory are managed exclusively by `vim.pack`. --- |