aboutsummaryrefslogtreecommitdiffstats
path: root/docs/apidocs/index.rst
blob: 8bd407341f9871b7866a46c53ff55f930ff8a4de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
.. This work is licensed under a Creative Commons Attribution 4.0 International
.. License.
.. http://creativecommons.org/licenses/by/4.0

======================================
Yardstick Framework Code Documentation
======================================

.. toctree::
   :maxdepth: 3

   modules
derived from the git bash completion script ___main () { local cur prev opts COMPREPLY=() cur="${COMP_WORDS[COMP_CWORD]}" prev="${COMP_WORDS[COMP_CWORD-1]}" opts=" -h $(${COMP_WORDS[0]} -h | grep -Eo '^ [^ ]+')" if [[ ! $opts =~ $prev ]]; then COMPREPLY=($(compgen -W "${opts}" -- ${cur})) fi } # these functions are setup like this in the thought that # deploy and util will eventually diverge from each other # for now they can use the same main logic so it's just # abstracted to another function __deploy_main () { ___main } __util_main () { ___main } __apex_func_wrap () { local cur words cword prev _get_comp_words_by_ref -n =: cur words cword prev $1 } # Setup function for bash completion __apex_complete () { local wrapper="__apex_wrap${2}" eval "$wrapper () { __apex_func_wrap $2 ; }" complete -o bashdefault -o default -o nospace -F $wrapper $1 2>/dev/null \ || complete -o default -o nospace -F $wrapper $1 } # run completion setup __apex_complete ./deploy.sh __deploy_main __apex_complete opnfv-deploy __deploy_main __apex_complete ./util.sh __util_main __apex_complete opnfv-util __util_main