Skip to content

Commit

Permalink
WIP docs/glossary: update
Browse files Browse the repository at this point in the history
Signed-off-by: Unai Martinez-Corral <[email protected]>
  • Loading branch information
umarcor committed Mar 29, 2022
1 parent e19accb commit 5c1503c
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ Glossary
Within :term:`f4pga <F4PGA>`, user-defined *modules* allow extending the built-in :term:`flows <Flow>` and
:term:`steps <Step>` to achieve custom and/or complex tasks.

.. NOTE::
:ghsharp:`#533 <533#issuecomment-1076964582>`

Dependency
A *dependency* is a prerequisite to execute a :term:`f4pga <F4PGA>` :term:`step <Step>` in a :term:`flow <Flow>`.
*Dependencies* might be files (such as HDL sources, constraints, etc.), :term:`artifacts <Artifact>` from previous
Expand All @@ -75,6 +78,9 @@ Glossary
shared previous *steps*.
The *target* of a *flow* specifies which *steps* to execute in a run.

.. NOTE::
:ghsharp:`#533 <533#issuecomment-1076964582>`

F4PGA

* *Uppercase*:
Expand Down Expand Up @@ -106,6 +112,9 @@ Glossary
are to be executed and which :term:`dependencies <Dependency>` and :term:`artifacts <Artifact>` are to be passed
along.

.. NOTE::
:ghsharp:`#533 <533#issuecomment-1076964582>`

Constraints
Set of parameters that allow users to select/specify certain physical characteristics of the FPGA device, such as
the pins/pads or the logic standard to use.
Expand Down Expand Up @@ -133,3 +142,12 @@ Glossary
Toolchain
:wikipedia:`Toolchain ➚ <Toolchain>` is a generic term used to refer to a set of programming tools used
consecutively to perform a complex software development task.

Frontend
*TBC*

Backend
*TBC*

Description
*TBC*

0 comments on commit 5c1503c

Please sign in to comment.