JD2022-TU1/main/extern/ITNetwork/gear/tools/Configuration Tool/stats_readme.txt

75 lines
No EOL
4 KiB
Text

_____)
/ /) , , /) , /)
/ ___ _ _ __ _ _____ // _ __ _ _/_ _____ // // _
/ / ) _(/_(_(_/ (_ (__(_) / (_/(__(_(_/_(_(_/ (_(_(_(___(_(_) / (_ /(__(_(/__(/_
(____ / /) .-/ /)
(/ (_/ (/
, ,
_ _/_ _ _/_ _ _/_ _ _ __ __ ____ __ _ ___
/_)_(__(_(_(___(_/_)_(___(_(__/_)_ /_)_/ (_(_)(_/_/ (_(_(_// (_
.-/ .-/
(_/ (_/
Gear configuration file statistics program
This tool will generate a csv (comma separated file) with all the .h (that are gearextconfig) located in a directory.
Those option are available to you:
-t templatefile --> Optional : If not specified the template is the full one. The template file (txt) which contain the format of data you want the tool to output for you.
-d directory --> Optional : If not specified, the current directory will be consider. This is the directory containing all your gearextconfig.h.
-r --> Optional : Recurse trought subdirectory when iterating on gearextconfig.h.
-f --> Mandatory : Name of the file where to save the statistics.
-v --> Optional : Verbose mode.
Template file doc
You can specify option for: module,config,platform,target,selection,parent and count field
Each field is on one line. Field and option must be separated by a ':' (ex: module:assert)
Field:
General:
By specifying only the name of the field you ensure that this field is shown. If not it will not appear in the stats files.
module,config and count field are mandatory (they will be always shown).
1. module,config,platform,target
module:[modulelist] --> specified which module you want or which you don't want by preceding their my a '!'
config:[configlist]
platform:[platformlist]
target:[targetlist]
2. platform value possibility: ps3_ppu,ps3_spu,psp,win32,win64,xenon,nitro,gc2. In the output file, platform is the only option
where we will merge different platform for a same module.
For example if a module is enable on win32 and win64 the platform will be win32|win64.
3. selection option can be either: manually, dependency, both or none. Default value is both.
4. parent has no option
5. count option is a int that is >= 0. All module that have a count < that this option will not be shown. Default value is 0.
Ex:
module:!assert,!types,!platform --> do NOT show assert, types and platform module, everything else will be shown.
module:assert,types,platform --> ONLY shown the assert, types and platorn module, everything else will NOT be shown.
config:!GEAR_CFG_COMPILE --> do NOT show GEAR_CFG_COMPILE config, everything else will be shown.
platform:gc2,nitro --> ONLY show gc2 and nitro platform, everything else will NOT be shown.
target:mygame_debug_memorylog --> ONLY show mygame_debug_memorylog target, everything else will NOT be shown.
selection:manually --> ONLY show the manually selected module
parent --> show the parent, if not present, parent field will not have been shown. Same goes for platform,target and selection
count:10 --> only show module (not config!) that are chosen 10 times.
Ex: Show all module/config for the win32 platform. Do not show target,parent and selection
platform:win32
Ex: Show all module except types, show all config, show platform, show parent, selection and module that have a count superior of equal to 1.
Do not show target.
platform
module:!types
parent
selection
count:1