Skip to content

Commit f506758

Browse files
committed
Adding info about restrictions on the order of functions
1 parent 49bcbc8 commit f506758

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

documentation/source/developer_guide/psyclone/psyclone_functions.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,8 @@ Using the ``profile_loops`` function allows the user to wrap the outermost loop
2626
def trans(psyir):
2727
profile_loops(psyir,colours_only=False)
2828
29+
30+
An important thing to note when including this function in an optimisation script is its position relative to other transformation functions.
31+
The ``profile_loops`` function must come after the ``colour_loops`` function but before the ``openmp_parallelise_loops`` function.
32+
This ensures that the callipers are injected into the correct position in the Psyclone generated code.
33+
The build step will fail gracefully if this function is used out of order.

0 commit comments

Comments
 (0)