| commit | 3fbb28a27a1511a702838aebd35ed361ea7c377e | [log] [tgz] |
|---|---|---|
| author | Miguel Young de la Sota <mcyoung@google.com> | Wed Oct 16 15:15:07 2019 -0500 |
| committer | Miguel Young <mcyoung@google.com> | Fri Oct 25 10:54:09 2019 -0500 |
| tree | 4fe4c339cbf064d5ca093353a75c6947fea4fee5 | |
| parent | be2293d49db42cfd88d386ef6350b30104898794 [diff] |
[sw] Require absolute import paths in software. This change modifies meson_init.sh so that meson does not emit -I arguments which are rooted at REPO_TOP. Concretely, any C/C++ file that wants to use sw/lib/my_cool_difs.h must write - `#include "sw/lib/my_cool_difs.h"` This will improve include hygine significantly as the project grows on the software side. Meson really, really wants to believe in a Make-like project where we don't care about this, and where you can include foo.h as foo.h if your TU is in the same directory. However, Ninja doesn't care, so we do minor postprocessing to remove precarious -I arguments. Due to how Meson treats generated headers, though, there really isn't a good way to make enforce this on generated files. For now, generated register files are included in the old way, but for tracking purposes we adopt the following convention: - `#include "my_cool_peripheral_regs.h" // Generated.` "Generated" includes are placed in a separate stanza before normal includes, but after system library imports. The existing Makefile flow should have been preserved; I just restricted the -I arguments to REPO_TOP.
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.
$ sudo apt install python3 python3-pip $ pip3 install --user -r python-requirements.txt
$ ./util/build_docs.py --preview
This compiles the documentation into ./opentitan-docs and starts a local server, which allows you to access the documentation at http://127.0.0.1:5500.
Have a look at CONTRIBUTING.md for guidelines 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).