lint: Fix yaml lint issues

pulp-platform · Aug 3, 2023 · d50d295 · d50d295
1 parent 9cdb3e4
commit d50d295
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 46 deletions.
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -27,7 +27,9 @@ variables:
   # UBOOT_ITB: ${CVA6_SDK}/u-boot/u-boot.itb
   # LINUX_UIMAGE: ${CVA6_SDK}/uImage
   # RISCV_LLVM: /usr/pack/riscv-1.0-kgf/pulp-llvm-0.12.0/bin/
+# yamllint disable rule:line-length
   # PATH: $RISCV_LLVM:$CI_PROJECT_DIR/.local/bin:${RISCV}/bin:/home/gitlabci/.cargo/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/condor/bin:/usr/sepp/bin
+# yamllint enable rule:line-length
 
 before_script:
   - export SNITCH_CLUSTER_ROOT=$($BENDER path snitch_cluster)
@@ -91,7 +93,9 @@ stages:
 #     - ./.gitlab-ci.d/occamy_cfg_fpga.sh
 #     - make -C hw/system/occamy update-source
 #     # Package IPs and run test elaboration
+# yamllint disable rule:line-length
 #     - make -C hw/system/occamy/fpga/vivado_ips occamy_xilinx EXT_JTAG=0 DEBUG=0
+# yamllint enable rule:line-length
 #   artifacts:
 #     expire_in: 4 days
 #     paths:
@@ -119,14 +123,14 @@ stages:
 #         - util/regtool.py
 #   timeout: 11h 00m
 #   script:
-#     # yamllint disable rule:line-length
+# yamllint disable rule:line-length
 #     - |
 #       if ! $CI_PROJECT_DIR/.gitlab-ci.d/memora_retry.sh --ignore-uncommitted-changes lookup occamy_vcu128; then
 #         make -C hw/system/occamy/fpga occamy_vcu128 EXT_JTAG=0 DEBUG=0
 #         mkdir -p /usr/scratch2/dolent1/gitlabci/buildcache/snitch/snitch-incremental/
 #         $CI_PROJECT_DIR/.gitlab-ci.d/memora_retry.sh --ignore-uncommitted-changes insert occamy_vcu128
 #       fi
-#     # yamllint enable rule:line-length
+# yamllint enable rule:line-length
 #   artifacts:
 #     expire_in: 4 days
 #     paths: [hw/system/occamy/fpga, hw/system/occamy/src]

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -12,48 +12,48 @@ repo_url: https://github.com/pulp-platform/snitch
 repo_name: pulp-platform/snitch
 
 markdown_extensions:
-- admonition
-- def_list
-- pymdownx.highlight
-- pymdownx.superfences
-- pymdownx.tabbed
-- pymdownx.emoji:
-    emoji_index: !!python/name:materialx.emoji.twemoji
-    emoji_generator: !!python/name:materialx.emoji.to_svg
+  - admonition
+  - def_list
+  - pymdownx.highlight
+  - pymdownx.superfences
+  - pymdownx.tabbed
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
 nav:
-- Home: index.md
-- User Guide:
-  - Getting Started: ug/getting_started.md
-  - Benchmarking: ug/benchmarking.md
-  - Tooling Setup at IIS: ug/setup-iis.md
-  - Trace Example: ug/example_trace.html
-  - Docker: ug/docker.md
-  - Directory Structure: ug/directory_structure.md
-  - Documentation: ug/documentation.md
-- Systems:
-  - Snitch Cluster:
-    - Guide: ug/snitch_cluster.md
-    - Schema: schema-doc/snitch_cluster.md
-  - Occamy:
-    - Guide: ug/occamy_system/occamy.md
-    - Architecture:
-      - Overview: ug/occamy_system/1_overview.md
-      - Address Map: ug/occamy_system/2_addrmap.md
-      - System Components: ug/occamy_system/3_system_components.md
-      - Clocking: ug/occamy_system/4_clocking.md
-      - Interrupts and Synchronization: 5_interrupts_and_synchronization.md
-    - Schema: schema-doc/occamy.md
-- Reference Manual:
-  - Snitch: rm/snitch/index.md
-  - Snitch Cluster: rm/snitch_cluster/index.md
-  - Reqrsp Interface: rm/reqrsp_interface/index.md
-  - Custom Instructions: rm/custom_instructions.md
-- Snitch Runtime:
-  - Pages: runtime/Pages/index.md
-  - Files: runtime/Files/index.md
-  - Classes: runtime/Classes/index.md
-  - Examples: runtime/Examples/index.md
-  - Modules: runtime/Modules/index.md
-  - Namespaces: runtime/Namespaces/index.md
-  # - Solder: rm/solder.md
-- Publications: publications.md
+  - Home: index.md
+  - User Guide:
+      - Getting Started: ug/getting_started.md
+      - Benchmarking: ug/benchmarking.md
+      - Tooling Setup at IIS: ug/setup-iis.md
+      - Trace Example: ug/example_trace.html
+      - Docker: ug/docker.md
+      - Directory Structure: ug/directory_structure.md
+      - Documentation: ug/documentation.md
+  - Systems:
+      - Snitch Cluster:
+          - Guide: ug/snitch_cluster.md
+          - Schema: schema-doc/snitch_cluster.md
+      - Occamy:
+          - Guide: ug/occamy_system/occamy.md
+          - Architecture:
+              - Overview: ug/occamy_system/1_overview.md
+              - Address Map: ug/occamy_system/2_addrmap.md
+              - System Components: ug/occamy_system/3_system_components.md
+              - Clocking: ug/occamy_system/4_clocking.md
+              - Interrupts and Synchronization: 5_interrupts_and_synchronization.md
+          - Schema: schema-doc/occamy.md
+  - Reference Manual:
+      - Snitch: rm/snitch/index.md
+      - Snitch Cluster: rm/snitch_cluster/index.md
+      - Reqrsp Interface: rm/reqrsp_interface/index.md
+      - Custom Instructions: rm/custom_instructions.md
+  - Snitch Runtime:
+      - Pages: runtime/Pages/index.md
+      - Files: runtime/Files/index.md
+      - Classes: runtime/Classes/index.md
+      - Examples: runtime/Examples/index.md
+      - Modules: runtime/Modules/index.md
+      - Namespaces: runtime/Namespaces/index.md
+      # - Solder: rm/solder.md
+  - Publications: publications.md
diff --git a/util/lint/.yamllint.yml b/util/lint/.yamllint.yml
@@ -23,3 +23,8 @@ rules:
   commas:
     ignore: |
       Bender.yml
+
+ignore:
+  - hw/vendor/openhwgroup_cva6/Bender.yml
+  - hw/vendor/openhwgroup_cva6/core/pmp/Bender.yml
+  - hw/vendor/pulp_platform_axi_tlb/Bender.yml