Skip to content
  1. Oct 20, 2021
  3. Oct 18, 2021
  5. Oct 15, 2021
  7. Oct 14, 2021
  9. Oct 11, 2021
  11. Oct 08, 2021
  13. Oct 07, 2021
  15. Oct 05, 2021
  17. Oct 04, 2021
    • Richard Neill's avatar
      tools: Fix incorrect reference in --help messages · 4f86b592
      Richard Neill authored 
      

The usage instructions now correctly refer to the script name (__file__) rather
than the module name (__name__) when describing how to call the tools.

Issue-Id: SCM-3529
Signed-off-by: Richard Neill's avatarRichard Neill <richard.neill@arm.com>
Change-Id: I2d264cb1a15827fd6b1195debe71a283171ab03c
      4f86b592
    • Richard Neill's avatar
      doc: Do not embed README.md in the Sphinx-rendered documentation · 64c7db10
      Richard Neill authored 
      

This patch decouples README.md from the rendered documentation, allowing its
non-Markdown text to be swapped to Markdown format.

The README and relevant documentation pages are refactored so that the README
only contains the critical information, and references the main content within
the project documentation.

The Sphinx package 'm2r2' which supports embedding .md files within .rst files
is no longer necessary, and is removed.

Issue-Id: SCM-3529
Signed-off-by: Richard Neill's avatarRichard Neill <richard.neill@arm.com>
Change-Id: Ie6d5ac9f29a421bb6a9707aebfd0dcb36d416a07
      64c7db10
  19. Sep 20, 2021
  21. Sep 16, 2021
    • Richard Neill's avatar
      tools/qa-checks: Fix relative path calculation to the default config file · ebb55ff7
      Richard Neill authored 
      

The user should be able to execute the run-checks.py script from any location.
This patch fixes an issue where the relative path to the configuration YAML file
was not being resolved properly.

Issue-Id: SCM-3033
Signed-off-by: Richard Neill's avatarRichard Neill <richard.neill@arm.com>
Change-Id: Ia5ede51cf240eddb4fed436ed2ccc69d33b5bd3e
      ebb55ff7
    • Richard Neill's avatar
      doc: Update CI build tool directory · 6f030ae1
      Richard Neill authored 
      

This patch updates the documentation to state that the kas-ci-build.py build
script may be found in the project's tools/build directory, and clarifies that
the YAML files provided to it must be valid and present as kas configuration
files within meta-ewaol-config/kas.

Issue-Id: SCM-3042
Signed-off-by: Richard Neill's avatarRichard Neill <richard.neill@arm.com>
Change-Id: I9743ab0964b89c55a60793f1996867f6e4e3efed
      6f030ae1
    • Richard Neill's avatar
      tools/qa-checks: Improve the spelling QA check · 47ee05f3
      Richard Neill authored 
      

This patch improves the spelling QA check to make the check less likely to
produce false-positives, and to reduce the maintainence effort on the internal
custom dictionary.

This patch:
* Avoids 'spelling errors' found within ReStructuredText code-blocks or links,
  as these are almost certainly going to be technical words that do not need to
  be validated against standard English spelling. Headers are still checked, so
  internal links are validated at the definition.
* Expand substrings before validation, to allow the custom dictionary to
  contain (and successfully pass) only proper words.

Issue-Id: SCM-3033
Signed-off-by: Richard Neill's avatarRichard Neill <richard.neill@arm.com>
Change-Id: I5303b93293d27c8b04116e19313c60790b5b1710
      47ee05f3
    • Richard Neill's avatar
      tools/qa-checks: Enable the commit message QA-check to analyse patch chains · b737ded6
      Richard Neill authored 
      

This patch allows the user to provide a set of commits to the commit message
check, enabling the ability to analyse a patch chain.

To do this, the commit message accepts a 'commits' parameter, which should be
defined in one of the follow two formats:

* '-N' to check the latest N commit messages
* 'commit1(,commit2,...)' as a string list of commits to check. The commits
  must be valid when passed to the 'git show' command, for example a commit SHA
  or a relative commit like HEAD~2.

This patch also excludes lines that are URLs from the message length check, as
URLs are allowed break the maximum character length.

Issue-Id: SCM-3033
Signed-off-by: Richard Neill's avatarRichard Neill <richard.neill@arm.com>
Change-Id: I0a6aa7552206c7e4a963d9ddf0687ff773386957
      b737ded6
  23. Sep 15, 2021
    • Richard Neill's avatar
      tools/qa-checks: Add remaining error handling for missing Python modules · 26f34d27
      Richard Neill authored 
      

