Improve the global config file documentation

lsp/data/lsp.conf

@@ -134,39 +134,46 @@ code_lens_enable=true
 code_lens_style=#000000;#ffff00
 
 
-[Python]
-#*******************************************************************************
-# The command (including parameters) used to start the LSP server. When
-# commented out like below, no server is started for the language.
-#*******************************************************************************
-#cmd=pylsp
+# This is a dummy language server configuration describing the available
+# language-specific options
+[DummyLanguage]
+# The command (including parameters) used to start the LSP server. Instead of
+# starting a new server, it is also possible to reuse other language's server
+# using the 'use' option - see the C++ configuration
+cmd=srvcmd
 # The server can be started with additional environment variables (such as foo
 # with the value bar, and foo1 with the value bar1 like in the example below).
-#env=foo=bar;foo1=bar1
-# The pylsp server seems to work reasonably well without a project directory
-use_outside_project_dir=true
-use_without_project=true
+env=foo=bar;foo1=bar1
 # File containing initialization options of the server.
-#initialization_options_file=/home/some_user/pylsp.json
+initialization_options_file=/home/some_user/init_options.json
 # When defined, performs logging to the specified file where all RPC communication
 # between the client plugin and the server will be stored (can also be 'stdout'
 # or 'stderr')
-#rpc_log=stdout
-#rpc_log_full=false
-
-
-[C]
-#cmd=clangd
-semantic_tokens_enable=true
+rpc_log=stdout
 # Semicolon separated list of character sequences which can trigger autocompletion.
 # Normally, the server defines these but this option can be used to further restrict
 # the list only to some sequences if the server-provided value does not work well.
-autocomplete_trigger_sequences=.;::;->;->*
+autocomplete_trigger_sequences=.;->
 # JSON file containing formatting options defined in
 # https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#formattingOptions
 # containing e.g. { "tabSize": 4, "insertSpaces": false }. Supported only by some
 # language servers.
+formatting_options_file=/home/some_user/my_formatting_config_file.json
+# Additional files and their mappings to LSP language IDs for which the server
+# is used as well. The Nth item in the list is always a LSP language ID and the
+# (N+1)th item is a glob pattern for which the language ID is used
+lang_id_mappings=dummylanguage;*.dummy
+
+
+[C]
+# Comment out the line below to start using the server
+#cmd=clangd
+semantic_tokens_enable=true
+autocomplete_trigger_sequences=.;::;->;->*
 #formatting_options_file=/home/some_user/my_formatting_config_file.json
+#rpc_log=stdout
+#rpc_log_full=false
+#show_server_stderr=true
 
 
 [C++]
@@ -176,12 +183,24 @@ use=C
 
 
 [Go]
+# Comment out the line below to start using the server
 #cmd=gopls
 autocomplete_apply_additional_edits=true
-# Additional files and their mappings to LSP language IDs for which the server
-# is used as well. The Nth item in the list is always a LSP language ID and the
-# (N+1)th item is a glob pattern for which the language ID is used
 lang_id_mappings=go.mod;go.mod;go.sum;go.sum;gotmpl;*tmpl
+#rpc_log=stdout
+#rpc_log_full=false
+#show_server_stderr=true
+
+
+[Python]
+# Comment out the line below to start using the server
+#cmd=pylsp
+use_outside_project_dir=true
+use_without_project=true
+#initialization_options_file=/home/some_user/pylsp.json
+#rpc_log=stdout
+#rpc_log_full=false
+#show_server_stderr=true
 
 
 # TODO: help needed! Only the above defined language servers have been tested