From 60d6ed57a892c7f9128309fde27bab5ef48d12d7 Mon Sep 17 00:00:00 2001 From: Philip Reichmuth Date: Tue, 8 Jan 2019 15:20:16 +0600 Subject: [PATCH 1/3] Add fix for SoftwareSerial submodule errors to documentation --- doc/installing.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/doc/installing.rst b/doc/installing.rst index f86eb1f0cb..890e4950f9 100644 --- a/doc/installing.rst +++ b/doc/installing.rst @@ -112,6 +112,16 @@ Instructions - Windows 10 - If using the Arduino IDE for Visual Studio (https://www.visualmicro.com/), be sure to click Tools - Visual Micro - Rescan Toolchains and Libraries +- You may see some error messages about missing files related to the + ``SoftwareSerial`` library. These are because the ESP8266 version + of this library has been moved to a separate git submodule. In + order to get rid of these messages, initialize the submodule: + + .. code:: bash + + cd %USERPROFILE%\Documents\hardware\esp8266com\esp8266 + git submodules update --init + - When later updating your local library, goto the esp8266 directory and do a git pull .. code:: bash @@ -174,3 +184,13 @@ Instructions - Other OS python get.py - Restart Arduino + +- You may see some error messages about missing files related to the + ``SoftwareSerial`` library. These are because the ESP8266 version + of this library has been moved to a separate git submodule. In + order to get rid of these messages, initialize the submodule: + + .. code:: bash + + cd esp8266 + git submodules update --init From e0bc4c822d9d959fb8e9efac75afa4af97cef575 Mon Sep 17 00:00:00 2001 From: Develo Date: Fri, 18 Jan 2019 15:23:43 -0300 Subject: [PATCH 2/3] Update installing.rst Replaces and based on #5602 Fixes #5583 --- doc/installing.rst | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/doc/installing.rst b/doc/installing.rst index 890e4950f9..4dac2bd052 100644 --- a/doc/installing.rst +++ b/doc/installing.rst @@ -101,6 +101,15 @@ Instructions - Windows 10 --- boards.txt --- LICENSE +- Initialize the submodules + + .. code:: bash + + cd %USERPROFILE%\Documents\hardware\esp8266com\esp8266 + git submodules update --init + + If error messages about missing files related to ``SoftwareSerial`` are encountered during the build process, it should be because this step was missed and is required. + - Download binary tools .. code:: bash @@ -112,16 +121,6 @@ Instructions - Windows 10 - If using the Arduino IDE for Visual Studio (https://www.visualmicro.com/), be sure to click Tools - Visual Micro - Rescan Toolchains and Libraries -- You may see some error messages about missing files related to the - ``SoftwareSerial`` library. These are because the ESP8266 version - of this library has been moved to a separate git submodule. In - order to get rid of these messages, initialize the submodule: - - .. code:: bash - - cd %USERPROFILE%\Documents\hardware\esp8266com\esp8266 - git submodules update --init - - When later updating your local library, goto the esp8266 directory and do a git pull .. code:: bash @@ -176,6 +175,15 @@ Instructions - Other OS --- boards.txt --- LICENSE +- Initialize the submodules + + .. code:: bash + + cd esp8266 + git submodules update --init + + If error messages about missing files related to ``SoftwareSerial`` are encountered during the build process, it should be because this step was missed and is required. + - Download binary tools .. code:: bash From 7e8fbeb7108484618b452689071557e5a010b386 Mon Sep 17 00:00:00 2001 From: Develo Date: Fri, 18 Jan 2019 17:22:00 -0300 Subject: [PATCH 3/3] Update installing.rst Remove forgotten section Add update section for Other OS --- doc/installing.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/doc/installing.rst b/doc/installing.rst index 4dac2bd052..d240cd4c16 100644 --- a/doc/installing.rst +++ b/doc/installing.rst @@ -193,12 +193,10 @@ Instructions - Other OS - Restart Arduino -- You may see some error messages about missing files related to the - ``SoftwareSerial`` library. These are because the ESP8266 version - of this library has been moved to a separate git submodule. In - order to get rid of these messages, initialize the submodule: +- When later updating your local library, goto the esp8266 directory and do a git pull .. code:: bash - cd esp8266 - git submodules update --init + cd hardware\esp8266com\esp8266 + git status + git pull