| commit | aef0a667f7c4b2dcebe09af35ae8a693d277c496 | [log] [tgz] |
|---|---|---|
| author | Hugo McNally <hugo.mcnally@gmail.com> | Sat Feb 11 19:44:55 2023 +0000 |
| committer | Greg Chadwick <mail@gregchadwick.co.uk> | Tue Mar 07 11:41:43 2023 +0000 |
| tree | 6e151d1c9773ddd35c6c0bde0f97bbee850b4f80 | |
| parent | eb1350fb8c988df763b780dd4579dfbdb409f279 [diff] |
[doc] Replaced Hugo links with standard markdown A script, `util/check_links.py`, was written by Amaury to automate most of the relinking. Below are the commands run to perform the relinking. Some moves had to be manually added to the move list, because they were either not properly tracked by git or to fix quirky behaviour of the script. Note that command has to be run twice because it can't handle non-bijective moves and that it incorrectly re-links two files, which are fixed in the final file. ``` git show --name-status HEAD~11..HEAD | grep '^R100' | sed 's/^R100\t//' > move_list.txt echo "hw/dv/sv/dv_utils/doc/index.md hw/dv/sv/dv_utils/README.md" >> move_list.txt echo "hw/dv/tools/doc/index.md hw/dv/tools/README.md" >> move_list.txt echo "README.md doc/introduction.md" >> move_list.txt echo "doc/project/checklist.md doc/project_governance/checklist/README.md" >> move_list.txt ./util/check_links.py . --ignore-book --move-list-file move_list.txt --apply echo "hw/dv/tools/README.md util/dvsim/README.md" > move_list.txt ./util/check_links.py . --ignore-book --move-list-file move_list.txt --apply git checkout HEAD -- SUMMARY.md hw/doc/cores.md ``` Signed-off-by: Hugo McNally <hugo.mcnally@gmail.com> Co-authored-by: Amaury Pouly <amaury.pouly@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 access it online at docs.opentitan.org.
Have a look at CONTRIBUTING and our documentation on project organization and processes 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).