aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgithub-actions <github-actions@github.com>2023-03-15 11:29:58 +0000
committergithub-actions <github-actions@github.com>2023-03-15 11:29:58 +0000
commit94f992cd0571ddfee6a681ab50d8ac187236ed9b (patch)
treedbc430b246177e6784f91fa57d54bcf6cc23dc9f
parentfeat: add vhdl support (#2504) (diff)
downloadnvim-lspconfig-94f992cd0571ddfee6a681ab50d8ac187236ed9b.tar
nvim-lspconfig-94f992cd0571ddfee6a681ab50d8ac187236ed9b.tar.gz
nvim-lspconfig-94f992cd0571ddfee6a681ab50d8ac187236ed9b.tar.bz2
nvim-lspconfig-94f992cd0571ddfee6a681ab50d8ac187236ed9b.tar.lz
nvim-lspconfig-94f992cd0571ddfee6a681ab50d8ac187236ed9b.tar.xz
nvim-lspconfig-94f992cd0571ddfee6a681ab50d8ac187236ed9b.tar.zst
nvim-lspconfig-94f992cd0571ddfee6a681ab50d8ac187236ed9b.zip
docs: update server_configurations.md
skip-checks: true
-rw-r--r--doc/server_configurations.md57
-rw-r--r--doc/server_configurations.txt57
2 files changed, 114 insertions, 0 deletions
diff --git a/doc/server_configurations.md b/doc/server_configurations.md
index e7e59fe2..d9929c4e 100644
--- a/doc/server_configurations.md
+++ b/doc/server_configurations.md
@@ -211,6 +211,7 @@ autogenerated from the Lua files. You can view this file in Nvim by running
- [verible](#verible)
- [veridian](#veridian)
- [veryl_ls](#veryl_ls)
+- [vhdl_ls](#vhdl_ls)
- [vimls](#vimls)
- [visualforce_ls](#visualforce_ls)
- [vls](#vls)
@@ -8990,6 +8991,62 @@ require'lspconfig'.veryl_ls.setup{}
```
+## vhdl_ls
+
+Install vhdl_ls from https://github.com/VHDL-LS/rust_hdl and add it to path
+
+Configuration
+
+The language server needs to know your library mapping to perform full analysis of the code. For this it uses a configuration file in the TOML format named vhdl_ls.toml.
+
+vhdl_ls will load configuration files in the following order of priority (first to last):
+
+ A file named .vhdl_ls.toml in the user home folder.
+ A file name from the VHDL_LS_CONFIG environment variable.
+ A file named vhdl_ls.toml in the workspace root.
+
+Settings in a later files overwrites those from previously loaded files.
+
+Example vhdl_ls.toml
+```
+# File names are either absolute or relative to the parent folder of the vhdl_ls.toml file
+[libraries]
+lib2.files = [
+ 'pkg2.vhd',
+]
+lib1.files = [
+ 'pkg1.vhd',
+ 'tb_ent.vhd'
+]
+```
+
+
+
+**Snippet to enable the language server:**
+```lua
+require'lspconfig'.vhdl_ls.setup{}
+```
+
+
+**Default values:**
+ - `cmd` :
+ ```lua
+ { "vhdl_ls" }
+ ```
+ - `filetypes` :
+ ```lua
+ { "vhd" }
+ ```
+ - `root_dir` :
+ ```lua
+ see source file
+ ```
+ - `single_file_support` :
+ ```lua
+ true
+ ```
+
+
## vimls
https://github.com/iamcco/vim-language-server
diff --git a/doc/server_configurations.txt b/doc/server_configurations.txt
index e7e59fe2..d9929c4e 100644
--- a/doc/server_configurations.txt
+++ b/doc/server_configurations.txt
@@ -211,6 +211,7 @@ autogenerated from the Lua files. You can view this file in Nvim by running
- [verible](#verible)
- [veridian](#veridian)
- [veryl_ls](#veryl_ls)
+- [vhdl_ls](#vhdl_ls)
- [vimls](#vimls)
- [visualforce_ls](#visualforce_ls)
- [vls](#vls)
@@ -8990,6 +8991,62 @@ require'lspconfig'.veryl_ls.setup{}
```
+## vhdl_ls
+
+Install vhdl_ls from https://github.com/VHDL-LS/rust_hdl and add it to path
+
+Configuration
+
+The language server needs to know your library mapping to perform full analysis of the code. For this it uses a configuration file in the TOML format named vhdl_ls.toml.
+
+vhdl_ls will load configuration files in the following order of priority (first to last):
+
+ A file named .vhdl_ls.toml in the user home folder.
+ A file name from the VHDL_LS_CONFIG environment variable.
+ A file named vhdl_ls.toml in the workspace root.
+
+Settings in a later files overwrites those from previously loaded files.
+
+Example vhdl_ls.toml
+```
+# File names are either absolute or relative to the parent folder of the vhdl_ls.toml file
+[libraries]
+lib2.files = [
+ 'pkg2.vhd',
+]
+lib1.files = [
+ 'pkg1.vhd',
+ 'tb_ent.vhd'
+]
+```
+
+
+
+**Snippet to enable the language server:**
+```lua
+require'lspconfig'.vhdl_ls.setup{}
+```
+
+
+**Default values:**
+ - `cmd` :
+ ```lua
+ { "vhdl_ls" }
+ ```
+ - `filetypes` :
+ ```lua
+ { "vhd" }
+ ```
+ - `root_dir` :
+ ```lua
+ see source file
+ ```
+ - `single_file_support` :
+ ```lua
+ true
+ ```
+
+
## vimls
https://github.com/iamcco/vim-language-server