On Sun, Oct 19, 2014 at 10:50:23PM -0700, Alex Wang wrote:
> This patch adds bash command-line completion script for ovs-appctl,
> ovs-dpctl, ovs-ofctl and ovsdb-tool command.  Right now, the script
> can do the following:
> 
> - display available completion or complete on unfinished user input
>   (long option, subcommand, and argument).
> 
> - once the subcommand (e.g. ofproto/trace) has been given, the
>   script will print the subcommand format.
> 
> - the script can convert between keywords like 'bridge/port/interface/dp'
>   and the available record in ovsdb.
> 
> The limitations are:
> 
> - only support small set of important keywords
>   (dp, datapath, bridge, switch, port, interface, iface).
> 
> - does not support parsing of nested options
>   (e.g. ovsdb-tool create [db [schema]]).
> 
> - does not support expansion on repeatitive argument
>   (e.g. ovs-dpctl show [dp...]).
> 
> - only support matching on long options, and only in the format
>   (--option [arg], i.e. should not use --option=[arg]).
> 
> To use the script, either copy it inside /etc/bash_completion.d/
> or manually run it via . ovs-command-compgen.bash.
> 
> Also, a unit testsuite is provided as ovs-command-compgen-test.bash.
> It is suggested that this test script be run only inside ovs-sandbox.
> 
> Signed-off-by: Alex Wang <[email protected]>

This should come with at least some minimal documentation somewhere
explaining how to install it, and it should be mentioned in NEWS.  I
think that the above list of features and limitations should be copied
into whatever documentation you write.

Acked-by: Ben Pfaff <[email protected]>
_______________________________________________
dev mailing list
[email protected]
http://openvswitch.org/mailman/listinfo/dev

Reply via email to