Prepare mbed-tools release 6.0.0

Author: monty-bot

CHANGELOG.md

@@ -12,6 +12,21 @@ beta releases are not included in this history. For a full list of all releases,
 
 [//]: # (begin_release_notes)
 
+6.0.0 (2021-02-10)
+==================
+
+Major changes
+-------------
+
+- The compile subcommand now requires both toolchain and mbed-target arguments. (#20210203124012)
+
+
+Features
+--------
+
+- Builds are now separated by target, profile and toolchain, allowing use of different configurations without clearing previous builds. (#141)
+
+
 5.5.0 (2021-02-06)
 ==================
 

docs/api/cli/build.html

@@ -104,7 +104,7 @@ <h1 class="title">Module <code>mbed_tools.cli.build</code></h1>
 
     Args:
        program_path: Path to the Mbed project.
-       mbed_os_path: the path to the local Mbed OS directory
+       mbed_os_path: The path to the local Mbed OS directory.
        profile: The Mbed build profile (debug, develop or release).
        custom_targets_json: Path to custom_targets.json.
        toolchain: The toolchain to use for the build.
@@ -115,23 +115,21 @@ <h1 class="title">Module <code>mbed_tools.cli.build</code></h1>
        sterm: Open a serial terminal to the connected target.
        baudrate: Change the serial baud rate (ignored unless --sterm is also given).
     &#34;&#34;&#34;
+    _validate_target_and_toolchain_args(mbed_target, toolchain)
+    cmake_build_subdir = pathlib.Path(mbed_target.upper(), profile.lower(), toolchain.upper())
     if mbed_os_path is None:
-        program = MbedProgram.from_existing(pathlib.Path(program_path))
+        program = MbedProgram.from_existing(pathlib.Path(program_path), cmake_build_subdir)
     else:
-        program = MbedProgram.from_existing(pathlib.Path(program_path), pathlib.Path(mbed_os_path))
-    mbed_config_file = program.files.cmake_config_file
+        program = MbedProgram.from_existing(pathlib.Path(program_path), cmake_build_subdir, pathlib.Path(mbed_os_path))
     build_tree = program.files.cmake_build_dir
     if clean and build_tree.exists():
         shutil.rmtree(build_tree)
 
-    if any([not mbed_config_file.exists(), not build_tree.exists(), mbed_target, toolchain]):
-        click.echo(&#34;Configuring project and generating build system...&#34;)
-        _validate_target_and_toolchain_args(mbed_target, toolchain)
-        if custom_targets_json is not None:
-            program.files.custom_targets_json = pathlib.Path(custom_targets_json)
-
-        generate_config(mbed_target.upper(), toolchain, program)
-        generate_build_system(program.root, build_tree, profile)
+    click.echo(&#34;Configuring project and generating build system...&#34;)
+    if custom_targets_json is not None:
+        program.files.custom_targets_json = pathlib.Path(custom_targets_json)
+    generate_config(mbed_target.upper(), toolchain, program)
+    generate_build_system(program.root, build_tree, profile)
 
     click.echo(&#34;Building Mbed project...&#34;)
     build_project(build_tree)
@@ -156,7 +154,9 @@ <h1 class="title">Module <code>mbed_tools.cli.build</code></h1>
 
 def _validate_target_and_toolchain_args(target: str, toolchain: str) -&gt; None:
     if not all([toolchain, target]):
-        raise click.UsageError(&#34;--toolchain and --mbed-target arguments are required when generating Mbed config!&#34;)</code></pre>
+        raise click.UsageError(
+            &#34;Both --toolchain and --mbed-target arguments are required when using the compile subcommand.&#34;
+        )</code></pre>
 </details>
 </section>
 <section>

docs/api/cli/configure.html

@@ -77,10 +77,11 @@ <h1 class="title">Module <code>mbed_tools.cli.configure</code></h1>
         program_path: the path to the local Mbed program
         mbed_os_path: the path to the local Mbed OS directory
     &#34;&#34;&#34;
+    cmake_build_subdir = pathlib.Path(mbed_target.upper(), &#34;develop&#34;, toolchain.upper())
     if mbed_os_path is None:
-        program = MbedProgram.from_existing(pathlib.Path(program_path))
+        program = MbedProgram.from_existing(pathlib.Path(program_path), cmake_build_subdir)
     else:
-        program = MbedProgram.from_existing(pathlib.Path(program_path), pathlib.Path(mbed_os_path))
+        program = MbedProgram.from_existing(pathlib.Path(program_path), cmake_build_subdir, pathlib.Path(mbed_os_path))
     mbed_target = mbed_target.upper()
     output_path = generate_config(mbed_target, toolchain, program)
     click.echo(f&#34;mbed_config.cmake has been generated and written to &#39;{str(output_path.resolve())}&#39;&#34;)</code></pre>

docs/api/project/mbed_program.html

@@ -95,12 +95,15 @@ <h1 class="title">Module <code>mbed_tools.project.mbed_program</code></h1>
         return cls(program_files, mbed_os)
 
     @classmethod
-    def from_existing(cls, dir_path: Path, mbed_os_path: Path = None, check_mbed_os: bool = True) -&gt; &#34;MbedProgram&#34;:
+    def from_existing(
+        cls, dir_path: Path, build_subdir: Path, mbed_os_path: Path = None, check_mbed_os: bool = True,
+    ) -&gt; &#34;MbedProgram&#34;:
         &#34;&#34;&#34;Create an MbedProgram from an existing program directory.
 
         Args:
             dir_path: Directory containing an Mbed program.
-            mbed_os_path: Directory containing Mbed OS
+            build_subdir: The subdirectory for the CMake build tree.
+            mbed_os_path: Directory containing Mbed OS.
             check_mbed_os: If True causes an exception to be raised if the Mbed OS source directory does not
                            exist.
 
@@ -114,7 +117,7 @@ <h1 class="title">Module <code>mbed_tools.project.mbed_program</code></h1>
             program_root = dir_path
 
         logger.info(f&#34;Found existing Mbed program at path &#39;{program_root}&#39;&#34;)
-        program = MbedProgramFiles.from_existing(program_root)
+        program = MbedProgramFiles.from_existing(program_root, build_subdir)
 
         try:
             mbed_os = MbedOS.from_existing(mbed_os_path, check_mbed_os)
@@ -308,12 +311,15 @@ <h2 id="args">Args</h2>
         return cls(program_files, mbed_os)
 
     @classmethod
-    def from_existing(cls, dir_path: Path, mbed_os_path: Path = None, check_mbed_os: bool = True) -&gt; &#34;MbedProgram&#34;:
+    def from_existing(
+        cls, dir_path: Path, build_subdir: Path, mbed_os_path: Path = None, check_mbed_os: bool = True,
+    ) -&gt; &#34;MbedProgram&#34;:
         &#34;&#34;&#34;Create an MbedProgram from an existing program directory.
 
         Args:
             dir_path: Directory containing an Mbed program.
-            mbed_os_path: Directory containing Mbed OS
+            build_subdir: The subdirectory for the CMake build tree.
+            mbed_os_path: Directory containing Mbed OS.
             check_mbed_os: If True causes an exception to be raised if the Mbed OS source directory does not
                            exist.
 
@@ -327,7 +333,7 @@ <h2 id="args">Args</h2>
             program_root = dir_path
 
         logger.info(f&#34;Found existing Mbed program at path &#39;{program_root}&#39;&#34;)
-        program = MbedProgramFiles.from_existing(program_root)
+        program = MbedProgramFiles.from_existing(program_root, build_subdir)
 
         try:
             mbed_os = MbedOS.from_existing(mbed_os_path, check_mbed_os)
@@ -342,16 +348,18 @@ <h2 id="args">Args</h2>
 <h3>Static methods</h3>
 <dl>
 <dt id="mbed_tools.project.mbed_program.MbedProgram.from_existing"><code class="name flex">
-<span>def <span class="ident">from_existing</span></span>(<span>dir_path: pathlib.Path, mbed_os_path: pathlib.Path = None, check_mbed_os: bool = True) ‑> <a title="mbed_tools.project.mbed_program.MbedProgram" href="#mbed_tools.project.mbed_program.MbedProgram">MbedProgram</a></span>
+<span>def <span class="ident">from_existing</span></span>(<span>dir_path: pathlib.Path, build_subdir: pathlib.Path, mbed_os_path: pathlib.Path = None, check_mbed_os: bool = True) ‑> <a title="mbed_tools.project.mbed_program.MbedProgram" href="#mbed_tools.project.mbed_program.MbedProgram">MbedProgram</a></span>
 </code></dt>
 <dd>
 <div class="desc"><p>Create an MbedProgram from an existing program directory.</p>
 <h2 id="args">Args</h2>
 <dl>
 <dt><strong><code>dir_path</code></strong></dt>
 <dd>Directory containing an Mbed program.</dd>
+<dt><strong><code>build_subdir</code></strong></dt>
+<dd>The subdirectory for the CMake build tree.</dd>
 <dt><strong><code>mbed_os_path</code></strong></dt>
-<dd>Directory containing Mbed OS</dd>
+<dd>Directory containing Mbed OS.</dd>
 <dt><strong><code>check_mbed_os</code></strong></dt>
 <dd>If True causes an exception to be raised if the Mbed OS source directory does not
 exist.</dd>
@@ -366,12 +374,15 @@ <h2 id="raises">Raises</h2>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">@classmethod
-def from_existing(cls, dir_path: Path, mbed_os_path: Path = None, check_mbed_os: bool = True) -&gt; &#34;MbedProgram&#34;:
+def from_existing(
+    cls, dir_path: Path, build_subdir: Path, mbed_os_path: Path = None, check_mbed_os: bool = True,
+) -&gt; &#34;MbedProgram&#34;:
     &#34;&#34;&#34;Create an MbedProgram from an existing program directory.
 
     Args:
         dir_path: Directory containing an Mbed program.
-        mbed_os_path: Directory containing Mbed OS
+        build_subdir: The subdirectory for the CMake build tree.
+        mbed_os_path: Directory containing Mbed OS.
         check_mbed_os: If True causes an exception to be raised if the Mbed OS source directory does not
                        exist.
 
@@ -385,7 +396,7 @@ <h2 id="raises">Raises</h2>
         program_root = dir_path
 
     logger.info(f&#34;Found existing Mbed program at path &#39;{program_root}&#39;&#34;)
-    program = MbedProgramFiles.from_existing(program_root)
+    program = MbedProgramFiles.from_existing(program_root, build_subdir)
 
     try:
         mbed_os = MbedOS.from_existing(mbed_os_path, check_mbed_os)