| commit | ef72c0e67832250700ad5ecfc559f67985add03c | [log] [tgz] |
|---|---|---|
| author | Philipp Wagner <phw@lowrisc.org> | Wed Oct 16 16:42:08 2019 +0100 |
| committer | Philipp Wagner <mail@philipp-wagner.com> | Wed Oct 23 10:12:17 2019 +0100 |
| tree | b66a199f60a7ae4e09e604df3093350eff4f0680 | |
| parent | 226eab6dfe7523472751677e35572211a8013596 [diff] |
[rv_dm] Document the Debug System wrapper The debug system wrapper instantiates the PULP Debug System, which we vendor in. The vendored-in code contains documentation that follows our documentation standards. This commit adds documentation for the debug system wrapper. It points to the upstream documentation, and explains the additional functinality provided by the wrapper. Fixes #343
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).