Skip to content

Commit

Permalink
optencod utility reverse :usagechain. tag arguments
Browse files Browse the repository at this point in the history 
update optencod utility documentation
  • Loading branch information
@jmalak
jmalak committed Jan 31, 2024
1 parent 08887ea commit 89f635f
Show file tree
Hide file tree
Showing 26 changed files with 1,399 additions and 1,147 deletions.
96 changes: 52 additions & 44 deletions bld/as/h/options.gml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,51 +37,58 @@
:cmt.
:cmt. GML Macros used:
:cmt.
:cmt. :chain. <option> <option> ... options that start with <option>
:cmt. can be chained together i.e.,
:cmt. -oa -ox -ot => -oaxt
:cmt. :target. <targ1> <targ2> ... valid for these targets (default is 'any')
:cmt. :ntarget. <targ1> <targ2> ... not valid for these targets
:cmt. :usagechain. <option> <usage text> group of options that start with <option>
:cmt. are chained together in usage text
:cmt. :usagegroup. <num> <usage text> group of options that have group <num>
:cmt. are chained together in usage text
:cmt. :title. <text> English title usage text
:cmt. :jtitle. <text> Japanese title usage text
:cmt. :titleu. <text> English title usage text for QNX resource file
:cmt. :jtitleu. <text> Japanese title usage text for QNX resource file
:cmt. :chain. <option> <option> ... options that start with <option>
:cmt. can be chained together i.e.,
:cmt. -oa -ox -ot => -oaxt
:cmt. :option. <option> <synonym> ... define an option
:cmt. :title. <text> English title usage text
:cmt. :jtitle. <text> Japanese title usage text
:cmt. :titleu. <text> English title usage text for QNX resource file
:cmt. :jtitleu. <text> Japanese title usage text for QNX resource file
:cmt. :usagegroup. <group_id> define group of options that have group
:cmt. <group_id> are grouped together in
:cmt. usage text
:cmt. :usagechain. <group_id> <option>
:cmt. group of options that start with <option>
:cmt. are chained together in usage text for
:cmt. defined group <group_id>
:cmt.
:cmt. :option. <option> <synonym> ... define an option
:cmt. :immediate. <fn> [<usage argid>] <fn> is called when option parsed
:cmt. :code. <source-code> <source-code> is executed when option parsed
:cmt. :enumerate. <name> [<option>] option is one value in <name> enumeration
:cmt. :number. [<fn>] [<default>] [<usage argid>] =<num> allowed; call <fn> to check
:cmt. :id. [<fn>] [<usage argid>] =<id> req'd; call <fn> to check
:cmt. :char. [<fn>] [<usage argid>] =<char> req'd; call <fn> to check
:cmt. :file. [<usage argid>] =<file> req'd
:cmt. :path. [<usage argid>] =<path> req'd
:cmt. :special. <fn> [<usage argid>] call <fn> to parse option
:cmt. :usage. <text> English usage text
:cmt. :jusage. <text> Japanese usage text
:cmt. :target. <targ1> <targ2> ... valid for these targets (default is 'any')
:cmt. :ntarget. <targ1> <targ2> ... not valid for these targets
:cmt. :immediate. <fn> [<usage argid>]
:cmt. <fn> is called when option parsed
:cmt. :code. <source-code> <source-code> is executed when option parsed
:cmt. :enumerate. <name> [<option>] option is one value in <name> enumeration
:cmt. :number. [<fn>] [<default>] [<usage argid>]
:cmt. =<num> allowed; call <fn> to check
:cmt. :id. [<fn>] [<usage argid>] =<id> req'd; call <fn> to check
:cmt. :char. [<fn>] [<usage argid>] =<char> req'd; call <fn> to check
:cmt. :file. [<usage argid>] =<file> req'd
:cmt. :path. [<usage argid>] =<path> req'd
:cmt. :special. <fn> [<usage argid>] call <fn> to parse option
:cmt.
:cmt. :optional. value is optional
:cmt. :internal. option is undocumented
:cmt. :prefix. prefix of a :special. option
:cmt. :nochain. option isn't chained with other options
:cmt. in parser code
:cmt. :usagenochain. option isn't chained with other options
:cmt. in usage text
:cmt. :timestamp. kludge to record "when" an option
:cmt. is set so that dependencies
:cmt. between options can be simulated
:cmt. :negate. negate option value
:cmt. :group. <num> [<chain>] group <num> to which option is included
:cmt. optionaly <chain> can be specified
:cmt. :optional. value is optional
:cmt. :internal. option is undocumented
:cmt. :prefix. prefix of a :special. option
:cmt. :nochain. option isn't chained with other options
:cmt. in parser code
:cmt. :timestamp. kludge to record "when" an option
:cmt. is set so that dependencies
:cmt. between options can be simulated
:cmt. :negate. negate option value
:cmt.
:cmt. :usage. <text> English usage text
:cmt. :jusage. <text> Japanese usage text
:cmt.
:cmt. :usagenochain. option isn't chained with other options
:cmt. in usage text
:cmt. :group. <group_id> group <group_id> to which option is
:cmt. included
:cmt.
:cmt. Global macros
:cmt.
:cmt. :noequal. args can't have option '='
:cmt. :argequal. <char> args use <char> instead of '='
:cmt. :noequal. args can't have option '='
:cmt. :argequal. <char> args use <char> instead of '='
:cmt.
:cmt. where <targ>:
:cmt. default - any, dbg, unused
Expand All @@ -92,6 +99,8 @@
:cmt. The :jtitle. or :jusage. tag is required if no text is associated with the tag.
:cmt. Otherwise, English text defined with :title. or :use. tag will be used instead.
:cmt.
:cmt. If any required argument is blank then use '.' (dot) character as placeholder.
:cmt.
:title. Usage: wasaxp {options} {asm_files}
Expand Down Expand Up @@ -131,21 +140,20 @@
:path.
:usage. set include path
:usagechain. o
:usage. Output object file format
:option. oc
:path.
:enumerate. format
:usage. COFF object file format
:option. oe
:path.
:enumerate. format
:usage. ELF object file format
:option. q
:usage. operate quietly
:usagechain. v
:usagechain. . v
:usage. Debug verbose output
:option. vi
Expand Down
89 changes: 49 additions & 40 deletions bld/bdiff/gml/optionsi.gml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,51 +37,58 @@
:cmt.
:cmt. GML Macros used:
:cmt.
:cmt. :chain. <option> <option> ... options that start with <option>
:cmt. can be chained together i.e.,
:cmt. -oa -ox -ot => -oaxt
:cmt. :target. <targ1> <targ2> ... valid for these targets (default is 'any')
:cmt. :ntarget. <targ1> <targ2> ... not valid for these targets
:cmt. :usagechain. <option> <usage text> group of options that start with <option>
:cmt. are chained together in usage text
:cmt. :usagegroup. <num> <usage text> group of options that have group <num>
:cmt. are chained together in usage text
:cmt. :title. <text> English title usage text
:cmt. :jtitle. <text> Japanese title usage text
:cmt. :titleu. <text> English title usage text for QNX resource file
:cmt. :jtitleu. <text> Japanese title usage text for QNX resource file
:cmt. :chain. <option> <option> ... options that start with <option>
:cmt. can be chained together i.e.,
:cmt. -oa -ox -ot => -oaxt
:cmt. :option. <option> <synonym> ... define an option
:cmt. :title. <text> English title usage text
:cmt. :jtitle. <text> Japanese title usage text
:cmt. :titleu. <text> English title usage text for QNX resource file
:cmt. :jtitleu. <text> Japanese title usage text for QNX resource file
:cmt. :usagegroup. <group_id> define group of options that have group
:cmt. <group_id> are grouped together in
:cmt. usage text
:cmt. :usagechain. <group_id> <option>
:cmt. group of options that start with <option>
:cmt. are chained together in usage text for
:cmt. defined group <group_id>
:cmt.
:cmt. :option. <option> <synonym> ... define an option
:cmt. :immediate. <fn> [<usage argid>] <fn> is called when option parsed
:cmt. :code. <source-code> <source-code> is executed when option parsed
:cmt. :enumerate. <name> [<option>] option is one value in <name> enumeration
:cmt. :number. [<fn>] [<default>] [<usage argid>] =<num> allowed; call <fn> to check
:cmt. :id. [<fn>] [<usage argid>] =<id> req'd; call <fn> to check
:cmt. :char. [<fn>] [<usage argid>] =<char> req'd; call <fn> to check
:cmt. :file. [<usage argid>] =<file> req'd
:cmt. :path. [<usage argid>] =<path> req'd
:cmt. :special. <fn> [<usage argid>] call <fn> to parse option
:cmt. :usage. <text> English usage text
:cmt. :jusage. <text> Japanese usage text
:cmt. :target. <targ1> <targ2> ... valid for these targets (default is 'any')
:cmt. :ntarget. <targ1> <targ2> ... not valid for these targets
:cmt. :immediate. <fn> [<usage argid>]
:cmt. <fn> is called when option parsed
:cmt. :code. <source-code> <source-code> is executed when option parsed
:cmt. :enumerate. <name> [<option>] option is one value in <name> enumeration
:cmt. :number. [<fn>] [<default>] [<usage argid>]
:cmt. =<num> allowed; call <fn> to check
:cmt. :id. [<fn>] [<usage argid>] =<id> req'd; call <fn> to check
:cmt. :char. [<fn>] [<usage argid>] =<char> req'd; call <fn> to check
:cmt. :file. [<usage argid>] =<file> req'd
:cmt. :path. [<usage argid>] =<path> req'd
:cmt. :special. <fn> [<usage argid>] call <fn> to parse option
:cmt.
:cmt. :optional. value is optional
:cmt. :internal. option is undocumented
:cmt. :prefix. prefix of a :special. option
:cmt. :nochain. option isn't chained with other options
:cmt. in parser code
:cmt. :usagenochain. option isn't chained with other options
:cmt. in usage text
:cmt. :timestamp. kludge to record "when" an option
:cmt. is set so that dependencies
:cmt. between options can be simulated
:cmt. :negate. negate option value
:cmt. :group. <num> [<chain>] group <num> to which option is included
:cmt. optionaly <chain> can be specified
:cmt. :optional. value is optional
:cmt. :internal. option is undocumented
:cmt. :prefix. prefix of a :special. option
:cmt. :nochain. option isn't chained with other options
:cmt. in parser code
:cmt. :timestamp. kludge to record "when" an option
:cmt. is set so that dependencies
:cmt. between options can be simulated
:cmt. :negate. negate option value
:cmt.
:cmt. :usage. <text> English usage text
:cmt. :jusage. <text> Japanese usage text
:cmt.
:cmt. :usagenochain. option isn't chained with other options
:cmt. in usage text
:cmt. :group. <group_id> group <group_id> to which option is
:cmt. included
:cmt.
:cmt. Global macros
:cmt.
:cmt. :noequal. args can't have option '='
:cmt. :argequal. <char> args use <char> instead of '='
:cmt. :noequal. args can't have option '='
:cmt. :argequal. <char> args use <char> instead of '='
:cmt.
:cmt. where <targ>:
:cmt. default - any, dbg, unused
Expand All @@ -92,6 +99,8 @@
:cmt. The :jtitle. or :jusage. tag is required if no text is associated with the tag.
:cmt. Otherwise, English text defined with :title. or :use. tag will be used instead.
:cmt.
:cmt. If any required argument is blank then use '.' (dot) character as placeholder.
:cmt.
:noequal.
Expand Down
89 changes: 49 additions & 40 deletions bld/bdiff/gml/optionsp.gml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,51 +37,58 @@
:cmt.
:cmt. GML Macros used:
:cmt.
:cmt. :chain. <option> <option> ... options that start with <option>
:cmt. can be chained together i.e.,
:cmt. -oa -ox -ot => -oaxt
:cmt. :target. <targ1> <targ2> ... valid for these targets (default is 'any')
:cmt. :ntarget. <targ1> <targ2> ... not valid for these targets
:cmt. :usagechain. <option> <usage text> group of options that start with <option>
:cmt. are chained together in usage text
:cmt. :usagegroup. <num> <usage text> group of options that have group <num>
:cmt. are chained together in usage text
:cmt. :title. <text> English title usage text
:cmt. :jtitle. <text> Japanese title usage text
:cmt. :titleu. <text> English title usage text for QNX resource file
:cmt. :jtitleu. <text> Japanese title usage text for QNX resource file
:cmt. :chain. <option> <option> ... options that start with <option>
:cmt. can be chained together i.e.,
:cmt. -oa -ox -ot => -oaxt
:cmt. :option. <option> <synonym> ... define an option
:cmt. :title. <text> English title usage text
:cmt. :jtitle. <text> Japanese title usage text
:cmt. :titleu. <text> English title usage text for QNX resource file
:cmt. :jtitleu. <text> Japanese title usage text for QNX resource file
:cmt. :usagegroup. <group_id> define group of options that have group
:cmt. <group_id> are grouped together in
:cmt. usage text
:cmt. :usagechain. <group_id> <option>
:cmt. group of options that start with <option>
:cmt. are chained together in usage text for
:cmt. defined group <group_id>
:cmt.
:cmt. :option. <option> <synonym> ... define an option
:cmt. :immediate. <fn> [<usage argid>] <fn> is called when option parsed
:cmt. :code. <source-code> <source-code> is executed when option parsed
:cmt. :enumerate. <name> [<option>] option is one value in <name> enumeration
:cmt. :number. [<fn>] [<default>] [<usage argid>] =<num> allowed; call <fn> to check
:cmt. :id. [<fn>] [<usage argid>] =<id> req'd; call <fn> to check
:cmt. :char. [<fn>] [<usage argid>] =<char> req'd; call <fn> to check
:cmt. :file. [<usage argid>] =<file> req'd
:cmt. :path. [<usage argid>] =<path> req'd
:cmt. :special. <fn> [<usage argid>] call <fn> to parse option
:cmt. :usage. <text> English usage text
:cmt. :jusage. <text> Japanese usage text
:cmt. :target. <targ1> <targ2> ... valid for these targets (default is 'any')
:cmt. :ntarget. <targ1> <targ2> ... not valid for these targets
:cmt. :immediate. <fn> [<usage argid>]
:cmt. <fn> is called when option parsed
:cmt. :code. <source-code> <source-code> is executed when option parsed
:cmt. :enumerate. <name> [<option>] option is one value in <name> enumeration
:cmt. :number. [<fn>] [<default>] [<usage argid>]
:cmt. =<num> allowed; call <fn> to check
:cmt. :id. [<fn>] [<usage argid>] =<id> req'd; call <fn> to check
:cmt. :char. [<fn>] [<usage argid>] =<char> req'd; call <fn> to check
:cmt. :file. [<usage argid>] =<file> req'd
:cmt. :path. [<usage argid>] =<path> req'd
:cmt. :special. <fn> [<usage argid>] call <fn> to parse option
:cmt.
:cmt. :optional. value is optional
:cmt. :internal. option is undocumented
:cmt. :prefix. prefix of a :special. option
:cmt. :nochain. option isn't chained with other options
:cmt. in parser code
:cmt. :usagenochain. option isn't chained with other options
:cmt. in usage text
:cmt. :timestamp. kludge to record "when" an option
:cmt. is set so that dependencies
:cmt. between options can be simulated
:cmt. :negate. negate option value
:cmt. :group. <num> [<chain>] group <num> to which option is included
:cmt. optionaly <chain> can be specified
:cmt. :optional. value is optional
:cmt. :internal. option is undocumented
:cmt. :prefix. prefix of a :special. option
:cmt. :nochain. option isn't chained with other options
:cmt. in parser code
:cmt. :timestamp. kludge to record "when" an option
:cmt. is set so that dependencies
:cmt. between options can be simulated
:cmt. :negate. negate option value
:cmt.
:cmt. :usage. <text> English usage text
:cmt. :jusage. <text> Japanese usage text
:cmt.
:cmt. :usagenochain. option isn't chained with other options
:cmt. in usage text
:cmt. :group. <group_id> group <group_id> to which option is
:cmt. included
:cmt.
:cmt. Global macros
:cmt.
:cmt. :noequal. args can't have option '='
:cmt. :argequal. <char> args use <char> instead of '='
:cmt. :noequal. args can't have option '='
:cmt. :argequal. <char> args use <char> instead of '='
:cmt.
:cmt. where <targ>:
:cmt. default - any, dbg, unused
Expand All @@ -92,6 +99,8 @@
:cmt. The :jtitle. or :jusage. tag is required if no text is associated with the tag.
:cmt. Otherwise, English text defined with :title. or :use. tag will be used instead.
:cmt.
:cmt. If any required argument is blank then use '.' (dot) character as placeholder.
:cmt.
:title. Usage: bpatch {-p} {-q} {-b} <file>
Expand Down
Loading

0 comments on commit 89f635f

Please sign in to comment.