| commit | 266b3a558b272e0a6fa27c8e598ca97481068705 | [log] [tgz] |
|---|---|---|
| author | Eunchan Kim <eunchan@google.com> | Wed Oct 09 14:31:57 2019 -0700 |
| committer | Eunchan Kim <eunchan@google.com> | Wed Oct 30 09:47:58 2019 -0700 |
| tree | 5ec02751defcaedee55708f50779d1b70259696f | |
| parent | 0c31dd6b45e5b5a0cb31d91763a6331e9547ff73 [diff] |
[doc/rm] Crossbar Tool Add `tlgen.py`, more generally `util/tlgen`, document to help understanding how the crossbar is being generated in OpenTitan and its usage. To generate tlgen selfdoc, validate has checker logic inside. The checking structure (control group) is slightly changed from its in reggen. The change makes validate to run recursively and generate the doc recursively. This document addresses the issue #340.
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).
