]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Update .gitignore with LSP files
authorTodd Short <todd.short@me.com>
Fri, 30 Jun 2023 21:28:16 +0000 (17:28 -0400)
committerPauli <pauli@openssl.org>
Sun, 2 Jul 2023 06:51:54 +0000 (16:51 +1000)
This does not provide files for LSP support, but ignores them so they
aren't accidentally checked in by developers.

LSP (Language Server Protocol) is a tools that can be used with various
editors to make navigating source code easier. It is more advanced than
`cscope` and supports completion, for example.

A common LSP for C/C++ is `clangd`, and it creates a `.cache` directory
within the project to store data.

The tool `bear` can be used with `make` to assist `clangd` in
determining where the source code is (specifically headers). This is
critical as OpenSSL uses the `<>` form of `#include` rather than the
`""` form. The `<>` form will cause `clangd` to look in e.g.
`/usr/include` for header files, rather than `include/openssl`. The
`bear` tool will create `compile_commands.json` that `clangd` can use
to find include files.

Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/21338)

.gitignore

index a6b0ab4de9bb0e637e3411f26c39e9e7b68fd0bd..68522d40e75da7d42bbf7db6832dd1450d862dbb 100644 (file)
@@ -245,3 +245,7 @@ MAKE0[0-9][0-9][0-9].@@@
 # Windows manifest files
 *.manifest
 doc-nits
+
+# LSP (Language Server Protocol) support
+.cache/
+compile_commands.json