From 65e38e5f91511bee6a4c7304fa8e4fa0c1e90479 Mon Sep 17 00:00:00 2001 From: Victor Date: Wed, 11 Sep 2024 19:27:03 +0800 Subject: [PATCH 1/4] update document format --- .../manual/file_formats/reference_file.rst | 159 ++++++++++++------ 1 file changed, 105 insertions(+), 54 deletions(-) diff --git a/docs/source/manual/file_formats/reference_file.rst b/docs/source/manual/file_formats/reference_file.rst index f2240df62..0f90a8a9f 100644 --- a/docs/source/manual/file_formats/reference_file.rst +++ b/docs/source/manual/file_formats/reference_file.rst @@ -17,60 +17,111 @@ An example of the file is shown as follows. Date: Mon Sep 9 16:41:53 2024 #the instance names are given during netlist generation -references: -- module: grid_io_top - count: 1 - instances: - - grid_io_top_1__2_ -- module: grid_io_right - count: 1 - instances: - - grid_io_right_2__1_ -- module: grid_io_bottom - count: 1 - instances: - - grid_io_bottom_1__0_ -- module: grid_io_left - count: 1 - instances: - - grid_io_left_0__1_ -- module: grid_clb - count: 1 - instances: - - grid_clb_1__1_ -- module: sb_0__0_ - count: 1 - instances: - - sb_0__0_ -- module: sb_0__1_ - count: 1 - instances: - - sb_0__1_ -- module: sb_1__0_ - count: 1 - instances: - - sb_1__0_ -- module: sb_1__1_ - count: 1 - instances: - - sb_1__1_ -- module: cbx_1__0_ - count: 1 - instances: - - cbx_1__0_ -- module: cbx_1__1_ - count: 1 - instances: - - cbx_1__1_ -- module: cby_0__1_ - count: 1 - instances: - - cby_0__1_ -- module: cby_1__1_ - count: 1 - instances: - - cby_1__1_ - direct_interc + + references: + - module: grid_io_top + + count: 1 + + instances: + + - grid_io_top_1__2_ + + - module: grid_io_right + + count: 1 + + instances: + + - grid_io_right_2__1_ + + - module: grid_io_bottom + + count: 1 + + instances: + + - grid_io_bottom_1__0_ + + - module: grid_io_left + + count: 1 + + instances: + + - grid_io_left_0__1_ + + - module: grid_clb + + count: 1 + + instances: + + - grid_clb_1__1_ + + - module: sb_0__0_ + + count: 1 + + instances: + + - sb_0__0_ + + - module: sb_0__1_ + + count: 1 + + instances: + + - sb_0__1_ + + - module: sb_1__0_ + + count: 1 + + instances: + + - sb_1__0_ + + - module: sb_1__1_ + + count: 1 + + instances: + + - sb_1__1_ + + - module: cbx_1__0_ + + count: 1 + + instances: + + - cbx_1__0_ + + - module: cbx_1__1_ + + count: 1 + + instances: + + - cbx_1__1_ + + - module: cby_0__1_ + + count: 1 + + instances: + + - cby_0__1_ + + - module: cby_1__1_ + + count: 1 + + instances: + + - cby_1__1_ In this example, the parent module is ``fpga_top``. The child modules under ``fpga_top`` are ``grid_io_top``, ``grid_io_right``, and etc. From 22da608e05876c60fa5ef0e8831732d1ac5f170e Mon Sep 17 00:00:00 2001 From: Victor Date: Thu, 12 Sep 2024 09:58:13 +0800 Subject: [PATCH 2/4] add ident --- docs/source/manual/file_formats/reference_file.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/manual/file_formats/reference_file.rst b/docs/source/manual/file_formats/reference_file.rst index 0f90a8a9f..cbf8db835 100644 --- a/docs/source/manual/file_formats/reference_file.rst +++ b/docs/source/manual/file_formats/reference_file.rst @@ -14,9 +14,9 @@ An example of the file is shown as follows. .. code-block:: yaml -Date: Mon Sep 9 16:41:53 2024 + Date: Mon Sep 9 16:41:53 2024 -#the instance names are given during netlist generation + #the instance names are given during netlist generation references: - module: grid_io_top From 7f88e97514d42457dce7cbe32eddf15bdd30d269 Mon Sep 17 00:00:00 2001 From: Victor Date: Thu, 12 Sep 2024 10:33:06 +0800 Subject: [PATCH 3/4] refine doc format --- .../manual/file_formats/reference_file.rst | 51 ------------------- 1 file changed, 51 deletions(-) diff --git a/docs/source/manual/file_formats/reference_file.rst b/docs/source/manual/file_formats/reference_file.rst index cbf8db835..1a57939a8 100644 --- a/docs/source/manual/file_formats/reference_file.rst +++ b/docs/source/manual/file_formats/reference_file.rst @@ -20,107 +20,56 @@ An example of the file is shown as follows. references: - module: grid_io_top - count: 1 - instances: - - grid_io_top_1__2_ - - module: grid_io_right - count: 1 - instances: - - grid_io_right_2__1_ - - module: grid_io_bottom - count: 1 - instances: - - grid_io_bottom_1__0_ - - module: grid_io_left - count: 1 - instances: - - grid_io_left_0__1_ - - module: grid_clb - count: 1 - instances: - - grid_clb_1__1_ - - module: sb_0__0_ - count: 1 - instances: - - sb_0__0_ - - module: sb_0__1_ - count: 1 - instances: - - sb_0__1_ - - module: sb_1__0_ - count: 1 - instances: - - sb_1__0_ - - module: sb_1__1_ - count: 1 - instances: - - sb_1__1_ - - module: cbx_1__0_ - count: 1 - instances: - - cbx_1__0_ - - module: cbx_1__1_ - count: 1 - instances: - - cbx_1__1_ - - module: cby_0__1_ - count: 1 - instances: - - cby_0__1_ - - module: cby_1__1_ - count: 1 - instances: - - cby_1__1_ In this example, the parent module is ``fpga_top``. From e5b3f5d90c9b36e31017552a3d7d19abd06d59c6 Mon Sep 17 00:00:00 2001 From: Victor Date: Thu, 12 Sep 2024 12:48:00 +0800 Subject: [PATCH 4/4] add link to file format description page --- .../openfpga_shell/openfpga_commands/setup_commands.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 b2e10d1b6..2c0cde183 100644 --- a/docs/source/manual/openfpga_shell/openfpga_commands/setup_commands.rst +++ b/docs/source/manual/openfpga_shell/openfpga_commands/setup_commands.rst @@ -535,7 +535,7 @@ report_reference .. option:: --file or -f - Specify the file name to write the reference information + Specify the file name to write the reference information. See details in :ref:`file_format_reference_file`. .. option:: --module @@ -547,4 +547,4 @@ report_reference .. option:: --verbose - Show verbose info \ No newline at end of file + Show verbose info