| commit | 6d091ec1b6cfce92e27785aa6b583aee50faf022 | [log] [tgz] |
|---|---|---|
| author | Alex Bradbury <asb@lowrisc.org> | Mon Nov 04 14:24:31 2019 +0000 |
| committer | Alex Bradbury <asb@asbradbury.org> | Tue Nov 05 11:14:11 2019 +0000 |
| tree | b6c6a8a3b9d25bb63d57ef93239a84d359a840f2 | |
| parent | db9c2710c19c4b16287b901ec56aed44d32c8f67 [diff] |
[util] Add checker for Signed-off-by lines in commit messages Lack of a Signed-off-by line with name and email metadata matching the commit author will be a failure for `lint_commits.py`, which in the current setup will cause CI to fail. Signed-off-by: Alex Bradbury <asb@lowrisc.org>
This repository contains hardware, software and utilities written as part of the OpenTitan project. It is structured as monolithic repository, or “monorepo”, where all components live in one repository.
The project contains comprehensive documentation of all IPs and tools. You can either access it online or build it locally by following the steps below.
Download and install hugo-extended.
Ensure that you have the required Python modules installed (to be executed in the repository root):
$ sudo apt install python3 python3-pip $ pip3 install --user -r python-requirements.txt
$ ./util/build_docs.py --preview
This compiles the documentation into ./build/docs and starts a local server, which allows you to access the documentation at http://127.0.0.1:1313.
Have a look at CONTRIBUTING for guidelines on how to contribute code to this repository.
Unless otherwise noted, everything in this repository is covered by the Apache License, Version 2.0 (see LICENSE for full text).