Skip to content

Commit

Permalink
DOC: update script docstring and help text to include an example.
Browse files Browse the repository at this point in the history
  • Loading branch information
ZLLentz committed Jul 17, 2024
1 parent 37f8f89 commit 4bcdc8c
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions scripts/ioc_deploy.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@
"""
ioc-deploy is a script for building and deploying ioc tags from github.
It will create a shallow clone of your IOC in the standard release area at the correct path and "make" it.
If the tag directory already exists, the script will exit.
Example command:
"ioc-deploy -n ioc-foo-bar -r R1.0.0"
This will clone the repository to the default ioc directory and run make
using the currently set EPICS environment variables.
With default settings this will clone
from https://github.com/pcdshub/ioc-foo-bar
to /cds/group/pcds/epics/ioc/foo/bar/R1.0.0
then cd and make.
"""

import argparse
Expand Down

0 comments on commit 4bcdc8c

Please sign in to comment.