Skip to content

Commit abff14f

Browse files
committed
Update docs for Vim and Emacs on using ccls
1 parent 276debf commit abff14f

File tree

2 files changed

+25
-27
lines changed

2 files changed

+25
-27
lines changed

integration/ide/emacs.rst

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,6 @@ Integration process consists of these steps:
3737
3. Generate a project using PlatformIO Core Project Generator (:option:`pio project init --ide`)
3838
4. Open project in Emacs.
3939

40-
------------
41-
42-
PlatformIO-Mode
43-
^^^^^^^^^^^^^^^
44-
45-
An Emacs minor mode has been written to facilitate building and uploading from within Emacs.
46-
It can be installed from the MELPA repository using ``M-x package-install``.
47-
See the MELPA `Getting Started <https://melpa.org/#/getting-started>`_ page for more information.
48-
49-
Setup instructions and an example config can be found at the `Github page <https://github.com/ZachMassia/platformio-mode>`_.
50-
51-
Code completion can optionally be provided by installing `irony-mode <https://github.com/Sarcasm/irony-mode>`_
52-
5340

5441
Project Generator
5542
^^^^^^^^^^^^^^^^^
@@ -61,6 +48,20 @@ command and generate project via :option:`pio project init --ide` command:
6148
6249
pio project init --ide emacs --board <ID>
6350
51+
.. warning::
52+
The libraries which are added, installed or used in the project
53+
after generating process won't be reflected in IDE. To fix it you
54+
need to reinitialize project using :ref:`cmd_project_init` (repeat it).
55+
56+
57+
PlatformIO-Mode
58+
^^^^^^^^^^^^^^^
59+
60+
An Emacs minor mode has been written to facilitate building and uploading from within Emacs.
61+
It can be installed from the MELPA repository using ``M-x package-install``.
62+
See the MELPA `Getting Started <https://melpa.org/#/getting-started>`_ page for more information.
63+
64+
Setup instructions and an example config can be found at the `Github page <https://github.com/ZachMassia/platformio-mode>`_.
6465

6566
There are 6 predefined targets for building.
6667

@@ -71,7 +72,11 @@ There are 6 predefined targets for building.
7172
* ``platformio_spiffs_upload`` - Upload files to file system SPIFFS (see :ref:`platform_espressif_uploadfs`). (``C-c i s``)
7273
* ``platformio_update`` - Update installed platforms and libraries. (``C-c i d``)
7374

74-
.. warning::
75-
The libraries which are added, installed or used in the project
76-
after generating process won't be reflected in IDE. To fix it you
77-
need to reinitialize project using :ref:`cmd_project_init` (repeat it).
75+
76+
Code Completion and Navigation
77+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
78+
79+
Please install the next:
80+
81+
* `C/C++/ObjC language server supporting cross references, hierarchies, completion and semantic highlighting <https://github.com/MaskRay/ccls>`_
82+
* `Emacs client for ccls, a C/C++ language server <https://github.com/MaskRay/emacs-ccls>`_.

integration/ide/vim.rst

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,6 @@ Integration process consists of these steps:
3232
3. Generate a project using PlatformIO Core Project Generator (:option:`pio project init --ide`)
3333
4. Import project in IDE.
3434

35-
"Neomake-PlatformIO" Plugin
36-
^^^^^^^^^^^^^^^^^^^^^^^^^^^
37-
38-
Please visit `neomake-platformio <https://github.com/coddingtonbear/neomake-platformio>`_
39-
for the further installation steps and documentation.
40-
4135
Project Generator
4236
^^^^^^^^^^^^^^^^^
4337

@@ -50,10 +44,9 @@ command and generate project via :option:`pio project init --ide` command:
5044
5145
Recommended bundles:
5246

53-
* C/C++/ language server supporting cross references, hierarchies, completion and semantic highlighting - `CCLS: vim lsp <https://github.com/MaskRay/ccls/wiki/vim-lsp>`_
54-
* Syntax highlight - `Arduino-syntax-file <https://github.com/vim-scripts/Arduino-syntax-file>`_
55-
* Code Completion - `YouCompleteMe <https://github.com/Valloric/YouCompleteMe>`_ (see configuration example by **Anthony Ford** `PlatformIO/YouCompleteMe Integration <https://gist.github.com/ajford/f551b2b6fd4d6b6e1ef2>`_)
56-
* Syntax checking - `Syntastic <https://github.com/scrooloose/syntastic>`_
47+
* `C/C++/ObjC language server supporting cross references, hierarchies, completion and semantic highlighting <https://github.com/MaskRay/ccls>`_
48+
* `Async language server protocol plugin for vim and neovim <https://github.com/prabirshrestha/vim-lsp>`_
49+
* `"Neomake-PlatformIO" Plugin <https://github.com/coddingtonbear/neomake-platformio>`_
5750

5851
Put to the project directory ``Makefile`` wrapper with contents:
5952

0 commit comments

Comments
 (0)