diff --git a/docs/source/manual/utilities/fabric_key_assistant.rst b/docs/source/manual/utilities/fabric_key_assistant.rst index 9bd525b91..4625366d2 100644 --- a/docs/source/manual/utilities/fabric_key_assistant.rst +++ b/docs/source/manual/utilities/fabric_key_assistant.rst @@ -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 @@ -29,13 +32,13 @@ The tool includes the following options: - while the input fabric key includes a key: +while the input fabric key includes a key: .. code-block:: xml - the resulting output fabric key file includes a key: +the resulting output fabric key file includes a key: .. code-block:: xml