Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix the error caused by wrong format of newly added stage function description. #250

Merged
merged 2 commits into from
Mar 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions source/SpinalHDL/Libraries/flow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,10 @@ Functions
| through a register stage that cut valid/payload paths
- Flow[T]
- 1
-
* - x.stage()
- | Equivalent to x.m2sPipe()
|
- Equivalent to x.m2sPipe()
- Flow[T]
- 1
-
* - | x << y
| y >> x
- Connect y to x
Expand Down
152 changes: 141 additions & 11 deletions source/locale/gettext/SpinalHDL/Libraries/flow.pot
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: SpinalHDL \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2024-03-30 13:03+0000\n"
"POT-Creation-Date: 2024-03-30 15:02+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
Expand Down Expand Up @@ -41,6 +41,7 @@ msgid "Driver"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:18
#: ../../SpinalHDL/Libraries/flow.rst:40
msgid "Description"
msgstr ""

Expand Down Expand Up @@ -70,6 +71,7 @@ msgid "payload"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:26
#: ../../SpinalHDL/Libraries/flow.rst:78
msgid "T"
msgstr ""

Expand All @@ -85,42 +87,170 @@ msgstr ""
msgid "Functions"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:93
#: ../../SpinalHDL/Libraries/flow.rst:39
msgid "Syntax"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:41
msgid "Return"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:42
msgid "Latency"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:43
msgid "Flow(type : Data)"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:0
#: ../../SpinalHDL/Libraries/flow.rst:44
msgid "Create a Flow of a given type"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:45
#: ../../SpinalHDL/Libraries/flow.rst:50
#: ../../SpinalHDL/Libraries/flow.rst:55
#: ../../SpinalHDL/Libraries/flow.rst:59
#: ../../SpinalHDL/Libraries/flow.rst:74
msgid "Flow[T]"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:47
msgid "master/slave Flow(type : Data)"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:0
msgid "Initialized with corresponding in/out setup"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:52
msgid "x.m2sPipe()"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:0
msgid "Return a Flow drived by x"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:0
msgid "through a register stage that cut valid/payload paths"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:56
#: ../../SpinalHDL/Libraries/flow.rst:60
#: ../../SpinalHDL/Libraries/flow.rst:70
msgid "1"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:57
msgid "x.stage()"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:58
msgid "Equivalent to x.m2sPipe()"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:0
msgid "x << y"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:0
msgid "y >> x"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:63
msgid "Connect y to x"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:65
#: ../../SpinalHDL/Libraries/flow.rst:75
msgid "0"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:0
msgid "x <-< y"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:0
msgid "y >-> x"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:68
msgid "Connect y to x through a m2sPipe"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:71
msgid "x.throwWhen(cond : Bool)"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:0
msgid "Return a Flow connected to x"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:0
msgid "When cond is high, transaction are dropped"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:76
msgid "x.toReg()"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:77
msgid "Return a register which is loaded with ``payload`` when valid is high"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:80
msgid "x.setIdle()"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:81
msgid "Set the Flow in an Idle state: ``valid`` is ``False`` and don't care about ``payload``."
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:84
msgid "x.push(newPayload: T)"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:85
msgid "Assign a new valid payload to the Flow. ``valid`` is set to ``True``."
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:90
msgid "Code example"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:101
#: ../../SpinalHDL/Libraries/flow.rst:98
msgid "Simulation Support"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:107
#: ../../SpinalHDL/Libraries/flow.rst:104
msgid "Class"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:108
#: ../../SpinalHDL/Libraries/flow.rst:105
msgid "Usage"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:109
#: ../../SpinalHDL/Libraries/flow.rst:106
msgid "FlowMonitor"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:110
#: ../../SpinalHDL/Libraries/flow.rst:107
msgid "Used for both master and slave sides, calls function with payload if Flow transmits data."
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:111
#: ../../SpinalHDL/Libraries/flow.rst:108
msgid "FlowDriver"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:112
#: ../../SpinalHDL/Libraries/flow.rst:109
msgid "Testbench master side, drives values by calling function to apply value (if available). Function must return if value was available. Supports random delays."
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:113
#: ../../SpinalHDL/Libraries/flow.rst:110
msgid "ScoreboardInOrder"
msgstr ""

#: ../../SpinalHDL/Libraries/flow.rst:114
#: ../../SpinalHDL/Libraries/flow.rst:111
msgid "Often used to compare reference/dut data"
msgstr ""
Loading
Loading