From 4bcdc8c70bc38e152f6520f847446a649cc6009c Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Wed, 17 Jul 2024 16:33:55 -0700 Subject: [PATCH] DOC: update script docstring and help text to include an example. --- scripts/ioc_deploy.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/scripts/ioc_deploy.py b/scripts/ioc_deploy.py index 78b4a34c..fc7d9c13 100755 --- a/scripts/ioc_deploy.py +++ b/scripts/ioc_deploy.py @@ -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