Skip to content

Commit e258a99

Browse files
committed
[Doc]: updating the documentation corresponding to include feature
Signed-off-by: Seyed Alireza Damghani <[email protected]>
1 parent f01f7a9 commit e258a99

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

doc/src/vtr/tasks.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,20 @@ Optional Fields
140140

141141
For instance with ``circuit_list_add=my_circuit.v`` or ``circuit_list_add=my_circuit.blif``, the flow would look for an SDC file named ``my_circuit.sdc`` within the specified ``sdc_dir``.
142142

143+
* **includes_dir**: Directory path to benchmark _include_ files
144+
145+
Absolute path or relative to ``$VTR_ROOT/vtr_flow/``.
146+
147+
Note: Multiple _includes_dir_ are NOT allowed in a task config file.
148+
149+
* **include_list_add**: A path to an _include_ file, which is relative to _includes_dir_
150+
151+
Multiple _include_list_add_ can be provided.
152+
153+
_include_ files could act as the top module complementary, like definitions, macros or sub-modules.
154+
155+
Note: _include_ files will be shared among all benchmark circuits in the task config file.
156+
143157
* **pass_requirements_file**: :ref:`vtr_pass_requirements` file.
144158

145159
Absolute path or relative to ``$VTR_ROOT/vtr_flow/parse/pass_requirements/`` or ``$VTR_ROOT/vtr_flow/tasks/<task_name>/config/``

0 commit comments

Comments
 (0)