Skip to content

Commit 64ffcd4

Browse files
Copyediting
In the interest of not making people chase links, the FAQ reproduces the text at `getting-started/installing.md` instead of linking to it.
1 parent 83930ea commit 64ffcd4

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

compiler-user-guide/src/developing-hardware/annotations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Functions with a `Synthesize` annotation must adhere to the following restrictio
1515
Also take the following into account when using `Synthesize` annotations.
1616

1717
* The Clash compiler is based on the GHC Haskell compiler, and the GHC machinery does not understand `Synthesize` annotations and it might subsequently decide to inline those functions.
18-
You should therefor also add a `{-# OPAQUE f #-}` pragma to the functions which you give a `Synthesize` functions.
18+
You should therefore also add a `{-# OPAQUE f #-}` pragma to the functions which you give a `Synthesize` annotation.
1919
* Functions with a `Synthesize` annotation will not be specialized on constants.
2020

2121
Finally, the root module, the module which you pass as an argument to the Clash compiler must either have:

compiler-user-guide/src/developing-hardware/primitives.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ Instead of discussing what the individual template holes mean in the above conte
259259

260260
Some final remarks to end this section: HDL primitives are there to instruct the Clash compiler to use the given HDL template, instead of trying to do normal synthesis.
261261
As a consequence you can use constructs inside the Haskell definitions that are normally not synthesizable by the Clash compiler.
262-
However, VHDL primitives do not give us _co-simulation_: where you would be able to simulate VHDL and Haskell in a _single_ environment.
262+
However, VHDL primitives do not give us _co-simulation_, where you would be able to simulate VHDL and Haskell in a _single_ environment.
263263
If you still want to simulate your design in Haskell, you will have to describe, in a cycle- and bit-accurate way, the behavior of that (potentially complex) IP you are trying to include in your design.
264264

265265
## Verilog examples

compiler-user-guide/src/general/faqs.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
- **Q**: How do I install Clash?
66

7-
**A**: Check out the `installing` page in the *Getting Started* section of the manual.
7+
**A**: Check out [clash-lang.org/install](https://clash-lang.org/install) to install the latest stable release of Clash, or to setup a Clash project.
88

99
------------------------------------------------------------------------
1010

@@ -19,10 +19,10 @@
1919

2020
------------------------------------------------------------------------
2121

22-
- **Q**: Is Clash a "high level synthesis" tool?
22+
- **Q**: Is Clash a "high-level synthesis" tool?
2323

24-
**A**: While clash provides a high level language features, hardware descriptions written in Clash are not decoupled from clock-level timing.
25-
Clash does therefore not offer what is generally understood as "high level synthesis".
24+
**A**: While clash provides high-level language features, hardware descriptions written in Clash are not decoupled from clock-level timing.
25+
Clash does therefore not offer what is generally understood as "high-level synthesis".
2626
Compared to the big three hardware description languages, *VHDL*, *Verilog*, and *SystemVerilog*, Clash arguably *is* high-level.
2727
It offers many of the powerful abstractions that modern software programming languages offer.
2828
In fact, it inherits many of the software industry's bleeding-edge features by virtue of basing its implementation on Haskell.
@@ -32,7 +32,7 @@
3232
- **Q**: Is Clash production ready?
3333

3434
**A**: Clash is constantly evolving, and since the 1.0 release there is a focus on maintaining API backwards compatibility.
35-
Clash is used successfully in real-world scenarios, and [QBayLogic Clash support](https://qbaylogic.com/clash-support.html) can help with education and implementation of Clash projects.
35+
Clash is used successfully in real-world scenarios, and [QBayLogic Clash support](https://qbaylogic.com/services/) can help with education and implementation of Clash projects.
3636

3737
------------------------------------------------------------------------
3838

@@ -43,7 +43,7 @@
4343

4444
For most toolchains, the default primitives supplied by Clash should work with minimal effort.
4545
If not, it is possible to call your vendor's library manually, or use a tool like [Yosys](http://clifford.at/yosys) to do mapping.
46-
It is also possible to consult [QBayLogic Clash support](https://qbaylogic.com/clash-support.html) for more assistance.
46+
It is also possible to consult [QBayLogic Clash support](https://qbaylogic.com/services/) for more assistance.
4747

4848
------------------------------------------------------------------------
4949

@@ -60,7 +60,7 @@
6060
Clash can be used for ASIC designs, however the RTL produced by Clash may not be immediately suitable as it is largely platform agnostic.
6161
While this is not a problem for FPGAs, it can make developing ASICs more complicated as many ASIC vendors have different proprietary tool flows, with limited information available about their workings.
6262

63-
If you are using Clash to develop for ASIC, and need assistance with getting your toolchain to work, you can contact [QBayLogic Clash support](https://qbaylogic.com/clash-support.html) for assistance.
63+
If you are using Clash to develop for ASIC, and need assistance with getting your toolchain to work, you can contact [QBayLogic Clash support](https://qbaylogic.com/services/) for assistance.
6464

6565
## Clash and Haskell
6666

compiler-user-guide/src/general/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Note
9090

9191
</div>
9292

93-
Due to the Clash's tight integration with GHC, updates to the GHC version that Clash uses result in changes to the Clash version.
93+
Due to Clash's tight integration with GHC, updates to the GHC version that Clash uses result in changes to the Clash version.
9494
As GHC's internals change frequently, even for minor bumps, it cannot be guaranteed that these changes will not result in Clash changes.
9595

9696
</div>

0 commit comments

Comments
 (0)