Implement packaging of code samples

This patch:
* Adjusts code samples to use a different Clang bin path: as if
  installed from a binary package rather than as if built from source
* Implements copying of code samples to the generated binary packages

Author: miyuki

samples/Makefile.conf

@@ -16,8 +16,5 @@
 #
 
 ifndef BIN_PATH
-ifndef VERSION
-    VERSION=0.1
+BIN_PATH=../../../bin
 endif
-BIN_PATH=../../../install-${VERSION}/LLVMEmbeddedToolchainForArm-${VERSION}/bin
-endif

samples/README.md

@@ -50,21 +50,14 @@ Debugging is only supported on Linux.
 ## Specifying the location of the installed toolchain
 
 The Makefiles of the code samples need the location of the installed LLVM
-Embedded Toolchain for Arm. There are several ways to specify the location,
-depending on the environment. The following option works in all environments:
-* Set the environment variable ``BIN_PATH`` to point to the ``bin`` directory
-  of the toolchain.
-
-The following two options work on Linux and MSYS2:
-* Set the environment variable ``VERSION`` to the revision of the built
-  toolchain (e.g. ``13.0.0`` or ``HEAD``). The sample Makefiles will assume that
-  the toolchain is installed in the default directory used by the
-  ``build.py`` script (i.e.
-  ``install-<revision>/LLVMEmbeddedToolchainForArm-<revision>``
-  in the root of the ``LLVM-embedded-toolchain-for-Arm`` repository
-  checkout), or
-* Don't set any of the above variables. This will have the same effect as
-  setting ``VERSION=0.1``.
+Embedded Toolchain for Arm.
+
+If you are using Linux or MSYS2 and running the samples directly from the
+installation directory the Makefiles will determine the correct location
+automatically.
+
+Otherwise you will need to set the environment variable ``BIN_PATH`` to point
+to the ``bin`` directory of the toolchain.
 
 ## Compiling, running and debugging the samples
 
@@ -88,12 +81,6 @@ use the following commands to build, run or debug the sample:
   ```
 * ``$ make clean`` to delete the generated ``.elf`` and ``.hex`` files
 
-Note: you can set an environment variable for a command using the following
-syntax:
-```
-$ VERSION=HEAD make run
-```
-
 ### Windows
 
 If you plan to run the compiled samples, ensure that the path of the directory

scripts/build.py

@@ -356,6 +356,7 @@ def main() -> int:
 
         def do_package():
             package.write_version_file(cfg, version)
+            package.copy_samples(cfg)
             package.package_toolchain(cfg)
         run_or_skip(cfg, Action.PACKAGE, do_package, 'packaging')
     except util.ToolchainBuildError:

scripts/config.py

@@ -346,6 +346,7 @@ def _fill_inferred(self):
         self.newlib_repo_dir = join(self.repos_dir, 'newlib.git')
         is_using_mingw = self.host_toolchain.kind == ToolchainKind.MINGW
         self.is_cross_compiling = (os.name == 'posix' and is_using_mingw)
+        self.is_windows = is_using_mingw
         self.cmake_generator = 'Ninja' if self.use_ninja else 'Unix Makefiles'
         self.release_mode = self.revision != 'HEAD'
         if self.release_mode:

scripts/package.py

@@ -15,6 +15,7 @@
 
 import logging
 import os
+import shutil
 from typing import FrozenSet
 import tarfile
 import zipfile
@@ -39,6 +40,25 @@ def write_version_file(cfg: config.Config, version: repos.LLVMBMTC) -> None:
     util.write_lines(lines, dest)
 
 
+def copy_samples(cfg: config.Config) -> None:
+    """Copy code samples, filter out files that are not usable on the target
+       platform."""
+    src = os.path.join(cfg.source_dir, 'samples')
+    dest = os.path.join(cfg.target_llvm_dir, 'samples')
+    if os.path.exists(dest):
+        shutil.rmtree(dest)
+
+    if cfg.is_windows:
+        # We don't filter out Makefile and Makefile.conf because we support
+        # using Windows+MSYS2
+        ignore = shutil.ignore_patterns('.gitignore')
+    else:
+        # make.bat is useless on Linux/Mac
+        ignore = shutil.ignore_patterns('.gitignore', 'make.bat')
+    logging.info('Copying "%s" to "%s"', src, dest)
+    shutil.copytree(src, dest, ignore=ignore)
+
+
 def _get_excluded_symlinks(cfg: config.Config) -> FrozenSet[str]:
     """Get a list of symlinks that should be excluded when symlinks are
        converted to copies (i.e. when targeting Windows or using zip as archive
@@ -51,7 +71,7 @@ def _get_excluded_symlinks(cfg: config.Config) -> FrozenSet[str]:
         'lld-link',  # Windows (COFF) linker
         'wasm-ld',   # WebAssembly linker
     ]
-    if cfg.is_cross_compiling:
+    if cfg.is_windows:
         excludes = [name + '.exe' for name in excludes]
     return frozenset(excludes)
 
@@ -64,7 +84,7 @@ def reset_uid(tarinfo: tarfile.TarInfo) -> tarfile.TarInfo:
         return tarinfo
     exclude_set: FrozenSet[str] = frozenset()
     dereference = False
-    if cfg.is_cross_compiling:
+    if cfg.is_windows:
         exclude_set = _get_excluded_symlinks(cfg)
         dereference = True
     with tarfile.open(dest_pkg, 'w:gz') as dest: