commit | 2a4448bc769c64fa850547a4115df025a6aff43b | [log] [tgz] |
---|---|---|
author | Sam Elliott <selliott@lowrisc.org> | Thu Apr 23 11:15:43 2020 +0100 |
committer | Philipp Wagner <mail@philipp-wagner.com> | Fri Apr 24 19:01:16 2020 +0100 |
tree | 41c9dd56514f676dbe0793bddb8d0e165fc43d48 | |
parent | 7fe0fb011cdc4641960654df0da0d3836d2c42e2 [diff] |
[topgen] Clang-format ignore top_earlgrey.{c,h} There are issues with running different versions of clang-format on these generated files causing conflicts (see #2035). In order to avoid making hardware engineers have the right version of clang-format installed when making a hardware-only change to topgen, we instead ignore clang-formatting on the C files that are autogenerated. This should cut down on formatting issues introduced by hardware-only changes, while still ensuring that the software tree is kept well-formatted. The `.clang-format` file introduced into the sw/autogen directory is so that utilities like `git-clang-format` will not attempt to reformat the files in that directory. Signed-off-by: Sam Elliott <selliott@lowrisc.org>
OpenTitan is an open source silicon Root of Trust (RoT) project. OpenTitan will make the silicon RoT design and implementation more transparent, trustworthy, and secure for enterprises, platform providers, and chip manufacturers. OpenTitan is administered by lowRISC CIC as a collaborative project to produce high quality, open IP for instantiation as a full-featured product. See the OpenTitan site and OpenTitan docs for more information about the project.
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. It exists to enable collaboration across partners participating in the OpenTitan project.
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 curl 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).