Skip to content

Commit

Permalink
[doc] add links
Browse files Browse the repository at this point in the history
  • Loading branch information
tangxifan committed Aug 27, 2023
1 parent f53e05f commit 3bc5c3b
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/source/manual/utilities/fabric_key_assistant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@
Fabric Key Assistant
--------------------

Fabric Key Assistant is a tool to help users to craft fabric key files.
Fabric Key Assistant is a tool to help users to craft fabric key files (see details in :ref:`file_formats_fabric_key`).
Note that crafting a fabric key is not an easy task for engineers, as its complexity grows exponentially with FPGA sizes.
This tool is developed to assist engineers when finalizing fabric key files.
It can apply sanity checks on hand-crafted fabric key files, helping engineers to correct and debug.

The tool can be found at ``/build/libs/libfabrickey/test/fabric_key_assistant``

The tool includes the following options:

.. option:: --reference <string>
Expand All @@ -29,13 +32,13 @@ The tool includes the following options:
<key id="1" name="tile_0__0_" value="5" alias="tile_4__2_"/>
while the input fabric key includes a key:
while the input fabric key includes a key:

.. code-block:: xml
<key id="23" alias="tile_4__2_"/>
the resulting output fabric key file includes a key:
the resulting output fabric key file includes a key:

.. code-block:: xml
Expand Down

0 comments on commit 3bc5c3b

Please sign in to comment.