summaryrefslogtreecommitdiff
path: root/docs/src/wiki-deprecated
diff options
context:
space:
mode:
authorAdam Izraelevitz2020-10-26 16:48:44 -0700
committerGitHub2020-10-26 23:48:44 +0000
commit58fa3c1118d9e892895970d48e2ba8a3c182bb81 (patch)
treea672be8750c8c8dd2bb1645f88b4ce1bbbb37993 /docs/src/wiki-deprecated
parent1b6bd89dfafc774af1c926a982418294091f6346 (diff)
Fix crosslinks in mdoc. Can't use md suffix (#1640)
* Fix crosslinks in mdoc. Can't use md suffix * Removed all .md crossrefs Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Diffstat (limited to 'docs/src/wiki-deprecated')
-rw-r--r--docs/src/wiki-deprecated/chisel3-vs-chisel2.md2
-rw-r--r--docs/src/wiki-deprecated/cookbook.md2
-rw-r--r--docs/src/wiki-deprecated/data-types.md2
-rw-r--r--docs/src/wiki-deprecated/developers.md4
-rw-r--r--docs/src/wiki-deprecated/faqs.md8
-rw-r--r--docs/src/wiki-deprecated/memories.md2
-rw-r--r--docs/src/wiki-deprecated/reset.md2
-rw-r--r--docs/src/wiki-deprecated/supported-hardware.md2
8 files changed, 12 insertions, 12 deletions
diff --git a/docs/src/wiki-deprecated/chisel3-vs-chisel2.md b/docs/src/wiki-deprecated/chisel3-vs-chisel2.md
index 6f14a2eb..c6fa83ed 100644
--- a/docs/src/wiki-deprecated/chisel3-vs-chisel2.md
+++ b/docs/src/wiki-deprecated/chisel3-vs-chisel2.md
@@ -89,7 +89,7 @@ for instructions on preparing your Chisel2 designs for Chisel3.
## Unsupported constructs
* `Mem(..., orderedWrites)` is no longer supported,
* masked writes are only supported for `Mem[Vec[_]]`,
-* Chisel3 Vecs must all have the same type, unlike with Chisel2. Use `MixedVec` (see [Bundles and Vecs](bundles-and-vecs.md)) for Vecs where the elements are of different types.
+* Chisel3 Vecs must all have the same type, unlike with Chisel2. Use `MixedVec` (see [Bundles and Vecs](bundles-and-vecs)) for Vecs where the elements are of different types.
* connections between `UInt` and `SInt` are illegal.
* the `Node` class and object no longer exist (the class should have been private in Chisel2)
* `printf()` is defined in the Chisel object and produces simulation printf()'s.
diff --git a/docs/src/wiki-deprecated/cookbook.md b/docs/src/wiki-deprecated/cookbook.md
index 9988fc82..7fa97579 100644
--- a/docs/src/wiki-deprecated/cookbook.md
+++ b/docs/src/wiki-deprecated/cookbook.md
@@ -6,7 +6,7 @@ section: "chisel3"
Welcome to the Chisel cookbook. This cookbook is still in early stages. If you have any requests or examples to share, please [file an issue](https://github.com/ucb-bar/chisel3/issues/new) and let us know!
-Please note that these examples make use of [Chisel's scala-style printing](printing.md#scala-style).
+Please note that these examples make use of [Chisel's scala-style printing](printing#scala-style).
* Converting Chisel Types to/from UInt
* [How do I create a UInt from an instance of a Bundle?](#how-do-i-create-a-uint-from-an-instance-of-a-bundle)
diff --git a/docs/src/wiki-deprecated/data-types.md b/docs/src/wiki-deprecated/data-types.md
index 227dee66..e931247f 100644
--- a/docs/src/wiki-deprecated/data-types.md
+++ b/docs/src/wiki-deprecated/data-types.md
@@ -17,7 +17,7 @@ format. Boolean values are represented as type ```Bool```. Note
that these types are distinct from Scala's builtin types such as
```Int``` or ```Boolean```.
-> There is a new experimental type **Interval** which gives the developer more control of the type by allowing the definition of an IntervalRange. See: [Interval Type](interval-type.md)
+> There is a new experimental type **Interval** which gives the developer more control of the type by allowing the definition of an IntervalRange. See: [Interval Type](interval-type)
Additionally, Chisel defines `Bundles` for making
collections of values with named fields (similar to ```structs``` in
diff --git a/docs/src/wiki-deprecated/developers.md b/docs/src/wiki-deprecated/developers.md
index ba5a1a62..4c133c54 100644
--- a/docs/src/wiki-deprecated/developers.md
+++ b/docs/src/wiki-deprecated/developers.md
@@ -7,5 +7,5 @@ section: "chisel3"
Tips and tricks for Chisel developers.
-* [Embedding Chisel as an sbt subproject](sbt-subproject.md)
-* [Test Coverage](test-coverage.md)
+* [Embedding Chisel as an sbt subproject](sbt-subproject)
+* [Test Coverage](test-coverage)
diff --git a/docs/src/wiki-deprecated/faqs.md b/docs/src/wiki-deprecated/faqs.md
index dfb01afe..45694cdc 100644
--- a/docs/src/wiki-deprecated/faqs.md
+++ b/docs/src/wiki-deprecated/faqs.md
@@ -24,7 +24,7 @@ We recommend the [Chisel Bootcamp](https://github.com/freechipsproject/chisel-bo
### How do I do ... (e.g. like that in Verilog) in Chisel?
-See the [cookbook](cookbook.md).
+See the [cookbook](cookbook).
### How can I contribute to Chisel?
@@ -78,7 +78,7 @@ Chisel Modules are written by defining a [Scala class](http://docs.scala-lang.or
### Why Chisel?
-Borrowed from [Chisel Introduction](introduction.md)
+Borrowed from [Chisel Introduction](introduction)
>We were motivated to develop a new hardware language by years of
struggle with existing hardware description languages in our research
@@ -226,7 +226,7 @@ res3: java.io.File = output.fir
### Why doesn't Chisel tell me which wires aren't connected?
As of commit [c313e13](https://github.com/freechipsproject/chisel3/commit/c313e137d4e562ef20195312501840ceab8cbc6a) it can!
-Please visit the wiki page [Unconnected Wires](unconnected-wires.md) for details.
+Please visit the wiki page [Unconnected Wires](unconnected-wires) for details.
### What does `Reference ... is not fully initialized.` mean?
@@ -235,7 +235,7 @@ It means that you have unconnected wires in your design which could be an indica
In Chisel2 compatibility mode (`NotStrict` compile options), chisel generates firrtl code that disables firrtl's initialized wire checks.
In pure chisel3 (`Strict` compile options), the generated firrtl code does not contain these disablers (`is invalid`).
Output wires that are not driven (not connected) are reported by firrtl as `not fully initialized`.
-Please visit the wiki page [Unconnected Wires](unconnected-wires.md) for details on solving the problem.
+Please visit the wiki page [Unconnected Wires](unconnected-wires) for details on solving the problem.
### Can I specify behavior before and after generated initial blocks?
Users may define the following macros if they wish to specify behavior before or after emitted initial blocks.
diff --git a/docs/src/wiki-deprecated/memories.md b/docs/src/wiki-deprecated/memories.md
index 6104309c..e4b9a80b 100644
--- a/docs/src/wiki-deprecated/memories.md
+++ b/docs/src/wiki-deprecated/memories.md
@@ -101,7 +101,7 @@ class RWSmem extends Module {
}
```
-(The `DontCare` is there to make Chisel's [unconnected wire detection](unconnected-wires.md) aware that reading while writing is undefined.)
+(The `DontCare` is there to make Chisel's [unconnected wire detection](unconnected-wires) aware that reading while writing is undefined.)
Here is an example single read/write port waveform, with [masks](#masks) (again, generated signal names and number of arrays may differ):
diff --git a/docs/src/wiki-deprecated/reset.md b/docs/src/wiki-deprecated/reset.md
index 5f9626dd..1b35dc00 100644
--- a/docs/src/wiki-deprecated/reset.md
+++ b/docs/src/wiki-deprecated/reset.md
@@ -117,7 +117,7 @@ You can also cast to force the concrete type of reset.
* `.asAsyncReset` will reinterpret a `Reset` as `AsyncReset`.
You can then use `withReset` to use a cast reset as the implicit reset.
-See ["Multiple Clock Domains"](multi-clock.md) for more information about `withReset`.
+See ["Multiple Clock Domains"](multi-clock) for more information about `withReset`.
The following will make `myReg` as well as both `resetAgnosticReg`s synchronously reset:
diff --git a/docs/src/wiki-deprecated/supported-hardware.md b/docs/src/wiki-deprecated/supported-hardware.md
index 9dad221d..97f82698 100644
--- a/docs/src/wiki-deprecated/supported-hardware.md
+++ b/docs/src/wiki-deprecated/supported-hardware.md
@@ -3,6 +3,6 @@ layout: docs
title: "Supported Hardware"
section: "chisel3"
---
-While Chisel focuses on binary logic, Chisel can support analog and tri-state wires with the `Analog` type - see [Datatypes in Chisel](data-types.md).
+While Chisel focuses on binary logic, Chisel can support analog and tri-state wires with the `Analog` type - see [Datatypes in Chisel](data-types).
We focus on binary logic designs as they constitute the vast majority of designs in practice. Tri-state logic are poorly supported standard industry flows and require special/controlled hard macros in order to be done.