fix some formatting

Signed-off-by: Brian McGillion <[email protected]>
tiiuae · Oct 7, 2024 · 0fb445f · 0fb445f
1 parent 601b7b3
commit 0fb445f
Show file tree

Hide file tree

Showing 8 changed files with 1,189 additions and 1,287 deletions.
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -8,7 +8,7 @@ on:
     branches:
       - main
     paths:
-      - 'docs/**'
+      - "docs/**"
 jobs:
   deploy:
     name: build doc and deploy to gh pages

diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml
@@ -15,7 +15,7 @@ on:
   # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
   schedule:
     # weekly on Sundays
-    - cron: '0 8 * * 0'
+    - cron: "0 8 * * 0"
   push:
     branches: ["main"]
 # Declare default permissions as read only.

diff --git a/REUSE.toml b/REUSE.toml
@@ -2,7 +2,6 @@
 # SPDX-License-Identifier: Apache-2.0
 
 version = 1
-
 SPDX-PackageName = "ghaf"
 SPDX-PackageSupplier = "Technology Innovation Institute <https://tii.ae>"
 SPDX-PackageDownloadLocation = "https://github.com/tiiuae/ghaf"
@@ -12,41 +11,42 @@ SPDX-License-Identifier = "Apache-2.0"
 SPDX-FileCopyrightText = "2022-2024 TII (SSRC) and the Ghaf contributors"
 precedence = "closest"
 path = [
-	"flake.lock", ".version",
-	"assets/**/*.png", "assets/**/*.svg",
-	"modules/common/development/audio_test/test_file1.mp3",
-	"modules/hardware/x86_64-generic/kernel/configs/ghaf_host_hardened_baseline-x86",
-	"modules/reference/hardware/jetpack/ghaf_host_hardened_baseline-jetson-orin",
-	"modules/lanzaboote/demo-secure-boot-keys/**/*",
-	"modules/microvm/virtualization/microvm/idsvm/mitmproxy/mitmproxy-ca/*",
+  "flake.lock",
+  ".version",
+  "assets/**/*.png",
+  "assets/**/*.svg",
+  "modules/common/development/audio_test/test_file1.mp3",
+  "modules/hardware/x86_64-generic/kernel/configs/ghaf_host_hardened_baseline-x86",
+  "modules/reference/hardware/jetpack/ghaf_host_hardened_baseline-jetson-orin",
+  "modules/lanzaboote/demo-secure-boot-keys/**/*",
+  "modules/microvm/virtualization/microvm/idsvm/mitmproxy/mitmproxy-ca/*"
 ]
 
 [[annotations]]
 SPDX-License-Identifier = "CC-BY-SA-4.0"
 SPDX-FileCopyrightText = "2022-2024 TII (SSRC) and the Ghaf contributors"
 precedence = "closest"
 path = [
-	"docs/**/*.svg", "docs/**/*.png",
+  "docs/**/*.svg",
+  "docs/**/*.png"
 ]
 
-# External code
-
 [[annotations]]
 # See https://github.com/qemu/qemu/blob/master/LICENSE
 # Our changes affects the GPL-2.0+ parts only.
 SPDX-License-Identifier = "GPL-2.0-or-later"
 SPDX-FileCopyrightText = [
-	"Fabrice Bellard and the QEMU team",
-	"Copyright (c) 2021-2022 Canokeys.org <[email protected]>",
-	"Written by Hongren (Zenithal) Zheng <[email protected]>",
-	"Copyright (c) 2019 Janus Technologies, Inc. (http://janustech.com)",
-	"Copyright (C) 2008-2010  Kevin O'Connor <[email protected]>",
-	"Copyright (C) 2006 Fabrice Bellard",
-	"Copyright (C) 2013 Red Hat Inc",
+  "Fabrice Bellard and the QEMU team",
+  "Copyright (c) 2021-2022 Canokeys.org <[email protected]>",
+  "Written by Hongren (Zenithal) Zheng <[email protected]>",
+  "Copyright (c) 2019 Janus Technologies, Inc. (http://janustech.com)",
+  "Copyright (C) 2008-2010  Kevin O'Connor <[email protected]>",
+  "Copyright (C) 2006 Fabrice Bellard",
+  "Copyright (C) 2013 Red Hat Inc"
 ]
 path = [
-	"overlays/custom-packages/qemu/*.patch",
-	"modules/reference/hardware/jetpack/nvidia-jetson-orin/virtualization/host/bpmp-virt-host/overlays/qemu/patches/0001-qemu-v8.1.3_bpmp-virt.patch"
+  "overlays/custom-packages/qemu/*.patch",
+  "modules/reference/hardware/jetpack/nvidia-jetson-orin/virtualization/host/bpmp-virt-host/overlays/qemu/patches/0001-qemu-v8.1.3_bpmp-virt.patch"
 ]
 
 [[annotations]]