In order to read the configuration file, the host system must have the pyyaml
Python package. As this is needed prior to any virtual environment set up, this
patch notifies the user if it cannot be found and aborts gracefully.

In addition, wrap the module import to warn if email_validator cannot be found
for the commit message QA-check (this should only happen if not using a virtual
environment).

Issue-Id: SCM-3033
Signed-off-by: Richard Neill's avatarRichard Neill <richard.neill@arm.com>
Change-Id: Ia564ecdd2a26fa499d1a524232882a32883d4279
      26f34d27
    • Richard Neill's avatar
      ci: Add licence and copyright header to .gitlab-ci.yml · 9489b934
      Richard Neill authored 
      

Issue-Id: SCM-3042
Signed-off-by: Richard Neill's avatarRichard Neill <richard.neill@arm.com>
Change-Id: I750c07d22e2c3175c6b31358e5176abc38043619
      9489b934
    • Richard Neill's avatar
      tools/qa-checks: Enable configurable root directory for running the checks · 323660eb
      Richard Neill authored and Diego Sueiro's avatar Diego Sueiro committed 
      

User-provided relative paths are considered relative from the root directory.
This patch allows the user to configure that root directory, so that the checks
may be easily applied to other projects on the file system,

The patch also refactors how keyword values are initialised, making them only
evaluate if they are needed. For example, the contents of the project's
.gitignore will only be read and processed if needed for the check
configuration.

Issue-Id: SCM-3033
Signed-off-by: Richard Neill's avatarRichard Neill <richard.neill@arm.com>
Change-Id: I02a087477942e5b152546b23a01d38f45be004da
      323660eb
    • Richard Neill's avatar
      tools/qa-checks: Enable default deletion of temporary Python virtual environment · b7d6ca92
      Richard Neill authored and Diego Sueiro's avatar Diego Sueiro committed 
      

This patch adds the --keep_venv option to run-checks.py. If this is not passed,
the temporary venv will be deleted after the script has been executed, to avoid
unexpectedly filling up the user's /tmp directory.

Issue-Id: SCM-3033
Signed-off-by: Richard Neill's avatarRichard Neill <richard.neill@arm.com>
Change-Id: Iaf6fcc3329d7608c5bc6b997a1de887638c64b2b
      b7d6ca92
    • Richard Neill's avatar
      tools/qa-checks: Allow and validate license header format for external works · ff797436
      Richard Neill authored and Diego Sueiro's avatar Diego Sueiro committed 
      

Externally-licensed works may be included and modified within meta-ewaol. This
patch allows these files to pass the license and copyright header QA-check by
validating an additional alternative format:

    Based on: <Original filename>
    In open-source project: <Source project/repository>
    Original file: Copyright (c) YYYY(-YYYY) <Contributor>
    Modifications: Copyright (c) YYYY(-YYYY) <Contributor>
    SPDX-License-Identifier: <License name>

Original works contributed directly to meta-ewaol continue to use the standard
license and copyright header format:

    Copyright (c) YYYY(-YYYY) <Contributor>
    SPDX-License-Identifier: <License name>

Issue-Id: SCM-3033
Signed-off-by: Richard Neill's avatarRichard Neill <richard.neill@arm.com>
Change-Id: Id1b031f29ddb26b3a910365dab9781bd9bd3c4b1
      ff797436
    • Kamil Dzieżyk's avatar
      ewaol-distro/images: Add sdk image flavour · 98190d8e
      Kamil Dzieżyk authored and Diego Sueiro's avatar Diego Sueiro committed 
      

This patch adds 'ewaol-sdk' DISTRO_FEATURE to ease image customization.
It contains set of libraries, headers and packages that are useful during
software development on target board.
'ewaol-sdk' is inherited by default in EWAOL SDK images:
 * ewaol-image-docker-sdk
 * ewaol-image-podman-sdk

ewaol-sdk enables:
 * Packages:
   - gator-daemon
   - kernel-devsrc
   - kernel-modules
 * IMAGE_FEATURES:
   - package-management
   - dev-pkgs
   - tools-debug
   - tools-sdk
   - tools-profile
   - debug-tweaks
   - ssh-server-openssh

Issue-ID: SCM-2394
Signed-off-by: Kamil Dzieżyk's avatarKamil Dziezyk <kamil.dziezyk@arm.com>
Change-Id: I22ea4ead8711671af6d9bc360f45748031720eca
      98190d8e