From aff38cf7d2b01d390866778bdfa656c5023f2de7 Mon Sep 17 00:00:00 2001 From: omid Date: Wed, 24 May 2023 14:07:43 -0400 Subject: [PATCH 1/3] update documentation --- docs/manifest/introduction.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/manifest/introduction.rst b/docs/manifest/introduction.rst index 053070c..9aa2f68 100644 --- a/docs/manifest/introduction.rst +++ b/docs/manifest/introduction.rst @@ -38,8 +38,15 @@ and runtime specific settings. manifest filename with the extension `.py`. E.g. the script filename for a manifest with filename of ``job.tem`` is ``job.py`` in the same directory as the manifest file. +.. note:: + In case the associated script file is in a different location from the manifest you could use a symlink + to refering the script. To change the default behavior for using the symlink and change where to execute + the script you need to pass --follow-symlink. +.. code-block:: shell + $ pyats run manifest job.tem --follow-symlink + $ job.py # is a symlink for the associated script Script types ~~~~~~~~~~~~ From 62e8d594e4f5612aaa9b320ae384179216c137e2 Mon Sep 17 00:00:00 2001 From: omid Date: Thu, 25 May 2023 16:48:31 -0400 Subject: [PATCH 2/3] address comments --- docs/manifest/introduction.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/manifest/introduction.rst b/docs/manifest/introduction.rst index 9aa2f68..f61b6d8 100644 --- a/docs/manifest/introduction.rst +++ b/docs/manifest/introduction.rst @@ -39,13 +39,15 @@ and runtime specific settings. with filename of ``job.tem`` is ``job.py`` in the same directory as the manifest file. .. note:: - In case the associated script file is in a different location from the manifest you could use a symlink - to refering the script. To change the default behavior for using the symlink and change where to execute - the script you need to pass --follow-symlink. + In case the associated script file is in a different location from the manifest you can use a symlink + to refer to the job.py. By default, the job will be executed in the directory where the manifest file is located. + To change the execution directory and use the symlink target directory to execute the script you need + to pass --follow-symlink. .. code-block:: shell $ pyats run manifest job.tem --follow-symlink + $ job.py # is a symlink for the associated script Script types ~~~~~~~~~~~~ From 749bc2f65c5cf745606c19472f09e2af97fd8f52 Mon Sep 17 00:00:00 2001 From: Thomas Ryan Date: Tue, 28 Nov 2023 14:06:23 -0500 Subject: [PATCH 3/3] Update docs/manifest/introduction.rst --- docs/manifest/introduction.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/manifest/introduction.rst b/docs/manifest/introduction.rst index f61b6d8..9c4bbd5 100644 --- a/docs/manifest/introduction.rst +++ b/docs/manifest/introduction.rst @@ -49,6 +49,7 @@ and runtime specific settings. $ pyats run manifest job.tem --follow-symlink $ job.py # is a symlink for the associated script + Script types ~~~~~~~~~~~~