From a57ed939234f6fd12d312d5d6fe879502d4c98f8 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Wed, 24 Aug 2016 23:50:15 +0300 Subject: [PATCH] Add information about C/C++ Index Rebuiding --- docs/ide/atom.rst | 14 +++++++------- docs/librarymanager/index.rst | 5 +++++ docs/userguide/lib/cmd_install.rst | 5 +++++ 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/docs/ide/atom.rst b/docs/ide/atom.rst index 9254e9e1..dc907b24 100644 --- a/docs/ide/atom.rst +++ b/docs/ide/atom.rst @@ -49,7 +49,7 @@ It's built on top of `GitHub's Atom "hackable" text editor `_. If you have already Atom installed, please install `PlatformIO IDE for Atom package `_. .. note:: - You don't need to install PlatformIO CLI seprately to system. + You don't need to install PlatformIO CLI separately to system. PlatformIO CLI is built into PlatformIO IDE and you will be able to use it within PlatformIO IDE Terminal. @@ -95,9 +95,9 @@ then install it and restart Atom: - **Other Systems**: Download the latest `Clang for the other systems `_. .. warning:: - The libraries which are added/installed after initializing process will - not be reflected in code linter. You need ``Menu: PlatformIO > - Rebuild C/C++ Project Index (Autocomplete, Linter)``. + If some libraries are not visible in :ref:`ide_atom` and Code Completion or + Code Linting does not work properly, please perform ``Menu: PlatformIO > + Rebuild C/C++ Project Index (Autocomplete, Linter)`` 3. IDE Installation ~~~~~~~~~~~~~~~~~~~ @@ -337,9 +337,9 @@ automatically created and preconfigured when you initialize project using ``Menu: PlatformIO > Initialize new PlatformIO Project or update existing...``. .. warning:: - The libraries which are added/installed after initializing process will - not be reflected in code linter. You need ``Menu: PlatformIO > - Rebuild C/C++ Project Index (Autocomplete, Linter)``. + If some libraries are not visible in :ref:`ide_atom` and Code Completion or + Code Linting does not work properly, please perform ``Menu: PlatformIO > + Rebuild C/C++ Project Index (Autocomplete, Linter)`` .. error:: diff --git a/docs/librarymanager/index.rst b/docs/librarymanager/index.rst index cb44bd46..8291dd38 100644 --- a/docs/librarymanager/index.rst +++ b/docs/librarymanager/index.rst @@ -54,4 +54,9 @@ You can use library ID, Name or even repository URL. For example, Please follow to :ref:`cmd_lib_install` for detailed documentation about possible values. +.. warning:: + If some libraries are not visible in :ref:`ide_atom` and Code Completion or + Code Linting does not work properly, please perform ``Menu: PlatformIO > + Rebuild C/C++ Project Index (Autocomplete, Linter)`` + .. image:: ../_static/platformio-demo-lib.gif diff --git a/docs/userguide/lib/cmd_install.rst b/docs/userguide/lib/cmd_install.rst index 880920b2..ae130e38 100644 --- a/docs/userguide/lib/cmd_install.rst +++ b/docs/userguide/lib/cmd_install.rst @@ -51,6 +51,11 @@ Usage platformio lib [STORAGE_OPTIONS] install = (name it should have locally) platformio lib [STORAGE_OPTIONS] install ("tag" can be commit, branch or tag) +.. warning:: + If some libraries are not visible in :ref:`ide_atom` and Code Completion or + Code Linting does not work properly, please perform ``Menu: PlatformIO > + Rebuild C/C++ Project Index (Autocomplete, Linter)`` + Description -----------