diff options
| author | Todd Short <todd.short@me.com> | 2023-06-30 17:28:16 -0400 |
|---|---|---|
| committer | Pauli <pauli@openssl.org> | 2023-07-02 16:51:54 +1000 |
| commit | 9e87e4e8ac2c5c75eae0ef1d4208e2aa12ff57dc (patch) | |
| tree | 89ba4676764b7c8e9651fedd6c9394a2d6daba64 /.gitignore | |
| parent | 89111cbc3238dcdf47e921af38d6b12c4b32d326 (diff) | |
Update .gitignore with LSP files
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)
Diffstat (limited to '.gitignore')
| -rw-r--r-- | .gitignore | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore index a6b0ab4de9..68522d40e7 100644 --- a/.gitignore +++ b/.gitignore @@ -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 |