CWG-44, add readme and changed checks

.gitlab-ci.yml

@@ -40,7 +40,7 @@ lint-vhdl-lib-base:
         - pip3 install vsg --use-pep517
     script:
         - cd libraries/base
-        - find . -name "*.vhd" -exec vsg --configuration ../../vsg_config.yaml -f {} \;
+        - find . -name "*.vhd" -exec vsg -c ../../vsg_config.yaml -f {} \;
 
 lint-vhdl-lib-dsp:
     tags:
@@ -51,7 +51,7 @@ lint-vhdl-lib-dsp:
         - pip3 install vsg --use-pep517
     script:
         - cd libraries/dsp
-        - find . -name "*.vhd" -exec vsg --configuration ../../vsg_config.yaml -f {} \;
+        - find . -name "*.vhd" -exec vsg -c ../../vsg_config.yaml -f {} \;
       
 lint-vhdl-lib-io:
     tags:
@@ -62,7 +62,7 @@ lint-vhdl-lib-io:
         - pip3 install vsg --use-pep517
     script:
         - cd libraries/io
-        - find . -name "*.vhd" -exec vsg --configuration ../../vsg_config.yaml -f {} \;
+        - find . -name "*.vhd" -exec vsg -c ../../vsg_config.yaml -f {} \;
       
 lint-vhdl-lib-technology:
     tags:
@@ -73,7 +73,7 @@ lint-vhdl-lib-technology:
         - pip3 install vsg --use-pep517
     script:
         - cd libraries/technology
-        - find . -name "*.vhd" -exec vsg --configuration ../../vsg_config.yaml -f {} \;
+        - find . -name "*.vhd" -exec vsg -c ../../vsg_config.yaml -f {} \;
 
 lint-vhdl-boards-uniboard2b:
     tags:
@@ -84,7 +84,7 @@ lint-vhdl-boards-uniboard2b:
         - pip3 install vsg --use-pep517
     script:
         - cd boards/uniboard2b
-        - find . -name "*.vhd" -exec vsg --configuration ../../vsg_config.yaml -f {} \;
+        - find . -name "*.vhd" -exec vsg -c ../../vsg_config.yaml -f {} \;
 
 lint-vhdl-boards-uniboard2c:
     tags:
@@ -95,18 +95,7 @@ lint-vhdl-boards-uniboard2c:
         - pip3 install vsg --use-pep517
     script:
         - cd boards/uniboard2c
-        - find . -name "*.vhd" -exec vsg --configuration ../../vsg_config.yaml -f {} \;
-
-lint-vhdl-applications-disturb2:
-    tags:
-        - hdl
-    stage: linting
-    allow_failure: true
-    before_script:
-        - pip3 install vsg --use-pep517
-    script:
-        - cd applications/disturb2
-        - find . -name "*.vhd" -exec vsg --configuration ../../vsg_config.yaml -f {} \;
+        - find . -name "*.vhd" -exec vsg -c ../../vsg_config.yaml -f {} \;
 
 lint-vhdl-applications-lofar2:
     tags:
@@ -117,7 +106,7 @@ lint-vhdl-applications-lofar2:
         - pip3 install vsg --use-pep517
     script:
         - cd applications/lofar2
-        - find . -name "*.vhd" -exec vsg --configuration ../../vsg_config.yaml -f {} \;
+        - find . -name "*.vhd" -exec vsg -c ../../vsg_config.yaml -f {} \;
 
 ###############################################################################
 # HDL simulation stage

readme.md

+# Gitlab CI/CD
+
+HDL linting is using *gitlab-runners* on *dop349*.
+
+Linting tool used is *vhdl-style-guide* (VSG)
+
+link: https://vhdl-style-guide.readthedocs.io/en/latest/index.html
+
+##### Linting settings.
+
+By default all rules are disabled in de *vsg_config.yaml* file.
+
+The only active rule on this moment is *case.keyword* and is set to *upper*.
+
+
+
+
+