From 03a1bd448be99d872d663a57a1cf4492882e090d Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Thu, 25 Apr 2024 04:59:47 +0200 Subject: Adding upstream version 0.1.29. Signed-off-by: Daniel Baumann --- debputy.pod | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) (limited to 'debputy.pod') diff --git a/debputy.pod b/debputy.pod index 6017bf5..933b6d0 100644 --- a/debputy.pod +++ b/debputy.pod @@ -274,6 +274,54 @@ Folding ranges (multi-line comments). Note these features are subject to the editor supporting them, correct language IDs being passed to B, etc. +Options for this subcommand + +=over 4 + +=item B<--ignore-language-ids> + +When provided, B will ignore any language ID that the editor provides for any file. Instead, B +will only rely on the file name for determining how to interpret the file content. + +Since B supports multiple file formats, it is needs to know what kind of file it is working with. The +editor is supposed to provide this via a "Language ID" attribute. This enables you as a user in the editor +to override the file format and have proper editor support no matter the filename. Unfortunately, most Debian +packaging files do not have a language ID assigned in the LSP specification, so editors either provide a +custom language ID or no custom language ID at all (that is, an empty string). + +When the editor does not provide a language ID for file, B will since 0.1.25 automatically attempt +to derive the language from the filename. With this option (introduced in 0.1.29), B will always +derive the language from the filename even if the editor provided a language ID. This can be helpful if your +editor is providing language IDs that B does not recognize. + +As an example, in B with B the language ID is derived from the name of the buffer's major mode. If +you tried to use B with a major mode that B does not recognize then without this +option, B would "silently" do nothing. With this option, it would have worked provided the filename +matched B's expectation no matter the major mode. + +On the downside, B will not provide correct advice unless the paths matches F<< .../debian/I >>. +This can provide issues with some setups where the debian directory is implicit such as some "packaging-only" repos +or some editor scratch pads. + +=item B<--tcp> or B<--ws> + +By default, the B language server will use B for communication with the editor. These options provide +either the TCP integration mode (B<--tcp>) or the websocket integration mode (B<--ws>). In this mode, the B<--host> +and B<--port> options can be used to choose the bind address. + +These options are mutually exclusive. + +The B<--ws> option requires B Debian package. + +=item B<--host> I, B<--port> I + +With B<--tcp> or B<--ws>, these option determines the bind address. The default is 127.0.0.1 for host and 2087 for +the port. + +In integration modes that does not need a bind address (such as the B mode), this option is ignored. + +=back + =item lsp editor-config B Provide an example configuration glue for using the B with the given editor -- cgit v1.2.3