Feature #104

OEDL - Extend 'defProperty' in 'defApplication'

Added by Thierry Rakotoarivelo over 1 year ago. Updated about 1 year ago.

Status:New Start:25/05/2009
Priority:Normal Due date:
Assigned to:- % Done:

0%

Category:OMF Software
Target version:Trunk

Description

Component: OEDL (NH)

Problem:

In the current OEDL version, the defProperty sub-command which is used inside a defApplication only allows for definition of parameter name on the command-line which are prefixed by "--" or "-" (e.g. "--help" or "-h"). Note that it also allows for no parameter names at all

However, some existing applications, such as 'tc' (the Linux Traffic Shaping command), have parameter names on the command line which are not prefixed by any dash(es).

We need to extend this defProperty to allow this. For example, by adding a new 'option' in its hash parameter, such as "use_dash" which will be true by default.

The current signature of defProperty is:

15 # defProperty has the following signature:
16 # defProperty ( name, description, mnemonic, options )
17 # - 'name' is interpreted as the long parameter for the command (For example, "--help")
18 # - 'mnemonic' is the short parameter call (for example, ?h will result in "-h")
19 # - 'options' is a Hash of options for this parameter:
20 # :type => <type>
21 # is the parameter types, any of ':string' or ':integer'
22 # or ':boolean' or 'nil'
23 # :dynamic => true | false
24 # true property can be changed at run-time
25 # :use_name => true | false
26 # if false then print only the parameter value and do
27 # not print either 'name' or 'mnemonic' when calling the command
28 # :order => integer
29 # Order the property according to integer when calling the command
30
31 # This is the ping destination. It is a string and its value is not prefixed by any
32 # "--options" or "-X", thus we set ':use_name' to false
33 #

History

Updated by Christoph Dwertmann about 1 year ago

  • Target version changed from OMF 5.1 to Trunk

Also available in: Atom PDF