@@ -58,8 +58,8 @@ path = "overlays/custom-packages/labwc/*.patch"
 # gtklock doesn't specify if later versions is allowed
 SPDX-License-Identifier = "GPL-3.0-only"
 SPDX-FileCopyrightText = [
-	"Copyright (c) 2022 Kenny Levinsen, Jovan Lanik, Erik Reider, Melih Darcan, Bhaskar Khoraja",
-	"Copyright (c) 2022 Zephyr Lykos"
+  "Copyright (c) 2022 Kenny Levinsen, Jovan Lanik, Erik Reider, Melih Darcan, Bhaskar Khoraja",
+  "Copyright (c) 2022 Zephyr Lykos"
 ]
 path = "overlays/custom-packages/gtklock/*.patch"
 
@@ -81,30 +81,30 @@ path = "packages/element-web/*.patch"
 [[annotations]]
 SPDX-License-Identifier = "Apache-2.0"
 SPDX-FileCopyrightText = [
-	"Copyright 2016 Aviral Dasgupta",
-	"Copyright 2016 OpenMarket Ltd",
-	"Copyright 2017, 2019 Michael Telatynski <[email protected]>",
-	"Copyright 2018 - 2021 New Vector Ltd",
+  "Copyright 2016 Aviral Dasgupta",
+  "Copyright 2016 OpenMarket Ltd",
+  "Copyright 2017, 2019 Michael Telatynski <[email protected]>",
+  "Copyright 2018 - 2021 New Vector Ltd"
 ]
 path = "overlays/custom-packages/element-desktop/element-main.patch"
 
 [[annotations]]
 SPDX-License-Identifier = "GPL-2.0-only"
 SPDX-FileCopyrightText = [
-	"Copyright (C) 2013 - Virtual Open Systems",
-	"Copyright (c) 2016, NVIDIA CORPORATION.  All rights reserved.",
-	"Copyright (c) 2018, NVIDIA CORPORATION.",
-	"Copyright (C) 2006 Qumranet, Inc.",
-	"Copyright 2010 Red Hat, Inc. and/or its affiliates.",
-	"2022-2024 TII (SSRC) and the Ghaf contributors",
+  "Copyright (C) 2013 - Virtual Open Systems",
+  "Copyright (c) 2016, NVIDIA CORPORATION.  All rights reserved.",
+  "Copyright (c) 2018, NVIDIA CORPORATION.",
+  "Copyright (C) 2006 Qumranet, Inc.",
+  "Copyright 2010 Red Hat, Inc. and/or its affiliates.",
+  "2022-2024 TII (SSRC) and the Ghaf contributors"
 ]
 path = [
-	"modules/reference/hardware/jetpack/nvidia-jetson-orin/virtualization/common/bpmp-virt-common/patches/*.patch",
-	"modules/reference/hardware/jetpack/nvidia-jetson-orin/virtualization/host/bpmp-virt-host/patches/*.patch",
-	"modules/reference/hardware/jetpack-microvm/*.patch",
-	"modules/reference/hardware/jetpack/nvidia-jetson-orin/virtualization/passthrough/uarti-net-vm/patches/net_vm_dtb_with_uarti.patch",
-	"modules/common/virtualization/pkvm/0001-pkvm-enable-pkvm-on-intel-x86-6.1-lts.patch",
-	"modules/microvm/virtualization/microvm/0001-x86-gpu-Don-t-reserve-stolen-memory-for-GPU-passthro.patch",
+  "modules/reference/hardware/jetpack/nvidia-jetson-orin/virtualization/common/bpmp-virt-common/patches/*.patch",
+  "modules/reference/hardware/jetpack/nvidia-jetson-orin/virtualization/host/bpmp-virt-host/patches/*.patch",
+  "modules/reference/hardware/jetpack-microvm/*.patch",
+  "modules/reference/hardware/jetpack/nvidia-jetson-orin/virtualization/passthrough/uarti-net-vm/patches/net_vm_dtb_with_uarti.patch",
+  "modules/common/virtualization/pkvm/0001-pkvm-enable-pkvm-on-intel-x86-6.1-lts.patch",
+  "modules/microvm/virtualization/microvm/0001-x86-gpu-Don-t-reserve-stolen-memory-for-GPU-passthro.patch"
 ]
 
 [[annotations]]
@@ -116,20 +116,19 @@ path = "modules/reference/hardware/jetpack/nvidia-jetson-orin/edk2-nvidia-always
 SPDX-License-Identifier = "LicenseRef-NvidiaProprietary"
 SPDX-FileCopyrightText = "Copyright (c) 2023-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved."
 path = [
-	"modules/reference/hardware/jetpack/nvidia-jetson-orin/tegra2-mb2-bct-scr.patch",
+  "modules/reference/hardware/jetpack/nvidia-jetson-orin/tegra2-mb2-bct-scr.patch"
 ]
 
-
 [[annotations]]
 SPDX-License-Identifier = "MIT"
 SPDX-FileCopyrightText = "Copyright 2019-2021 Microchip Corporation."
 path = [
-	"packages/hart-software-services/0001-Workaround-for-a-compilation-issue.patch",
+  "packages/hart-software-services/0001-Workaround-for-a-compilation-issue.patch"
 ]
 
 [[annotations]]
 SPDX-License-Identifier = "BSD-2-Clause"
 SPDX-FileCopyrightText = "Copyright (c) 2017-2020, Linaro Limited"
 path = [
-	"targets/nvidia-jetson-orin/0001-ta-pkcs11-Build-time-option-for-controlling-pin-lock.patch",
+  "targets/nvidia-jetson-orin/0001-ta-pkcs11-Build-time-option-for-controlling-pin-lock.patch"
 ]
diff --git a/docs/book.toml b/docs/book.toml
@@ -17,5 +17,6 @@ git-repository-icon = "fa-github"
 additional-css = ["theme/pagetoc.css"]
 additional-js = ["theme/pagetoc.js"]
 
-[preprocessor.footnote]
 [preprocessor.alerts]
