Google Git
Sign in
opensecura / 3p / lowrisc / opentitan / fd597f15d862cbca95e570cd71044a7b0a8e45ee^! / .
commitfd597f15d862cbca95e570cd71044a7b0a8e45ee[log] [tgz]
authorHugo McNally <hugo.mcnally@gmail.com>Wed Feb 08 12:19:53 2023 +0000
committerGreg Chadwick <mail@gregchadwick.co.uk>Tue Mar 07 11:41:43 2023 +0000
tree7567483d1244c821874534a6fad7ec9298319d72
parent9057c75c328bbec5e6cfd5713372cacd190c1e9d [diff]
[doc mv] `util/` doc files moved for new layout.

No file has been modified, so that git can more easily track moved files.

`util/_index.md` was deleted as `doc/rm/_index.md`
was a better starting point for a `util` overview/summary.

Signed-off-by: Hugo McNally <hugo.mcnally@gmail.com>
Co-authored-by: Harry Callahan <hcallahan@lowrisc.org>
Co-authored-by: James Wainwright <james.wainwright@lowrisc.org>

diff --git a/doc/rm/_index.md b/util/README.md
similarity index 100%
rename from doc/rm/_index.md
rename to util/README.md

diff --git a/util/_index.md b/util/_index.md
deleted file mode 100644
index 8c1ff93..0000000
--- a/util/_index.md
+++ /dev/null

@@ -1,11 +0,0 @@
----
-title: "Utilities"
----
-
-This is the landing spot for utility script documentation within the OpenTitan project.
-Primarily these are README files about tooling scripts used to generate technical content.
-More description and information can be found within the [Reference Manual]({{< relref "doc/rm" >}}) and [User Guide]({{< relref "doc/ug" >}}) areas.
-
-## Utility READMEs
-
-{{% sectionContent %}}

diff --git a/doc/rm/vendor_in_tool.md b/util/doc/vendor.md
similarity index 100%
rename from doc/rm/vendor_in_tool.md
rename to util/doc/vendor.md

diff --git a/util/dvsim/doc/testplanner.md b/util/dvsim/README.md
similarity index 100%
rename from util/dvsim/doc/testplanner.md
rename to util/dvsim/README.md

diff --git a/util/fpvgen/doc/index.md b/util/fpvgen/README.md
similarity index 100%
rename from util/fpvgen/doc/index.md
rename to util/fpvgen/README.md

diff --git a/doc/rm/ipgen_tool.md b/util/ipgen/README.md
similarity index 100%
rename from doc/rm/ipgen_tool.md
rename to util/ipgen/README.md

diff --git a/doc/rm/register_tool/index.md b/util/reggen/README.md
similarity index 100%
rename from doc/rm/register_tool/index.md
rename to util/reggen/README.md

diff --git a/doc/rm/register_tool/reg_top.svg b/util/reggen/doc/reg_top.svg
similarity index 100%
rename from doc/rm/register_tool/reg_top.svg
rename to util/reggen/doc/reg_top.svg

diff --git a/util/reggen/doc/index.md b/util/reggen/doc/setup_and_use.md
similarity index 100%
rename from util/reggen/doc/index.md
rename to util/reggen/doc/setup_and_use.md

diff --git a/doc/rm/register_tool/subreg_ext.svg b/util/reggen/doc/subreg_ext.svg
similarity index 100%
rename from doc/rm/register_tool/subreg_ext.svg
rename to util/reggen/doc/subreg_ext.svg

diff --git a/doc/rm/register_tool/subreg_rw.svg b/util/reggen/doc/subreg_rw.svg
similarity index 100%
rename from doc/rm/register_tool/subreg_rw.svg
rename to util/reggen/doc/subreg_rw.svg

diff --git a/doc/rm/register_tool/subreg_rw0c.svg b/util/reggen/doc/subreg_rw0c.svg
similarity index 100%
rename from doc/rm/register_tool/subreg_rw0c.svg
rename to util/reggen/doc/subreg_rw0c.svg

diff --git a/doc/rm/register_tool/subreg_rw1c.svg b/util/reggen/doc/subreg_rw1c.svg
similarity index 100%
rename from doc/rm/register_tool/subreg_rw1c.svg
rename to util/reggen/doc/subreg_rw1c.svg

diff --git a/doc/rm/register_tool/subreg_rw1s.svg b/util/reggen/doc/subreg_rw1s.svg
similarity index 100%
rename from doc/rm/register_tool/subreg_rw1s.svg
rename to util/reggen/doc/subreg_rw1s.svg

diff --git a/doc/rm/register_tool/subreg_shadow.svg b/util/reggen/doc/subreg_shadow.svg
similarity index 100%
rename from doc/rm/register_tool/subreg_shadow.svg
rename to util/reggen/doc/subreg_shadow.svg

diff --git a/doc/rm/crossbar_tool/index.md b/util/tlgen/README.md
similarity index 100%
rename from doc/rm/crossbar_tool/index.md
rename to util/tlgen/README.md

diff --git a/doc/rm/crossbar_tool/crossbar_example_1.svg b/util/tlgen/doc/crossbar_example_1.svg
similarity index 100%
rename from doc/rm/crossbar_tool/crossbar_example_1.svg
rename to util/tlgen/doc/crossbar_example_1.svg

diff --git a/doc/rm/crossbar_tool/crossbar_example_2.svg b/util/tlgen/doc/crossbar_example_2.svg
similarity index 100%
rename from doc/rm/crossbar_tool/crossbar_example_2.svg
rename to util/tlgen/doc/crossbar_example_2.svg

diff --git a/doc/rm/crossbar_tool/crossbar_example_3.svg b/util/tlgen/doc/crossbar_example_3.svg
similarity index 100%
rename from doc/rm/crossbar_tool/crossbar_example_3.svg
rename to util/tlgen/doc/crossbar_example_3.svg

diff --git a/doc/rm/crossbar_tool/crossbar_example_4.svg b/util/tlgen/doc/crossbar_example_4.svg
similarity index 100%
rename from doc/rm/crossbar_tool/crossbar_example_4.svg
rename to util/tlgen/doc/crossbar_example_4.svg

diff --git a/doc/rm/crossbar_tool/crossbar_example_5.svg b/util/tlgen/doc/crossbar_example_5.svg
similarity index 100%
rename from doc/rm/crossbar_tool/crossbar_example_5.svg
rename to util/tlgen/doc/crossbar_example_5.svg

diff --git a/doc/rm/topgen_tool.md b/util/topgen/README.md
similarity index 100%
rename from doc/rm/topgen_tool.md
rename to util/topgen/README.md

diff --git a/util/uvmdvgen/doc/index.md b/util/uvmdvgen/README.md
similarity index 100%
rename from util/uvmdvgen/doc/index.md
rename to util/uvmdvgen/README.md