Skip to content

update documentation for manifest #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

update documentation for manifest #210

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aff38cf
update documentation
omehrabi May 24, 2023
62e8d59
address comments
omehrabi May 25, 2023
749bc2f
Update docs/manifest/introduction.rst
ThomasJRyan Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/manifest/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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 job file is in a different location from the manifest you can use a symlink
to refer to the job.py file. 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please show symlink from the filesystem, e.g.

ls -l job.py
lrwxr-xr-x  1 admin  wheel  20 Nov 29 11:36 job.py -> /tmp/job/path/job.py

This job will be executed in the /tmp/job/path directory.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please show symlink from the filesystem, e.g.

ls -l job.py
lrwxr-xr-x  1 admin  wheel  20 Nov 29 11:36 job.py -> /tmp/job/path/job.py

This job will be executed in the /tmp/job/path directory.

@omehrabi
Did you see this note from a reviewer?

Script types
~~~~~~~~~~~~

Expand Down