Skip to content

Commit e32a324

Browse files
authored
update to docs for new SCR Route file behavior
as of v1.2.2, if route file is called outside of a start/complete pair the original file path is returned.
1 parent b2d557f commit e32a324

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/rst/users/api.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,10 @@ A process does not need to create any directories listed in the string returned
164164
The SCR implementation creates any necessary directories before returning from the call.
165165
A call to :code:`SCR_Route_file` is local to the calling process; it is not a collective call.
166166

167-
:code:`SCR_Route_file` can only be called within a Start/Complete pair
167+
As of version 1.2.2, :code:`SCR_Route_file` can be succesfully called at any point during application execution.
168+
If it is called outside of a Start/Complete pair, the original file path is simply copied to the return string.
169+
170+
:code:`SCR_Route_file` has special behaviour when called within a Start/Complete pair
168171
for restart, checkpoint, or output.
169172
Within a restart operation, the input parameter :code:`name` only requires a file name.
170173
No path component is needed.

0 commit comments

Comments
 (0)