diff options
| author | William Boman <william@redwill.se> | 2022-06-08 01:36:47 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-08 01:36:47 +0200 |
| commit | 2b2d2141394f95a28cf5dfed922ebecf123d72b1 (patch) | |
| tree | e4962a1f3e45b9dbd619431748aca916caa70dba /doc | |
| parent | feat: add marksman (#760) (diff) | |
| download | mason-2b2d2141394f95a28cf5dfed922ebecf123d72b1.tar mason-2b2d2141394f95a28cf5dfed922ebecf123d72b1.tar.gz mason-2b2d2141394f95a28cf5dfed922ebecf123d72b1.tar.bz2 mason-2b2d2141394f95a28cf5dfed922ebecf123d72b1.tar.lz mason-2b2d2141394f95a28cf5dfed922ebecf123d72b1.tar.xz mason-2b2d2141394f95a28cf5dfed922ebecf123d72b1.tar.zst mason-2b2d2141394f95a28cf5dfed922ebecf123d72b1.zip | |
chore: update some logging (#761)
* chore: update some logging
* docs: add section about known errors
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/nvim-lsp-installer.txt | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/doc/nvim-lsp-installer.txt b/doc/nvim-lsp-installer.txt index 4af71a46..a769166b 100644 --- a/doc/nvim-lsp-installer.txt +++ b/doc/nvim-lsp-installer.txt @@ -284,6 +284,23 @@ GITHUB MIRROR *nvim-lsp-installer-download-mirror-github* }, } + +============================================================================== +INSTALLATION ERRORS *nvim-lsp-installer-errors* + + *nvim-lsp-installer-errors-github-api* +For some installers, the GitHub API is used to fetch information about +releases. This API imposes a rate limit that may be triggered, causing +installations to fail. The reasons why a rate limit is triggered are many, for +example being behind a public API, or using other software that also send +requests to the GitHub API. + +To circumvent this, nvim-lsp-installer will utilize the GitHub CLI when +available, leading to API requests being subject to a much higher rate limit +threshold when authenticated. Should you run into errors with communicating +with GitHub's API, it's recommended to install, and authenticate, the GitHub +CLI: https://cli.github.com/. + ============================================================================== DEBUGGING *nvim-lsp-installer-debugging* @@ -295,7 +312,9 @@ sure to set nvim-lsp-installer's log level to DEBUG or TRACE, like so: } You may find the logs by entering the command `:LspInstallLog`. Providing the -contents of this file when reporting an issue will help tremendously. +contents of this file when reporting an issue will help tremendously. Remember +to redo whatever is failing after changing the log level in order to capture +new log entries. ============================================================================== Lua module: nvim-lsp-installer |