| commit | b695011268e3923928afa3a55b68786179cf8cf6 | [log] [tgz] |
|---|---|---|
| author | Sam Elliott <selliott@lowrisc.org> | Tue Feb 11 20:41:47 2020 +0000 |
| committer | Philipp Wagner <mail@philipp-wagner.com> | Wed Feb 12 16:24:15 2020 +0000 |
| tree | 993acd95b78b23f3f77fd3315355ef3656bbca36 | |
| parent | cc0231da22278451d9b5170f038b787cce4e77f9 [diff] |
[doc] Add C Style Guide Rules for Symbol Naming Unlike C++, C does not have user-defined namespaces. This means programmers need to be a lot more careful when naming types, functions, and symbols. The following two rules have come up in the software team when discussing the DIFs, and I feel they are important enough to go into the OpenTitan-wide C style guide. 1. All symbols in a particular header must share the same unique prefix. 2. The names of enumeration constants must be prefixed with the name of their respective enumeration type. This commit adds both rules with some explanation as to why they are needed, and some illustrative examples. 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 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).