Chore: Dissolve using Git submodules

- Don't use `git clone --recursive` any longer. - Remove corresponding documentation.
hiveeyes · May 28, 2023 · 7751442 · 7751442
1 parent b008b6a
commit 7751442
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 54 deletions.
diff --git a/README.rst b/README.rst
@@ -46,10 +46,9 @@ Setup
 
 Source code
 ===========
-Get source code with all dependency libraries and tools::
-
-    git clone --recursive https://github.com/hiveeyes/arduino
+Acquire source code repository::
 
+    git clone https://github.com/hiveeyes/arduino
 
 Toolchain
 =========

diff --git a/doc/source/development.rst b/doc/source/development.rst
@@ -11,6 +11,7 @@ Development
 ****
 Todo
 ****
+
 Have a look at the agenda at :ref:`todo`.
 
 
@@ -19,6 +20,7 @@ Have a look at the agenda at :ref:`todo`.
 *******
 Hacking
 *******
+
 For hacking on the repository, there are some guidelines.
 
 Initialize a new firmware flavour
@@ -32,49 +34,6 @@ The following steps are needed to initialize a new project inside the multivaria
     cp generic/{Makefile,platformio.ini} purpose-transport-protocol/
 
 
-Libraries as git submodules
-===========================
-Dependency libraries are organized as git submodules inside the ``libraries/`` folder.
-This avoids redundancy and delivers a coherent sandbox environment without too much
-overhead on artifact maintenance.
-
-
-Sync submodules
----------------
-To sync newly added libraries, do::
-
-    git submodule update --recursive --init
-
-
-Add library
------------
-To add a new library as a submodule, do the following::
-
-    git submodule add https://mightbegithub.com/author/repo-name libraries/repo-name
-
-
-Update library
---------------
-To update submodules to the latest commit available from their remote::
-
-    # Change to the submodule directory
-    cd submodule_dir
-
-    # Checkout desired branch
-    git checkout master
-
-    # Update
-    git pull
-
-    # Get back to your project root
-    cd ..
-
-    # Now the submodule is in the state you want, so
-    git commit -am "Pulled update to submodule_dir"
-
-.. seealso:: https://stackoverflow.com/questions/5828324/update-git-submodule-to-latest-commit-on-origin/5828396#5828396
-
-
 .. _simulation:
 
 **********

diff --git a/gateway-rfm69-csv-sdcard/README.rst b/gateway-rfm69-csv-sdcard/README.rst
@@ -39,7 +39,7 @@ Build on your workstation
 ::
 
     # Get hold of the source code repository including all dependencies
-    git clone --recursive https://github.com/hiveeyes/arduino
+    git clone https://github.com/hiveeyes/arduino
 
     # Select this firmware
     cd gateway-rfm69-csv-sdcard

diff --git a/gateway-rfm69-csv-uart/README.rst b/gateway-rfm69-csv-uart/README.rst
@@ -41,7 +41,7 @@ Build on your workstation
 ::
 
     # Get hold of the source code repository including all dependencies
-    git clone --recursive https://github.com/hiveeyes/arduino
+    git clone https://github.com/hiveeyes/arduino
 
     # Select this firmware
     cd gateway-rfm69-csv-uart

diff --git a/generic/README.rst b/generic/README.rst
@@ -106,7 +106,7 @@ Build on your workstation
 ::
 
     # Acquire the source code repository including all dependencies.
-    git clone --recursive https://github.com/hiveeyes/arduino
+    git clone https://github.com/hiveeyes/arduino
 
     # Select this firmware.
     cd generic

diff --git a/libraries/TerkinData/README.rst b/libraries/TerkinData/README.rst
@@ -190,7 +190,7 @@ Build for embedded targets
 ::
 
     # Get source code.
-    git clone --recursive https://github.com/hiveeyes/arduino
+    git clone https://github.com/hiveeyes/arduino
     cd arduino/libraries/TerkinData/examples
 
     # Build examples for all embedded platforms.

diff --git a/node-gprs-http/README.rst b/node-gprs-http/README.rst
@@ -71,7 +71,7 @@ Clone git repository
 ::
 
     # Get hold of the source code repository including all dependencies
-    git clone --recursive https://github.com/hiveeyes/arduino
+    git clone https://github.com/hiveeyes/arduino
 
     # Select this firmware
     cd node-gprs-http

diff --git a/node-rfm69-csv/README.rst b/node-rfm69-csv/README.rst
@@ -39,7 +39,7 @@ Build on your workstation
 ::
 
     # Get hold of the source code repository including all dependencies
-    git clone --recursive https://github.com/hiveeyes/arduino
+    git clone https://github.com/hiveeyes/arduino
 
     # Select this firmware
     cd node-rfm69-csv

diff --git a/node-wifi-mqtt/README.rst b/node-wifi-mqtt/README.rst
@@ -81,7 +81,7 @@ Clone git repository
 ::
 
     # Get hold of the source code repository including all dependencies
-    git clone --recursive https://github.com/hiveeyes/arduino
+    git clone https://github.com/hiveeyes/arduino
 
     # Select this firmware
     cd node-wifi-mqtt

diff --git a/node-yun-http/README.rst b/node-yun-http/README.rst
@@ -71,7 +71,7 @@ Clone git repository
 ::
 
     # Get hold of the source code repository including all dependencies
-    git clone --recursive https://github.com/hiveeyes/arduino
+    git clone https://github.com/hiveeyes/arduino
 
     # Select this firmware
     cd node-yun-http