Attachment 239687 Details for Bug 269137 – patch for the article Use Language Servers for Development in the FreeBSD Src Tree

[patch] patch for the article Use Language Servers for Development in the FreeBSD Src Tree

0001-Updates-documentation-for-article-freebsd-src-lsp.patch (text/plain), 3.06 KB, created by derik on 2023-01-24 21:47:39 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: derik

Created: 2023-01-24 21:47:39 UTC

Size: 3.06 KB

patch

obsolete

>From 6751a06a560f9cb4328c12e36e831749cb175469 Mon Sep 17 00:00:00 2001
>From: Derik Ramirez <derik@rderik.com>
>Date: Tue, 24 Jan 2023 10:35:25 +0000
>Subject: [PATCH] Updates documentation for article freebsd-src-lsp
>
>This commit includes changes in the article "Use Language Servers for
>Development in the FreeBSD Src Tree". The changes are to clarify that
>the dependencies mentioned in the article can also be installed via
>`pkg` and not only through ports.
>---
> .../en/articles/freebsd-src-lsp/_index.adoc   | 31 +++++++++++++++----
> 1 file changed, 25 insertions(+), 6 deletions(-)
>
>diff --git a/documentation/content/en/articles/freebsd-src-lsp/_index.adoc b/documentation/content/en/articles/freebsd-src-lsp/_index.adoc
>index 8b6647833f..ac916d756e 100644
>--- a/documentation/content/en/articles/freebsd-src-lsp/_index.adoc
>+++ b/documentation/content/en/articles/freebsd-src-lsp/_index.adoc
>@@ -46,13 +46,30 @@ toc::[]
> [[intro]]
> == Introduction
> 
>-This guide is about setting up a FreeBSD src tree with language servers performing source code indexing.
>+This guide is about setting up a FreeBSD src tree with language servers performing source code indexing. The guide describes the steps for Vim/NeoVim and VSCode. If you use a different text editor you can use this guide as a reference and search the equivalent commands for your preferred editor.
> 
>-[[ports-required]]
>-== Required Ports
>+[[requirements]]
>+== Requirements
> 
>-Some ports are required throughout the guide.
>-Choose a favorite combination of tools from each category below:
>+In order to follow this guide we need to install certain requirements. We need a Language server, `ccls` or `clangd`, and optionally a compilation database.
>+
>+The installation of the Language server can be performed via `pkg` or via ports. If we chose `clangd` we need to install `llvm`.
>+
>+Using `pkg` to install `ccls`:
>+
>+[source,shell]
>+....
>+# pkg install ccls
>+....
>+
>+If we want to use `clangd` we need to install `llvm` (The example command uses `llvm15` but choose the version you desire):
>+
>+[source,shell]
>+....
>+# pkg install llvm15
>+....
>+
>+To install via ports choose a favorite combination of tools from each category below:
> 
> * Language server implementations
> ** package:devel/ccls[]
>@@ -114,12 +131,14 @@ au User lsp_setup call lsp#register_server({
> ....
> au User lsp_setup call lsp#register_server({
>     \ 'name': 'clangd',
>-    \ 'cmd': {server_info->['clangd12', '--background-index', '--header-insertion=never']},
>+    \ 'cmd': {server_info->['clangd15', '--background-index', '--header-insertion=never']},
>     \ 'allowlist': ['c', 'cpp', 'objc'],
>     \ 'initialization_options': {},
>     \ })
> ....
> 
>+Depending on the version that you installed for `clangd` you might need to update the `server-info` to point to the correct binary.
>+
> Please refer to link:https://github.com/prabirshrestha/vim-lsp/blob/master/README.md#registering-servers[] to learn about setting up key bindings and code completion.
> The official site of clangd is link:https://clangd.llvm.org[], and the repository link of ccls is link:https://github.com/MaskRay/ccls/[].
> 
>-- 
>2.39.0
>

Actions: View | Diff

Attachments on bug 269137: 239687