Comments

Author: sarahmarshy

tools/project.py

@@ -126,6 +126,7 @@
         args_error(parser, "[ERROR] You should specify an IDE")
     ide = options.ide
 
+    # Program Number or name
     p, n, src= options.program, options.program_name, options.source_dir
 
     if src is None:
@@ -144,6 +145,8 @@
     # Export results
     successes = []
     failures = []
+
+    # source is used to generate IDE files to toolchain directly in the source tree and doesn't generate zip file
     zip = src is None
     clean = src is None
 

tools/project_api.py

@@ -15,6 +15,7 @@
 except:
     ps = object()
 
+
 def get_program(n):
     p = TEST_MAP[n].n
     return p
@@ -23,6 +24,7 @@ def get_program(n):
 def get_test(p):
     return Test(p)
 
+
 def get_test_from_name(n):
     if not n in TEST_MAP.keys():
         # Check if there is an alias for this in private_settings.py
@@ -36,7 +38,12 @@ def get_test_from_name(n):
             return None
     return get_program(n)
 
+
 def setup_project(mcu, ide, program = None, source_dir= None, macros = None, build = None):
+
+    # Some libraries have extra macros (called by exporter symbols) to we need to pass
+    # them to maintain compilation macros integrity between compiled library and
+    # header files we might use with it
     lib_symbols = []
     if macros:
         lib_symbols += macros
@@ -59,7 +66,7 @@ def setup_project(mcu, ide, program = None, source_dir= None, macros = None, bui
             if MBED_LIBRARIES in test.dependencies:
                 test.dependencies.remove(MBED_LIBRARIES)
                 test.dependencies.append(MBED_BASE)
-
+        # Build the project with the same directory structure of the mbed online IDE
         project_name = test.id
         project_dir = [join(EXPORT_WORKSPACE, project_name)]
         project_temp = EXPORT_TMP