Docstrings. Empty executable search path handling.

Author: sarahmarshy

tools/build.py

@@ -214,11 +214,10 @@
     if options.cppcheck_validation:
         for toolchain in toolchains:
             if not TOOLCHAIN_CLASSES[toolchain].check_executable():
-                if TOOLCHAIN_PATHS[toolchain] == '':
-                    TOOLCHAIN_PATHS[toolchain] = "No path set"
+                search_path = TOOLCHAIN_PATHS[toolchain] or "No path set"
                 args_error(parser, "Could not find executable for %s.\n"
                                    "Currently set search path: %s"
-                           % (toolchain, TOOLCHAIN_PATHS[toolchain]))
+                           % (toolchain, search_path))
             for target in targets:
                 try:
                     mcu = TARGET_MAP[target]

tools/make.py

@@ -233,11 +233,10 @@
         notify = None
 
     if not TOOLCHAIN_CLASSES[toolchain].check_executable():
-        if TOOLCHAIN_PATHS[toolchain] == '':
-            TOOLCHAIN_PATHS[toolchain] = "No path set"
+        search_path = TOOLCHAIN_PATHS[toolchain] or "No path set"
         args_error(parser, "Could not find executable for %s.\n"
                            "Currently set search path: %s"
-                           %(toolchain,TOOLCHAIN_PATHS[toolchain]))
+                           %(toolchain,search_path))
 
     # Test
     for test_no in p:

tools/test.py

@@ -116,11 +116,10 @@
         toolchain = options.tool[0]
 
         if not TOOLCHAIN_CLASSES[toolchain].check_executable():
-            if TOOLCHAIN_PATHS[toolchain] == '':
-                TOOLCHAIN_PATHS[toolchain] = "No path set"
+            search_path = TOOLCHAIN_PATHS[toolchain] or "No path set"
             args_error(parser, "Could not find executable for %s.\n"
                                "Currently set search path: %s"
-                       % (toolchain, TOOLCHAIN_PATHS[toolchain]))
+                       % (toolchain, search_path))
 
         # Find all tests in the relevant paths
         for path in all_paths:

tools/toolchains/arm.py

@@ -44,6 +44,9 @@ class ARM(mbedToolchain):
 
     @staticmethod
     def check_executable():
+        """Returns True if the executable (armcc) location specified by the
+         user exists OR the executable can be found on the PATH.
+         Returns False otherwise."""
         if not TOOLCHAIN_PATHS["ARM"] or not exists(TOOLCHAIN_PATHS['ARM']):
             exe = find_executable('armcc')
             if not exe:

tools/toolchains/gcc.py

@@ -272,6 +272,9 @@ def binary(self, resources, elf, bin):
 class GCC_ARM(GCC):
     @staticmethod
     def check_executable():
+        """Returns True if the executable (arm-none-eabi-gcc) location
+        specified by the user exists OR the executable can be found on the PATH.
+        Returns False otherwise."""
         if not TOOLCHAIN_PATHS["GCC_ARM"] or not exists(TOOLCHAIN_PATHS['GCC_ARM']):
             exe = find_executable('arm-none-eabi-gcc')
             if not exe:
@@ -306,6 +309,9 @@ def __init__(self, target, options=None, notify=None, macros=None, silent=False,
 class GCC_CR(GCC):
     @staticmethod
     def check_executable():
+        """Returns True if the executable (arm-none-eabi-gcc) location
+        specified by the user exists OR the executable can be found on the PATH.
+        Returns False otherwise."""
         if not TOOLCHAIN_PATHS["GCC_CR"] or not exists(TOOLCHAIN_PATHS['GCC_CR']):
             exe = find_executable('arm-none-eabi-gcc')
             if not exe:

tools/toolchains/iar.py

@@ -47,6 +47,9 @@ class IAR(mbedToolchain):
 
     @staticmethod
     def check_executable():
+        """Returns True if the executable (arm-none-eabi-gcc) location
+        specified by the user exists OR the executable can be found on the PATH.
+        Returns False otherwise."""
         if not TOOLCHAIN_PATHS["IAR"] or not exists(TOOLCHAIN_PATHS['IAR']):
             exe = find_executable('iccarm')
             if not exe: