@@ -44,5 +44,110 @@ In order to save the logs in files the developer must add the variable `HOG_LOGG
```
:::{warning}
The files will be overwritten every time that the `Hog/do` script runs.
The files will be overwritten every time that the `Hog/Do` script runs.
:::
## Hog Environmental configuration files
### Project HogEnv.conf
This file configures the behavior of Hog and its Logger Project wide.
Because this file is in the project folder will affect also to the CI jobs.
#### Options
***fail when error :** (not yet implemented) it will trigger the kill of the process or job
***enabled :** enables the option
***delay :** set a number of delay messages before killing
***exclude :** excludes errors with the strings in the array
***Overloads :** allows to overload the verbose level of message output by the script to another verbose level defined by the user
***(verbose level original)2(new verbose level) :** all the error messages containing one of the strings in the array will be output as critical warnings
* Example:
* e2c will convert the error message in a critical message
* i2w will convert the info message in a warning message
* c2e will convert the critical message in a error message
```yaml
# ############################
# Hog Configuration File
# ############################
# Force Hog to stop processing when an error is detected
[fail when error]#not implemetned yet
enabled= 0
delay= 30
exclude=[ "Wrong number of arguments"]
# overload the type of message to show
# EX:
# e2c: error will be shown as critical
[overloads]
e2c=["(vsim-86)" ,
"(vsim-3421)",
"Fatal error in Subprogram get_b_chamber_type",
"Can't parse message of type "ReportMetaData" because it is missing required fields:report_type",
]
i2w=[
"[HDL 9-3088]"
]
c2e=[
"[Hog:ReadListFile-0]",
"[HDL 9-1206]",
"[HDL 9-3136]",
"[HDL 9-3242]",
"[HDL 9-3500]",
"[HDL 9-1314]",
"[HDL 9-3429]",
"[HDL 9-5341]",
"[HDL 9-4622]",
"[HDL 9-5342]",
"[HDL 9-3609]",
"[HDL 9-845]",
"[HDL 9-3609]",
"[HDL 9-1797]",
"[HDL 9-3611]",
"[HDL 9-3134]",
"[Synth 8-6859]",
"[HDL 9-3082]"
]
w2i=[
" Case choice must be a locally static expression [/home/guille/ATLAS/l0mdt-hdl-design/HAL/ctrl/src/SM_C2C_INTF/misc/I2C_reg_master.vhd:"
]
# i2e=["Copyright 1986-2022 Xilinx, Inc. All Rights Reserved."]
```
### Home HogEnv.conf
This file configures the appearance of the Logger.
This folder will be in the home folder of the user and will only affect Hog Locally
***terminal :** Configurations about the appearence of the Hog output
***logger :** Enables the output of log files as described previously [0: disabled ; 1: Enabled]
***colored :** Enables the color level of the Hog output [0: monocrome; 1: basic color scheme; 2: full colored logs]
***verbose :** Allows to change what is verbose by the Hog Logger
***pidshow :** Allows to change what is verbose by the Hog Logger [0: disabled ; 1: Enabled]
***lineCounter :** Shows a line counter in the left of the logger [0: disabled ; 1: Enabled]
***msgtypeCounter :** Shows a message type line counter in the left of the logger [0: disabled ; 1: Enabled]
