Merge pull request #442 from matthijskooijman/doc-and-log-improvements

Doc and log improvements

README.md

@@ -5222,6 +5222,15 @@ Another important detail is that global options that are lists gets the values m
 The last set of values found is inserted at the beginning of the list.
 You can collect filters for all the imported global sections.
 
+Imports are processed recursively: An `import` section in an imported
+file is also processed (so importing `A.yaml` that imports `B.yaml`
+effectively imports both).
+
+If an import filename is a relative path, it is resolved relative to the
+config file that contains the import (so it works regardless of the
+working directory and, in case of recursive imports, of where top-level
+config lives).
+
 It's recommended to always use some file extension in the *FILE_CONTAINING_THE_YAML_DEFINITIONS* name.
 If you don't use any file extension and you use a relative path this name could be confused with an internal template.
 See [Importing internal templates](#importing-internal-templates).

kibot/gs.py

@@ -463,9 +463,11 @@ class GS(object):
         source = GS.pro_file
         prj_file = os.path.join(sch_dir, GS.sch_basename+ext)
         if source is not None and os.path.isfile(source):
+            logger.debug('Copying project `{}` to `{}`'.format(source, prj_file))
             copy2(source, prj_file)
             GS.fix_page_layout(prj_file)  # Alias for KiConf.fix_page_layout
         else:
+            logger.debug('Creating dummy project file `{}`'.format(prj_file))
             # Create a dummy project file to avoid warnings
             f = open(prj_file, 'wt')
             f.close()

kibot/out_diff.py

@@ -478,7 +478,7 @@ class DiffOptions(BaseOptions):
             run_command(cmd, just_raise=True)
         except CalledProcessError as e:
             if e.returncode == 10:
-                logger.error('Diff above the thresold')
+                logger.error('Diff above the threshold')
                 exit(DIFF_TOO_BIG)
             logger.error('Running {} returned {}'.format(e.cmd, e.returncode))
             if e.stdout: