ibek command line namespaces #106
Comments
|
Firstly, we could ditch the subcommands and group only in the help: |
|
Although maybe the namespacing is nice... |
|
Well we need longer names for the individual functions if we don't namespace methinks. |
|
Suggestion: |
|
This is what we have so far: |
|
If we want to maintain order, would this work? |
|
Apart from the order I think the names are right |
|
Neat. I think for the support subcommands especially having them in the order they should be run would be really useful. |
|
Will try to achieve the order. In the mean time. The install.sh scripts came out pretty (and are working - with a few caveats) #!/bin/bash
##########################################################################
##### boilerplate install script for support modules #####################
##########################################################################
# ARGUMENTS:
# $1 VERSION to install (must match repo tag)
VERSION=${1}
# get the name of this folder, i.e. the name of the support module
NAME=$(basename $(dirname ${0}))
ibek support git-clone ${NAME} ${VERSION}
ibek support register ${NAME}
ibek support add-libs ${NAME} devIocStats
ibek support add-dbds ${NAME} devIocStats.dbd
##########################################################################
##### put patch commands here if needed ##################################
##########################################################################
ibek support compile ${NAME}
ibek support generate-links ${NAME} |
|
I think we have this in good shape now. Here are the commands and they now appear in the typical order of usage: |
gilesknap
added a commit
that referenced
this issue
Sep 22, 2023
changes to add new support functions as per #106
|
Done in #107 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We have decided to bring into ibek the set of commands for building support modules at container build time, these currently reside in
https://github.com/epics-containers/ibek-support/blob/ibek-j20-changes/_global/support.py
To do so we need to intelligently namespace the command line interface to avoid confusion.
Here is a proposed hierarchy for criticism @coretl @GDYendell :-
One of the problems I see with this is that in some cases we have just written python code to wrap calling back out bash. This is certainly the case for the compile functions. I can use GitPython for the clone - but to what advantage - it might just get in the way when you need to do something obscure with git. Having said this - whenever such issues arise we can just directly call the command from install.sh and eschew ibek. Then we see ibek as something with some legible help that guides you to the most common actions.
The text was updated successfully, but these errors were encountered: