Fix some linting issues (#2046)

.github/workflows/markdownlint.yml

@@ -14,4 +14,4 @@ jobs:
     - name: Use markdownlint
       uses: actionshub/markdownlint@v3.1.3
       with:
-        filesToIgnoreRegex: "CHANGELOG.md|CONTRIBUTING.md|README.md|packaging_guidelines.md|about.md|quick_start.md|index.md|gpu_os_support.md|magma_install.md|math.md|reference/rocmcc.md|docker.md|hip.md|hip_sdk_install_win.md|all_deploy_options.md|inception_casestudy.md|deep_learning_rocm.md|quick_start_windows.md|tensorflow_install.md|pytorch_install.md|mi250.md|openmp.md|c++_primitives.md|ai_tools.md|computer_vision.md|all.md|compilers.md|management_tools.md|validation_tools.md|installing_linux.md|file_reorg.md|prerequisites.md|quick_start_linux.md|docker_support_matrix.md|gpu_os_support.md|"
+        filesToIgnoreRegex: CHANGELOG.md

CONTRIBUTING.md

@@ -38,15 +38,18 @@ as follows:
   our automated github action on a Pull Request (PR).
 
 ## Filenames and folder structure
+
 Please use snake case for file names. Our documentation follows pitchfork for
 folder structure. All documentation is in /docs except for special files like
 the contributing guide in the / folder. All images used in the documentation are
 place in the /docs/data folder.
 
-## How do provide feedback for for ROCm documentation?
+## How to provide feedback for for ROCm documentation
+
 There are three standard ways to provide feedback for this repository.
 
 ### Pull Request
+
 All contributions to ROCm documentation should arrive via the
 [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow)
 targetting the develop branch of the repository. If you are unable to contribute
@@ -95,6 +98,7 @@ python3 -mvenv .venv
 ```
 
 Python versions known to build documentation:
+
 - 3.8
 - 3.9
 - 3.10
@@ -149,8 +153,7 @@ resulting website show up on a locally serving web server.
     - Sets the root of the output website for live previews. Must be changed
       alongside the `tasks.json` command.
     - Tells live server to wait with the update to give time for Sphinx to
-    regenerate site contents and not refresh before all is don. (Empirical value
-    )
+      regenerate site contents and not refresh before all is don. (Empirical value)
     - Automatic virtual env activation is a nice touch, should you want to build
       the site from the integrated terminal.
 
@@ -215,11 +218,11 @@ resulting website show up on a locally serving web server.
     ```
 
     > (Implementation detail: two problem matchers were needed to be defined,
-    because VS Code doesn't tolerate some problem information being potentially
-    absent. While a single regex could match all types of errors, if a capture
-    group remains empty (the line number doesn't show up in all warning/error
-    messages) but the `pattern` references said empty capture group, VS Code
-    discards the message completely.)
+    > because VS Code doesn't tolerate some problem information being potentially
+    > absent. While a single regex could match all types of errors, if a capture
+    > group remains empty (the line number doesn't show up in all warning/error
+    > messages) but the `pattern` references said empty capture group, VS Code
+    > discards the message completely.)
 
 4. Configure Python virtual environment (venv)
 
@@ -241,3 +244,5 @@ resulting website show up on a locally serving web server.
     `.vscode/build/html/index.html` and select `Open with Live Server`. The
     contents should update on every rebuild without having to refresh the
     browser.
+
+<!-- markdownlint-restore -->

docs/about.md

@@ -28,6 +28,7 @@ projects that believe markdown is not suitable should contact the documentation
 team prior to selecting rst.
 
 ### MyST
+
 [Markedly Structured Text (MyST)](https://myst-tools.org/docs/spec) is an extended
 flavor of Markdown ([https://commonmark.org/](CommonMark)) influenced by ReStructured
 Text (RST) and Sphinx.

docs/how_to/deep_learning_rocm.md

@@ -10,6 +10,7 @@ align: center
 ---
 ROCm Compatible Frameworks Flowchart
 ```
+
 ## Frameworks Installation
 
 - [How to Install PyTorch?](pytorch_install/pytorch_install)

docs/how_to/manage_install/install_linux.md

@@ -428,8 +428,8 @@ To check the `kernel-headers` and `linux-modules-extra` package versions,
 follow these steps:
 
 1. For the Ubuntu/Debian environment, execute the following command to verify
-the kernel headers and development packages are installed with the respective
-versions:
+   the kernel headers and development packages are installed with the
+   respective versions:
 
    ```shell
    sudo dpkg -l | grep linux-headers
@@ -456,8 +456,8 @@ installed:
    ```
 
 3. If the supported version installation of Linux headers and development
-packages are not installed on the system, execute the following command to
-install the packages:
+   packages are not installed on the system, execute the following command
+   to install the packages:
 
    ```shell
    sudo apt install linux-headers-`uname -r` linux-modules-extra-`uname -r`
@@ -607,8 +607,8 @@ type the following on the command line:
    the same versions as the kernel.
 
 2. The following command lists the development packages on your system. Verify
-if the listed development package's version number matches the kernel version
-number:
+   if the listed development package's version number matches the kernel
+   version number:
 
    ```shell
    sudo yum list installed kernel-devel

docs/reference/all.md

@@ -1,6 +1,7 @@
 # All Reference Material
 
 ## ROCm Software Groups
+
 :::::{grid} 1 1 2 2
 :gutter: 1
 

docs/reference/gpu_arch/mi250.md

@@ -50,34 +50,42 @@ Figure 1: Structure of a single GCD in the AMD Instinct MI250 accelerator.
 :header-rows: 1
 :name: mi250-perf
 
-* - Computation and Data Type
+*
+  - Computation and Data Type
   - FLOPS/CLOCK/CU
   - Peak TFLOPS
-* - Matrix FP64
+*
+  - Matrix FP64
   - 256
   - 90.5
-* - Vector FP64
+*
+  - Vector FP64
   - 128
   - 45.3
-* - Matrix FP32
+*
+  - Matrix FP32
   - 256
   - 90.5
-* - Packed FP32
+*
+  - Packed FP32
   - 256
   - 90.5
-* - Vector FP32
+*
+  - Vector FP32
   - 128
   - 45.3
-* - Matrix FP16
+*
+  - Matrix FP16
   - 1024
   - 362.1
-* - Matrix BF16
+*
+  - Matrix BF16
   - 1024
   - 362.1
-* - Matrix INT8
+*
+  - Matrix INT8
   - 1024
   - 362.1
-
 ```
 
 {numref}`mi250-perf` summarizes the aggregated peak performance of the AMD

docs/reference/gpu_libraries/c++_primitives.md

@@ -1,4 +1,5 @@
 # C++ Primitive Libraries
+
 ROCm template libraries for algorithms are as follows:
 
 :::::{grid} 1 1 3 3

docs/reference/openmp/openmp.md

@@ -260,6 +260,7 @@ Address Sanitizer is a memory error detector tool utilized by applications to de
 - Initialization order bugs
 
 **Features Supported on AMDGPU Platform (amdgcn-amd-amdhsa):**
+
 - Heap buffer overflow
 
 - Global buffer overflow

docs/reference/rocmcc/rocmcc.md

@@ -18,6 +18,7 @@ The differences are listed in [the table below](rocm-llvm-vs-alt).
 :::
 
 For more details, see:
+
 - AMD GPU usage: [llvm.org/docs/AMDGPUUsage.html](https://llvm.org/docs/AMDGPUUsage.html)
 - Releases and source: <https://github.com/RadeonOpenCompute/llvm-project>
 
@@ -153,7 +154,6 @@ to perform this optimization. Users can choose different levels of
 aggressiveness with which this optimization can be applied to the application,
 with 1 being the least aggressive and 7 being the most aggressive level.
 
-
 :::{table} -fstruct-layout Values and Their Effects
 | -fstruct-layout value | Structure peeling | Pointer size after selective compression of self-referential pointers in structures, wherever safe | Type of structure fields eligible for compression | Whether compression performed under safety check |
 | ----------- | ----------- | ----------- | ----------- | ----------- |

docs/release/gpu_os_support.md

@@ -61,7 +61,6 @@ Use Driver Shipped with ROCm
 | AMD Radeon™ VII        | Vega           |Full        | gfx906                                                               | Supported                            | Unsupported   |
 | AMD Radeon™ R9 Fury    | Fiji           |Full        | gfx803                                                               | Community                            | Unsupported |
 
-
 :::
 
 ::::
@@ -104,6 +103,7 @@ below:
 - HIP SDK includes the HIP Runtime and a selection of GPU libraries for compute.
   Please see [article](link) for details of HIP SDK.
 - HIP enables the use of the HIP Runtime only.
+
 :::
 
 ::::

docs/understand/file_reorg.md

@@ -94,9 +94,10 @@ from the new location (/opt/rocm-xxx/include) as shown in the example below.
 The depreciation plan for backward compatibility wrapper header files is as
 follows
 
-- #pragma message announcing deprecation – ROCm v5.2 release.
-- #pragma message changed to #warning – Future release, tentatively ROCm v5.5.
-- #warning changed to #error – Future release, tentatively ROCm v5.6.
+- `#pragma` message announcing deprecation – ROCm v5.2 release.
+- `#pragma` message changed to `#warning` – Future release, tentatively ROCm
+  v5.5.
+- `#warning` changed to `#error` – Future release, tentatively ROCm v5.6.
 - Backward compatibility wrappers removed – Future release, tentatively ROCm
   v6.0.
 

docs/understand/installing_linux.md

@@ -125,8 +125,8 @@ The single-version ROCm installation refers to the following:
 The multiversion installation refers to the following:
 
 - Installation of multiple instances of the ROCm stack on a system. Extending
-the package name and its dependencies with the release version adds the ability
-to support multiple versions of packages simultaneously.
+  the package name and its dependencies with the release version adds the
+  ability to support multiple versions of packages simultaneously.
 - Use of versioned ROCm meta-packages.
 
 ```{note}

mdlrc-style.rb

@@ -2,7 +2,16 @@ all
 # Extend line length
 rule 'MD013', :line_length => 99999
 
+# Use "1. 2. 3."-style numbered lists instead of "1. 1. 1."
+rule 'MD029', :style => :ordered
+
 # Allow in-line HTML
 exclude_rule 'MD033'
 
 exclude_rule 'MD041'
+
+# False positives, see: https://github.com/markdownlint/markdownlint/issues/374
+exclude_rule 'MD005'
+
+# False positives, see: https://github.com/markdownlint/markdownlint/issues/313
+exclude_rule 'MD007'