Skip to content

Commit

Permalink
Update docs in preparation for 1.1.0 release (#259)
Browse files Browse the repository at this point in the history
fixes #258
  • Loading branch information
ghentschke authored Feb 20, 2024
1 parent 4fdaf5c commit 8ed9857
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 5 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,11 @@
- First release of CDT LSP

Fixed issues: <https://github.com/eclipse-cdt/cdt-lsp/milestone/1?closed=1>

### v1.1.0 (Feb 2024)

- Added basic spelling support
- Added .clangd configuration file syntax checker
- Added basic clangd LSP extension support for textDocument/ast and textDocument/symbolInfo

Fixed issues: <https://github.com/eclipse-cdt/cdt-lsp/milestone/2?closed=1>
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,14 +126,11 @@ This file may be hidden by default, therefore to see the file uncheck the *.\* r
### Open a file

By default C/C++ will be opened with the standard CEditor.
The default can be changed per project or per workspace with the *C/C++ General* -> *Editor (LSP)* -> *Prefer C/C++ Editor (LSP)* checkbox in the project setting or preferences.
The default can be changed per project or per workspace with the *C/C++ General* -> *Editor (LSP)* -> *Set C/C++ Editor (LSP) as default* checkbox in the project properties or workspace preference page.

- Note: The workspace setting will be used for projects that have not checked the *Enable project specific settings* checkbox in the project properties -> *C/C++ General* -> *Editor (LSP)* page.

Alternatively, you can choose which editor to open the file by using *Open With*:

![open-with.png](images/open-with.png "open-with.png")

**Note:** Opening a C/C++ file using *Open With* in the context menu of a file won't work for the LSP based editor, because the language server won't be started if *Set C/C++ Editor (LSP) as default* is not enabled!

With the *C/C++ Editor (LSP)* open, the presentation of the C++ file will follow the LSP4E conventions augmented by the information returned from clangd.

Expand All @@ -148,6 +145,7 @@ For plug-in dependencies the MANIFEST.MF's dependency information will provide t
| CDT LSP Version | clangd | cmake* | Eclipse IDE Release |
|:-:|:-:|:-:|:-:|
| 1.0.x | 15.0.x | 3.x | 2023-09 |
| 1.1.x | 17.0.x | 3.x | 2023-12 |

\* cmake is required to run through the demo flow, but any tool that can create compile_commands.json or otherwise feed settings to clangd is suitable.

Expand Down
Binary file removed images/open-with.png
Binary file not shown.
Binary file modified images/preferences.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/properties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8ed9857

Please sign in to comment.