small readme improvements

ika-rwth-aachen · Oct 11, 2023 · c1ec673 · c1ec673
1 parent 4fe94ad
commit c1ec673
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/.gitlab-ci/docker-ros.yml b/.gitlab-ci/docker-ros.yml
@@ -37,8 +37,8 @@ variables:
   ENABLE_RECURSIVE_ADDITIONAL_PIP:   'false'                          # Enable recursive discovery of files named `additional-pip-file`
   CUSTOM_SCRIPT_FILE:         docker/custom.sh                        # Relative filepath to script containing custom installation commands
   ENABLE_RECURSIVE_CUSTOM_SCRIPT:    'false'                          # Enable recursive discovery of files named `custom-script-file`
-  VCS_IMPORT_FILE:            .repos                                  # Relative filepath to file containing additional repos to install via vcstools
-  ENABLE_RECURSIVE_VCS_IMPORT:       'true'                           # Enable recursive discovery of files named `vcs-import-file`
+  VCS_IMPORT_FILE:            .repos                                  # Relative filepath to file containing additional repos to install via vcstools (only relevant if ENABLE_RECURSIVE_VCS_IMPORT=false)
+  ENABLE_RECURSIVE_VCS_IMPORT:       'true'                           # Enable recursive discovery of files named `*.repos`
   # -----
   DOCKER_ROS_GIT_REF:     main
 

diff --git a/README.md b/README.md
@@ -326,7 +326,7 @@ Create a folder `additional-files` in your `docker` folder (or configure a diffe
   Relative filepath to file containing additional pip packages to install  
   *default:* `docker/additional-pip-requirements.txt`
 - **`vcs-import-file` | `VCS_IMPORT_FILE`**  
-  Relative filepath to file containing additional repos to install via vcstools
+  Relative filepath to file containing additional repos to install via vcstools (only relevant if `enable-recursive-vcs-import=false`)
   *default:* `.repos`
 - **`base-image` | `BASE_IMAGE`**  
   Base image `name:tag`  
@@ -377,7 +377,7 @@ Create a folder `additional-files` in your `docker` folder (or configure a diffe
   Enable recursive discovery of files named `custom-script-file`  
   *default:* `false`
 - **`enable-recursive-vcs-import` | `ENABLE_RECURSIVE_VCS_IMPORT`**  
-  Enable recursive discovery of files named `additional-repo-file`  
+  Enable recursive discovery of files named `*.repos`  
   *default:* `true`
 - **`git-ssh-known-host-keys` | `GIT_SSH_KNOWN_HOST_KEYS`**  
   Known SSH host keys for cloning private Git repositories via SSH (may be obtained using `ssh-keyscan`)  

diff --git a/docker/recursive_vcs_import.py b/docker/recursive_vcs_import.py
@@ -13,6 +13,7 @@ def findDotRepos(search_path: str, clone_path: Optional[str] = None) -> List[pat
         repos.extend(list(pathlib.Path(clone_path).glob("**/*.repos")))
     return repos
 
+
 def main():
 
     search_path = sys.argv[1] if len(sys.argv) > 1 else "."
@@ -39,4 +40,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    main()