From 423e15289c94569649569c0a3847128882b21f18 Mon Sep 17 00:00:00 2001 From: Lin Date: Thu, 12 Sep 2024 13:47:10 +0800 Subject: [PATCH] add link to command doc, valid now --- docs/source/manual/file_formats/unique_blocks.rst | 2 +- .../openfpga_commands/setup_commands.rst | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/manual/file_formats/unique_blocks.rst b/docs/source/manual/file_formats/unique_blocks.rst index 9a9e86c1d..ace724cc4 100644 --- a/docs/source/manual/file_formats/unique_blocks.rst +++ b/docs/source/manual/file_formats/unique_blocks.rst @@ -1,7 +1,7 @@ .. _file_formats_unique_blocks: Unique Blocks (.xml) -~~~~~~~~~~~~~~~~~~~~ +-------------------- A unique blocks file is formatted in XML. The unique blocks can be of type ``cbx``, ``cby``, or ``sb``. As illustrated by the XML code below, the file includes the type and coordinates of these unique blocks, as well as the coordinates of their corresponding instances. diff --git a/docs/source/manual/openfpga_shell/openfpga_commands/setup_commands.rst b/docs/source/manual/openfpga_shell/openfpga_commands/setup_commands.rst index 3738c78b0..103e245ab 100644 --- a/docs/source/manual/openfpga_shell/openfpga_commands/setup_commands.rst +++ b/docs/source/manual/openfpga_shell/openfpga_commands/setup_commands.rst @@ -554,15 +554,15 @@ report_reference read_unique_blocks ~~~~~~~~~~~~~~~~~~~~ - Read information of unique blocks from a given file + Read information of unique blocks from a given file. .. option:: --file - Specify the file which contains unique block information. See details in :ref:`_file_formats_unique_blocks` + Specify the file which contains unique block information. See details in :ref:`file_formats_unique_blocks`. .. option:: --type - Specify the type of the unique blocks file [xml|bin]. If not specified, by default it is XML + Specify the type of the unique blocks file [xml|bin]. If not specified, by default it is XML. .. option:: --verbose @@ -573,15 +573,15 @@ read_unique_blocks write_unique_blocks ~~~~~~~~~~~~~~~~~~~~~ - Write information of unique blocks from internal data structure to a given file + Write information of unique blocks from internal data structure to a given file. .. option:: --file - Specify the file which we will write unique block information to. See details in :ref:`_file_formats_unique_blocks` + Specify the file which we will write unique block information to. See details in :ref:`file_formats_unique_blocks`. .. option:: --type - Specify the type of the unique blocks file [xml|bin]. If not specified, by default it is XML + Specify the type of the unique blocks file [xml|bin]. If not specified, by default it is XML. .. option:: --verbose