Skip to content

Commit

Permalink
Tutorial: ~TYPELEM should be ~TYPEL
Browse files Browse the repository at this point in the history
(cherry picked from commit 735f1ce)
  • Loading branch information
JvWesterveld authored and martijnbastiaan committed Apr 23, 2020
1 parent b210fb2 commit 845a233
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions clash-prelude/src/Clash/Tutorial.hs
Original file line number Diff line number Diff line change
Expand Up @@ -1226,14 +1226,14 @@ a general listing of the available template holes:
of the signal, and the type of the @(N+1)@'th argument.
* @~SIGDO[\<HOLE\>]@: Create a signal declaration, using @\<HOLE\>@ as the name
of the signal, and the type of the result.
* @~TYPELEM[\<HOLE\>]@: The element type of the vector type represented by @\<HOLE\>@.
The content of @\<HOLE\>@ must either be: @TYP[N]@, @TYPO@, or @TYPELEM[\<HOLE\>]@.
* @~TYPEL[\<HOLE\>]@: The element type of the vector type represented by @\<HOLE\>@.
The content of @\<HOLE\>@ must either be: @~TYP[N]@, @~TYPO@, or @~TYPEL[\<HOLE\>]@.
* @~COMPNAME@: The name of the component in which the primitive is instantiated.
* @~LENGTH[\<HOLE\>]@: The vector length of the type represented by @\<HOLE\>@.
* @~DEPTH[\<HOLE\>]@: The tree depth of the type represented by @\<HOLE\>@.
The content of @\<HOLE\>@ must either be: @TYP[N]@, @TYPO@, or @TYPELEM[\<HOLE\>]@.
The content of @\<HOLE\>@ must either be: @~TYP[N]@, @~TYPO@, or @~TYPEL[\<HOLE\>]@.
* @~SIZE[\<HOLE\>]@: The number of bits needed to encode the type represented by @\<HOLE\>@.
The content of @\<HOLE\>@ must either be: @TYP[N]@, @TYPO@, or @TYPELEM[\<HOLE\>]@.
The content of @\<HOLE\>@ must either be: @~TYP[N]@, @~TYPO@, or @~TYPEL[\<HOLE\>]@.
* @~IF \<CONDITION\> ~THEN \<THEN\> ~ELSE \<ELSE\> ~FI@: renders the @\<ELSE\>@
part when @\<CONDITION\>@ evaluates to /0/, and renders the @\<THEN\>@ in all
other cases. Valid @\<CONDITION\>@s are @~LENGTH[\<HOLE\>]@, @~SIZE[\<HOLE\>]@,
Expand All @@ -1245,11 +1245,11 @@ a general listing of the available template holes:
* @~TOBV[\<HOLE\>][\<TYPE\>]@: create conversion code that so that the
expression in @\<HOLE\>@ is converted to a bit vector (@std_logic_vector@).
The @\<TYPE\>@ hole indicates the type of the expression and must be either
@~TYP[N]@, @~TYPO@, or @~TYPELEM[\<HOLE\>]@.
@~TYP[N]@, @~TYPO@, or @~TYPEL[\<HOLE\>]@.
* @~FROMBV[\<HOLE\>][\<TYPE\>]@: create conversion code that so that the
expression in @\<HOLE\>@, which has a bit vector (@std_logic_vector@) type,
is converted to type indicated by @\<TYPE\>@. The @\<TYPE\>@ hole must be
either @~TYP[N]@, @~TYPO@, or @~TYPELEM[\<HOLE\>]@.
either @~TYP[N]@, @~TYPO@, or @~TYPEL[\<HOLE\>]@.
* @~INCLUDENAME[N]@: the generated name of the @N@'th included component.
* @~FILEPATH[\<HOLE\>]@: The argument mentioned in @\<HOLE\>@ is a file which
must be copied to the location of the generated HDL.
Expand Down

0 comments on commit 845a233

Please sign in to comment.