Skip to content

Commit ab069fb

Browse files
committed
chipflow-toml-guide: Fix RST syntax for terms
Signed-off-by: gatecat <gatecat@ds0.me>
1 parent 66aaba8 commit ab069fb

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/chipflow-toml-guide.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ You probably won't need to change these if you're starting from an example repos
7878
default = 'sys_clk'
7979
8080
This section links the clock domains utilized in the design to specific pads.
81-
These pads need to be specified in the `[silicon.pads]`_ section with the :term:type set to :term:clock.
81+
These pads need to be specified in the `[silicon.pads]`_ section with the :term:`type` set to :term:`clock`.
8282
The ``default`` clock domain is associated with the Amaranth :any:`sync <lang-domains>` :ref:`clock domain <lang-clockdomains>`.
8383
Currently, only one ``default`` clock domain is supported.
8484

@@ -92,7 +92,7 @@ Currently, only one ``default`` clock domain is supported.
9292
default = 'sys_rst_n'
9393
9494
This section identifies the input pads designated for reset functionality.
95-
These pads need to be specified in the `[silicon.pads]`_ section with the :term:type set to :term:reset.
95+
These pads need to be specified in the `[silicon.pads]`_ section with the :term:`type` set to :term:`reset`.
9696
The logic that synchronizes the reset signal with the clock will be generated automatically.
9797

9898
``[chipflow.silicon]``
@@ -143,7 +143,7 @@ Available pad rings
143143
------------------
144144

145145
The ``silicon.pads`` section lists special pads. In general you are unlikely to need to add to this.
146-
Each pad specified with the name used by the design and two parameters: :term:type and :term:`loc`.
146+
Each pad specified with the name used by the design and two parameters: :term:`type` and :term:`loc`.
147147

148148
.. code-block:: TOML
149149
@@ -159,7 +159,7 @@ In the above example two pads specified, ``sys_clk`` pad for clock input and ``s
159159
This is the physical location of the pad on your chosen pad ring. How these are indexed varies by the pad ring.
160160

161161
type
162-
The :term:type for each pad can be set to one of :term:clock or :term:reset.
162+
The :term:`type` for each pad can be set to one of :term:`clock` or :term:`reset`.
163163

164164
clock
165165
External clock input.
@@ -172,8 +172,8 @@ In the above example two pads specified, ``sys_clk`` pad for clock input and ``s
172172
-------------------
173173

174174
This section outlines the connection of pads to the power supply available for the selected process and package.
175-
These pads are declared with the :term:type and :term:loc parameters, similar to the `[silicon.pads]`_ section.
176-
Note that in this context, the :term:type parameter can only be ``ground`` or ``power``.
175+
These pads are declared with the :term:`type` and :term:`loc` parameters, similar to the `[silicon.pads]`_ section.
176+
Note that in this context, the :term:`type` parameter can only be ``ground`` or ``power``.
177177

178178
This is a work in progress, and currently you can use the defaults provided by customer support.
179179

0 commit comments

Comments
 (0)