From e7ab7a61f15ea2f1005d4d8ed31341617222fcb3 Mon Sep 17 00:00:00 2001
From: tangxifan <tangxifan@gmail.com>
Date: Fri, 9 Aug 2024 18:09:12 -0700
Subject: [PATCH] [doc] update to use tile name and index when defining clock
 taps

---
 docs/source/manual/file_formats/clock_network.rst | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/docs/source/manual/file_formats/clock_network.rst b/docs/source/manual/file_formats/clock_network.rst
index fba5c3ef2..62e266347 100644
--- a/docs/source/manual/file_formats/clock_network.rst
+++ b/docs/source/manual/file_formats/clock_network.rst
@@ -308,20 +308,25 @@ For example,
   <clock_network name="clk_tree_0" global_port="clk[0:1]">
     <!-- Some clock spines -->
     <taps>
-      <all from_pin="clk[0:0]" to_pin="clb.clk[0:0]"/>
-      <region from_pin="clk[1:1]" to_pin="clb.clk[1:1]" start_x="1" start_y="1" end_x="4" end_y="4" repeat_x="2" repeat_y="2"/>
-      <single from_pin="clk[1:1]" to_pin="clb.clk[1:1]" x="2" y="2"/>
+      <all from_pin="clk[0:0]" to_pin="clb[0:0].clk[0:0]"/>
+      <region from_pin="clk[1:1]" to_pin="clb[1:1].clk[1:1]" start_x="1" start_y="1" end_x="4" end_y="4" repeat_x="2" repeat_y="2"/>
+      <single from_pin="clk[1:1]" to_pin="clb[2:2].clk[1:1]" x="2" y="2"/>
     </taps>
   </clock_network>
 
 where all the clock spines of the clock network ``clk_tree_0`` tap the clock pins ``clk`` of tile ``clb`` in a VPR architecture description file:
 
-.. note:: Use the name of ``subtile`` in the ``to_pin`` when there are a number of subtiles in your tile!
+.. note:: Use the name of ``tile`` in the ``to_pin`` when there are a number of subtiles in your tile! Use the absolute index for the subtile in the tile.
 
 .. code-block:: xml
 
   <tile name="clb">
-   <sub_tile name="clb">
+   <!-- subtile index ranges [0:0] -->
+   <sub_tile name="clbM" capacity="1">
+     <clock name="clk" num_pins="2"/>
+   </sub_tile>
+   <!-- subtile index ranges [1:2] -->
+   <sub_tile name="clbA" capacity="2">
      <clock name="clk" num_pins="2"/>
    </sub_tile>
   </tile>