+
+[preprocessor.footnote]
diff --git a/docs/theme/pagetoc.css b/docs/theme/pagetoc.css
@@ -5,103 +5,103 @@ SPDX-License-Identifier: WTFPL
 */
 
 :root {
-    --toc-width: 270px;
-    --center-content-toc-shift: calc(-1 * var(--toc-width) / 2);
+  --toc-width: 270px;
+  --center-content-toc-shift: calc(-1 * var(--toc-width) / 2);
 }
 
 .nav-chapters {
-    /* adjust width of buttons that bring to the previous or the next page */
-    min-width: 50px;
+  /* adjust width of buttons that bring to the previous or the next page */
+  min-width: 50px;
 }
 
 .previous {
-    /*
+  /*
     adjust the space between the left sidebar or the left side of the screen 
     and the button that leads to the previous page
     */
-    margin-left: var(--page-padding);
+  margin-left: var(--page-padding);
 }
 
 @media only screen {
-    main {
-        display: flex;
-    }
+  main {
+    display: flex;
+  }
 
-    @media (max-width: 1179px) {
-        .sidebar-hidden .sidetoc {
-            display: none;
-        }
+  @media (max-width: 1179px) {
+    .sidebar-hidden .sidetoc {
+      display: none;
     }
+  }
 
-    @media (max-width: 1439px) {
-        .sidebar-visible .sidetoc {
-            display: none;
-        }
+  @media (max-width: 1439px) {
+    .sidebar-visible .sidetoc {
+      display: none;
     }
+  }
 
-    @media (1180px <= width <= 1439px) {
-        .sidebar-hidden main {
-            position: relative;
-            left: var(--center-content-toc-shift);
-        }
+  @media (1180px <= width <= 1439px) {
+    .sidebar-hidden main {
+      position: relative;
+      left: var(--center-content-toc-shift);
     }
+  }
 
-    @media (1440px <= width <= 1700px) {
-        .sidebar-visible main {
-            position: relative;
-            left: var(--center-content-toc-shift);
-        }
+  @media (1440px <= width <= 1700px) {
+    .sidebar-visible main {
+      position: relative;
+      left: var(--center-content-toc-shift);
     }
+  }
 
-    .content-wrap {
-        overflow-y: auto;
-        width: 100%;
-    }
+  .content-wrap {
+    overflow-y: auto;
+    width: 100%;
+  }
 
-    .sidetoc {
-        margin-top: 20px;
-        margin-left: 10px;
-        margin-right: auto;
-    }
-    .pagetoc {
-        position: fixed;
-        /* adjust TOC width */
-        width: var(--toc-width);
-        height: calc(100vh - var(--menu-bar-height) - 0.67em * 4);
-        overflow: auto;
-    }
-    .pagetoc a {
-        border-left: 1px solid var(--sidebar-bg);
-        color: var(--fg) !important;
-        display: block;
-        padding-bottom: 5px;
-        padding-top: 5px;
-        padding-left: 10px;
-        text-align: left;
-        text-decoration: none;
-    }
-    .pagetoc a:hover,
-    .pagetoc a.active {
-        background: var(--sidebar-bg);
-        color: var(--sidebar-fg) !important;
-    }
-    .pagetoc .active {
-        background: var(--sidebar-bg);
-        color: var(--sidebar-fg);
-    }
-    .pagetoc .pagetoc-H2 {
-        padding-left: 20px;
-    }
-    .pagetoc .pagetoc-H3 {
-        padding-left: 40px;
-    }
-    .pagetoc .pagetoc-H4 {
-        padding-left: 60px;
-    }
+  .sidetoc {
+    margin-top: 20px;
+    margin-left: 10px;
+    margin-right: auto;
+  }
+  .pagetoc {
+    position: fixed;
+    /* adjust TOC width */
+    width: var(--toc-width);
+    height: calc(100vh - var(--menu-bar-height) - 0.67em * 4);
+    overflow: auto;
+  }
+  .pagetoc a {
+    border-left: 1px solid var(--sidebar-bg);
+    color: var(--fg) !important;
+    display: block;
+    padding-bottom: 5px;
+    padding-top: 5px;
+    padding-left: 10px;
+    text-align: left;
+    text-decoration: none;
+  }
+  .pagetoc a:hover,
+  .pagetoc a.active {
+    background: var(--sidebar-bg);
+    color: var(--sidebar-fg) !important;
+  }
+  .pagetoc .active {
+    background: var(--sidebar-bg);
+    color: var(--sidebar-fg);
+  }
+  .pagetoc .pagetoc-H2 {
+    padding-left: 20px;
+  }
+  .pagetoc .pagetoc-H3 {
+    padding-left: 40px;
+  }
+  .pagetoc .pagetoc-H4 {
+    padding-left: 60px;
+  }
 }
 
 @media print {
-    .sidetoc {
-        display: none;
-    }
+  .sidetoc {
+    display: none;
+  }
 }