pcdshub / pcdshub/shared-dotfiles

Use compgen to list scripts in the environment + manually describe them

Open
#18 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
3
Forks
15
Avg merge
7d 10h
Merged PRs (30d)
1

Description

In order to auto-generate parts of https://github.com/pcdshub/shared-dotfiles/blob/master/helpme.md for listing where scripts are coming from, we could use the trial env and compgen to list all executables in $PATH.

Current list might show something like this for things on disk:

BLmotors (/reg/g/pcds/engineering_tools/latest-released/scripts/BLmotors)
CWget (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/CWget)
CWput (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/CWput)
ChannelWatcher (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/ChannelWatcher)
S99caRepeater (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/S99caRepeater)
S99logServer (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/S99logServer)
StripTool (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/StripTool)
VisualDCT.jar (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/VisualDCT.jar)
acctst (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/acctst)
add_psdatmgr_public_key.sh (/reg/common/tools/bin/add_psdatmgr_public_key.sh)
addlabuser (/reg/common/tools/bin/addlabuser)
addpowerstrip (/reg/common/tools/bin/addpowerstrip)
addpowerstrip.121010 (/reg/common/tools/bin/addpowerstrip.121010)
addpowerstrip_leviton (/reg/common/tools/bin/addpowerstrip_leviton)
addtermsrv (/reg/common/tools/bin/addtermsrv)
addxu (/reg/common/tools/bin/addxu)
alh (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/alh)
alh_DB (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/alh_DB)
alh_printer (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/alh_printer)
ami_offline_psana (/reg/g/pcds/engineering_tools/latest-released/scripts/ami_offline_psana)
antelope (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/antelope)
archive-status (/reg/g/pcds/engineering_tools/latest-released/scripts/archive-status)
ascheck (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/ascheck)
assembleSnippets.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/assembleSnippets.pl)
bldEnvData.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/bldEnvData.pl)
caCamcom (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/caCamcom)
caConnTest (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/caConnTest)
caEventRate (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/caEventRate)
caRepeater (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/caRepeater)
caRepeater.service (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/caRepeater.service)
caSnooper (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/caSnooper)
ca_test (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/ca_test)
caget (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/caget)
cainfo (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/cainfo)
camViewer (/reg/g/pcds/engineering_tools/latest-released/scripts/camViewer)
camonitor (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/camonitor)
capr.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/capr.pl)
caput (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/caput)
casw (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/casw)
catime (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/catime)
check_consist (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/check_consist)
checkcnf (/reg/g/pcds/engineering_tools/latest-released/scripts/checkcnf)
configdb_readxtc (/reg/g/pcds/engineering_tools/latest-released/scripts/configdb_readxtc)
console (/reg/common/tools/bin/console)
convertRelease.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/convertRelease.pl)
cron-ldap.sh (/reg/common/tools/bin/cron-ldap.sh)
cvsclean.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/cvsclean.pl)
daq_control (/reg/g/pcds/engineering_tools/latest-released/scripts/daq_control)
daq_waitwin (/reg/g/pcds/engineering_tools/latest-released/scripts/daq_waitwin)
dbExpand.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/dbExpand.pl)
dbdExpand.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/dbdExpand.pl)
dbdToHtml.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/dbdToHtml.pl)
dbdToMenuH.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/dbdToMenuH.pl)
dbdToRecordtypeH.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/dbdToRecordtypeH.pl)
delpowerstrip (/reg/common/tools/bin/delpowerstrip)
deltermsrv (/reg/common/tools/bin/deltermsrv)
depclean.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/depclean.pl)
devTEST (/reg/common/tools/bin/devTEST)
dev_conda (/reg/g/pcds/engineering_tools/latest-released/scripts/dev_conda)
digiconfig (/reg/common/tools/bin/digiconfig)
digiconfigure (/reg/common/tools/bin/digiconfigure)
dos2unix.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/dos2unix.pl)
e_flex (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/e_flex)
eco (/reg/common/tools/bin/eco)
edm (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/edm)
elog_par_post (/reg/g/pcds/engineering_tools/latest-released/scripts/elog_par_post)
eloggrabber (/reg/g/pcds/engineering_tools/latest-released/scripts/eloggrabber)
epics-build (/reg/common/tools/bin/epics-build)
epics-checkout (/reg/common/tools/bin/epics-checkout)
epics-release (/reg/common/tools/bin/epics-release)
epics-update (/reg/common/tools/bin/epics-update)
epics-versions (/reg/common/tools/bin/epics-versions)
epicsArchChecker (/reg/g/pcds/engineering_tools/latest-released/scripts/epicsArchChecker)
epicsMakeMemFs.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/epicsMakeMemFs.pl)
epix_gains (/reg/g/pcds/engineering_tools/latest-released/scripts/epix_gains)
evrStatus (/reg/g/pcds/engineering_tools/latest-released/scripts/evrStatus)
expandVars.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/expandVars.pl)
ezcaVarArrayTest (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/ezcaVarArrayTest)
firefox-tmp-profile.sh (/reg/common/tools/bin/firefox-tmp-profile.sh)
flatdb (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/flatdb)
fullPathName.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/fullPathName.pl)
fwdCliS (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/fwdCliS)
gateway (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/gateway)
genVersionHeader.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/genVersionHeader.pl)
get_curr_exp (/reg/g/pcds/engineering_tools/latest-released/scripts/get_curr_exp)
get_hutch_name (/reg/g/pcds/engineering_tools/latest-released/scripts/get_hutch_name)
get_info (/reg/g/pcds/engineering_tools/latest-released/scripts/get_info)
get_lastRun (/reg/g/pcds/engineering_tools/latest-released/scripts/get_lastRun)
gige (/reg/g/pcds/engineering_tools/latest-released/scripts/gige)
git-archive-all (/usr/local/bin/git-archive-all)
git-bare-repo (/reg/common/tools/bin/git-bare-repo)
git-branch-status (/reg/common/tools/bin/git-branch-status)
git-clone-github (/reg/common/tools/bin/git-clone-github)
gnome-settings.sh (/reg/common/tools/bin/gnome-settings.sh)
grep_ioc (/reg/g/pcds/engineering_tools/latest-released/scripts/grep_ioc)
grep_pv (/reg/g/pcds/engineering_tools/latest-released/scripts/grep_pv)
imgr (/reg/g/pcds/engineering_tools/latest-released/scripts/imgr)
installEpics.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/installEpics.pl)
installLinks (/reg/common/tools/bin/installLinks)
iocLogServer (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/iocLogServer)
iocmanager (/reg/g/pcds/engineering_tools/latest-released/scripts/iocmanager)
ioctool (/reg/g/pcds/engineering_tools/latest-released/scripts/ioctool)
ipmConfigEpics (/reg/g/pcds/engineering_tools/latest-released/scripts/ipmConfigEpics)
makeBaseApp.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/makeBaseApp.pl)
makeBaseExt.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/makeBaseExt.pl)
makeBpt (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/makeBpt)
makeIncludeDbd.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/makeIncludeDbd.pl)
makeMakefile.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/makeMakefile.pl)
makeTestfile.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/makeTestfile.pl)
makepeds (/reg/g/pcds/engineering_tools/latest-released/scripts/makepeds)
makepeds_psana (/reg/g/pcds/engineering_tools/latest-released/scripts/makepeds_psana)
mapUSBSerial.sh (/reg/common/tools/bin/mapUSBSerial.sh)
mapUSBbySN.sh (/reg/common/tools/bin/mapUSBbySN.sh)
mapUSBbySN.sh~ (/reg/common/tools/bin/mapUSBbySN.sh~)
mkmf.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/mkmf.pl)
motor-expert-screen (/reg/g/pcds/engineering_tools/latest-released/scripts/motor-expert-screen)
motor-typhos (/reg/g/pcds/engineering_tools/latest-released/scripts/motor-typhos)
motorInfo (/reg/g/pcds/engineering_tools/latest-released/scripts/motorInfo)
mount.wekaautofs (/reg/common/tools/bin/mount.wekaautofs)
msi (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/msi)
munch.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/munch.pl)
netconfig (/reg/common/tools/bin/netconfig)
nis2ldap (/reg/common/tools/bin/nis2ldap)
no-hot-corners.sh (/reg/common/tools/bin/no-hot-corners.sh)
nvidia.sh (/reg/common/tools/bin/nvidia.sh)
p2p (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/p2p)
parsecasw (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/parsecasw)
pcds_conda (/reg/g/pcds/engineering_tools/latest-released/scripts/pcds_conda)
pingHUTCH (/reg/common/tools/bin/pingHUTCH)
pkg_release (/reg/g/pcds/engineering_tools/latest-released/scripts/pkg_release)
pmgr (/reg/g/pcds/engineering_tools/latest-released/scripts/pmgr)
podRemove.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/podRemove.pl)
podToHtml.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/podToHtml.pl)
power (/reg/common/tools/bin/power)
probe (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/probe)
processRequestFile (/reg/common/tools/bin/processRequestFile)
propagate (/reg/common/tools/bin/propagate)
psipmi (/reg/common/tools/bin/psipmi)
pvcall (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/pvcall)
pvget (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/pvget)
pvinfo (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/pvinfo)
pvlist (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/pvlist)
pvmonitor (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/pvmonitor)
pvput (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/pvput)
pydev_env (/reg/g/pcds/engineering_tools/latest-released/scripts/pydev_env)
pydev_register (/reg/g/pcds/engineering_tools/latest-released/scripts/pydev_register)
pyps-deploy (/reg/g/pcds/engineering_tools/latest-released/scripts/pyps-deploy)
questionnaire_tools (/reg/g/pcds/engineering_tools/latest-released/scripts/questionnaire_tools)
registerRecordDeviceDriver.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/registerRecordDeviceDriver.pl)
replaceVAR.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/replaceVAR.pl)
restartdaq (/reg/g/pcds/engineering_tools/latest-released/scripts/restartdaq)
run-backup.sh (/reg/common/tools/bin/run-backup.sh)
serverStat (/reg/g/pcds/engineering_tools/latest-released/scripts/serverStat)
showcam (/reg/common/tools/bin/showcam)
softIoc (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/softIoc)
softIocPVA (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/softIocPVA)
startami (/reg/g/pcds/engineering_tools/latest-released/scripts/startami)
stopami (/reg/g/pcds/engineering_tools/latest-released/scripts/stopami)
stopdaq (/reg/g/pcds/engineering_tools/latest-released/scripts/stopdaq)
svn-vdiffwrap.sh (/reg/common/tools/bin/svn-vdiffwrap.sh)
svnIocToGit (/reg/common/tools/bin/svnIocToGit)
svnModuleToGit (/reg/common/tools/bin/svnModuleToGit)
takepeds (/reg/g/pcds/engineering_tools/latest-released/scripts/takepeds)
tap-to-junit-xml.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/tap-to-junit-xml.pl)
updatenetconfig (/reg/common/tools/bin/updatenetconfig)
useManifestTool.pl (/reg/g/pcds/epics/base/R7.0.2-2.0/bin/rhel7-x86_64/useManifestTool.pl)
vdct (/reg/g/pcds/epics/extensions/R0.2.0/bin/rhel7-x86_64/vdct)
ver (/reg/common/tools/bin/ver)
verifyUpToDate (/reg/common/tools/bin/verifyUpToDate)
wheredaq (/reg/g/pcds/engineering_tools/latest-released/scripts/wheredaq)
wherepsana (/reg/g/pcds/engineering_tools/latest-released/scripts/wherepsana)
xps-reposition.py (/reg/common/tools/bin/xps-reposition.py)

There are other aliases and things, too, that we might want to whitelist.

Have a mapping of {executable: description} to make generating the table a bit easier.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with helpme.md and the trial environment described in the issue. Run compgen to inspect executables in $PATH and compare the output with the existing script list. Done means the relevant list is generated and the scripts are manually described in helpme.md.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.