Skip to content

Commit 5e3eeb5

Browse files
thoughtpolicechristiaanb
authored andcommitted
tutorial: follow up with new CLI flags (#124)
Signed-off-by: Austin Seipp <[email protected]>
1 parent 9390522 commit 5e3eeb5

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/CLaSH/Tutorial.hs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1238,8 +1238,8 @@ a general listing of the available template holes:
12381238
other cases. Valid @\<CONDITION\>@s are @~LENGTH[\<HOLE\>]@, @~SIZE[\<HOLE\>]@,
12391239
@~DEPTH[\<HOLE\>]@, @~VIVADO@, @~IW64@, @~ISLIT[N]@, @~ISVAR[N], @~ISGATED[N]@,
12401240
@~ISSYNC[N]@, and @~AND[\<HOLE1\>,\<HOLE2\>,..]@.
1241-
* @~VIVADO@: /1/ when CλaSH compiler is invoked with the @-clash-xilinx@ or
1242-
@-clash-vivado@ flag. To be used with in an @~IF .. ~THEN .. ~ElSE .. ~FI@
1241+
* @~VIVADO@: /1/ when CλaSH compiler is invoked with the @-fclash-xilinx@ or
1242+
@-fclash-vivado@ flag. To be used with in an @~IF .. ~THEN .. ~ElSE .. ~FI@
12431243
statement.
12441244
* @~FROMBV[\<HOLE\>][\<TYPE\>]@: create conversion code that so that the
12451245
expression in @\<HOLE\>@ is converted to a bit vector (@std_logic_vector@).
@@ -2082,12 +2082,12 @@ Here is a list of Haskell features for which the CλaSH compiler has only
20822082
* 'Int8'
20832083
* 'Int16'
20842084
* 'Int32'
2085-
* 'Int64' (not available when compiling with @-clash-intwidth=32@ on a 64-bit machine)
2085+
* 'Int64' (not available when compiling with @-fclash-intwidth=32@ on a 64-bit machine)
20862086
* 'Word'
20872087
* 'Word8'
20882088
* 'Word16'
20892089
* 'Word32'
2090-
* 'Word64' (not available when compiling with @-clash-intwidth=32@ on a 64-bit machine)
2090+
* 'Word64' (not available when compiling with @-fclash-intwidth=32@ on a 64-bit machine)
20912091
* 'Char'
20922092
20932093
There are several aspects of which you should take note:
@@ -2100,13 +2100,13 @@ Here is a list of Haskell features for which the CλaSH compiler has only
21002100
machine, and the other has a 64-bit machine. In general, you should
21012101
be avoiding 'Int' in such cases, but as a band-aid solution, you can
21022102
force the CλaSH compiler to use a specific bit-width for `Int` and
2103-
`Word` using the @-clash-intwidth=N@ flag, where /N/ must either be
2103+
`Word` using the @-fclash-intwidth=N@ flag, where /N/ must either be
21042104
/32/ or /64/.
21052105
2106-
* When you use the @-clash-intwidth=32@ flag on a /64-bit/ machine,
2106+
* When you use the @-fclash-intwidth=32@ flag on a /64-bit/ machine,
21072107
the 'Word64' and 'Int64' types /cannot/ be translated. This
21082108
restriction does /not/ apply to the other three combinations of
2109-
@-clash-intwidth@ flag and machine type.
2109+
@-fclash-intwidth@ flag and machine type.
21102110
21112111
* The translation of 'Integer' is not meaning-preserving. 'Integer' in
21122112
Haskell is an arbitrary precision integer, something that cannot
@@ -2115,7 +2115,7 @@ Here is a list of Haskell features for which the CλaSH compiler has only
21152115
as we do for 'Int' and 'Word'. As you have read in a previous
21162116
bullet point, this number of bits is either 32 or 64, depending on
21172117
the architecture of the machine the CλaSH compiler is running on, or
2118-
the setting of the @-clash-intwidth@ flag.
2118+
the setting of the @-fclash-intwidth@ flag.
21192119
21202120
Consequently, you should use `Integer` with due diligence; be
21212121
especially careful when using `fromIntegral` as it does a conversion

0 commit comments

Comments
 (0)