Przeglądaj źródła

style: replace em dash with hyphen

Signed-off-by: Ahmed Al-Nassif <mr.ahmed.nassif@gmail.com>
Ahmed Al-Nassif 1 tydzień temu
rodzic
commit
9f6bd30dd9

+ 2 - 2
.github/actions/btf/action.yml

@@ -172,7 +172,7 @@ runs:
       uses: ./.github/actions/set-kernel-config
       with:
         config_list: |
-          # eBPF support (Issue #176)  tiny safe programs that run in the kernel
+          # eBPF support (Issue #176) - tiny safe programs that run in the kernel
           # to trace/control events. Requires BTF above for CO-RE to work.
           CONFIG_BPF_EVENTS=y
           CONFIG_KPROBE_EVENTS=y
@@ -183,7 +183,7 @@ runs:
       uses: ./.github/actions/set-kernel-config
       with:
         config_list: |
-          # FUSE-BPF support (Issue #211)  FUSE filesystems backed by eBPF
+          # FUSE-BPF support (Issue #211) - FUSE filesystems backed by eBPF
           # programs. Sits on eBPF (Issue #176) above. Explicitly set the
           # kconfig dependencies (FUSE_FS, BPF via BPF_SYSCALL) so kconfig can't
           # silently drop FUSE_BPF on any branch whose gki_defconfig differs.

+ 1 - 1
.github/actions/susfs-patches/action.yml

@@ -165,7 +165,7 @@ runs:
 
         # Fix set_nameidata() calls for 5.10 kernels.
         # The SUSFS patch adds set_nameidata(nd, old_dfd, fake_filename, NULL) with 4 args,
-        # but 5.10 kernels only have 3-param set_nameidata(p, dfd, name)  no root param.
+        # but 5.10 kernels only have 3-param set_nameidata(p, dfd, name) - no root param.
         #if [[ "${{ inputs.version }}" == "android12-5.10" || "${{ inputs.version }}" == "android13-5.10" ]]; then
         #  if grep -q 'set_nameidata(nd, old_dfd, fake_filename, NULL)' fs/namei.c; then
         #   echo "Fixing set_nameidata calls for 5.10 (4-arg -> 3-arg)"

+ 1 - 1
.github/workflows/build.yml

@@ -566,7 +566,7 @@ jobs:
         WARNINGS="N/A"
         
         {
-          echo "## ${{ inputs.android_version }} ${{ inputs.kernel_version }}.${{ inputs.sublevel }} (${{ inputs.variant }})  ${STATUS}"
+          echo "## ${{ inputs.android_version }} ${{ inputs.kernel_version }}.${{ inputs.sublevel }} (${{ inputs.variant }}) - ${STATUS}"
           echo
           echo "| Metric | Value |"
           echo "|--------|-------|"

+ 4 - 4
.github/workflows/main.yml

@@ -238,7 +238,7 @@ jobs:
           # NoMount (pinned in verified mode, else dev tip)
           emit nomount_commit "$(pick "$PIN_NOMOUNT" https://github.com/maxsteeel/nomount.git refs/heads/dev)"
 
-          # KernelSU-Next manager  always built from the official repo's dev branch.
+          # KernelSU-Next manager - always built from the official repo's dev branch.
           # pershoot's fork is used only for the kernel SUSFS integration (root_commit below),
           # never for the manager. Manager always builds at latest.
           emit kernelsu_commit "$(resolve_sha https://github.com/KernelSU-Next/KernelSU-Next.git refs/heads/dev)"
@@ -1099,7 +1099,7 @@ jobs:
         STOCK_COMMIT=$(git merge-base HEAD FETCH_HEAD)
         echo "KSU Stock Commit (official sync point): $STOCK_COMMIT"
 
-        # Extract version info  anchored to the official sync point
+        # Extract version info - anchored to the official sync point
         # (STOCK_COMMIT), i.e. the commit the linked manager is built from.
         # Mirrors pershoot c0a2c5fd: count the merge-base with origin, not
         # the fork's extra commits, so the version shown in the release
@@ -1217,7 +1217,7 @@ jobs:
             parts.append(f"- **Branch:** `{branch}`")
             parts.append(f"- **Commit:** `{commit}`")
             if manager_url:
-                note = f"  {manager_note}" if manager_note else ""
+                note = f" - {manager_note}" if manager_note else ""
                 base = manager_url.split("/actions/")[0]
                 parts.append(f"- **Manager:** [{base}]({manager_url}){note}")
             parts.append("")
@@ -1491,7 +1491,7 @@ jobs:
               parts.append(f"- **Branch:** `{branch}`")
               parts.append(f"- **Commit:** `{commit}`")
               if manager_url:
-                  note = f"  {manager_note}" if manager_note else ""
+                  note = f" - {manager_note}" if manager_note else ""
                   base = manager_url.split("/actions/")[0]
                   parts.append(f"- **Manager:** [{base}]({manager_url}){note}")
               parts.append("")

+ 12 - 12
README.md

@@ -34,17 +34,17 @@ By flashing this kernel, **YOU** are choosing to make these modifications. If so
 
 ## Features
 
-- [KernelSU-Next](docs/kernelsu-next.md) / [KernelSU (Classic)](docs/kernelsu-classic.md) / [ReSukiSU](docs/resukisu.md)  root implementations
-- [SUSFS](docs/susfs.md)  root hiding
-- [NoMount](docs/nomount.md)  mount metamodule (root hiding)
-- [Baseband Guard](docs/bbg.md)  partition protection
-- [Networking](docs/networking.md)  WireGuard, BBR, IPSet, CIFS
-- [TMPFS](docs/tmpfs.md)  xattr / POSIX ACLs
-- [BPF](docs/bpf.md)  BTF / eBPF / FUSE-BPF
-- [Ptrace Leak Fix](docs/ptrace.md)  internal to root hiding
-- [Unicode Fix](docs/unicode.md)  internal to root hiding (experimental)
-- [Performance](docs/performance.md)  incl. [NTSync](docs/ntsync.md)
-- [DroidSpaces](docs/droidspaces.md)  container runtime
+- [KernelSU-Next](docs/kernelsu-next.md) / [KernelSU (Classic)](docs/kernelsu-classic.md) / [ReSukiSU](docs/resukisu.md) - root implementations
+- [SUSFS](docs/susfs.md) - root hiding
+- [NoMount](docs/nomount.md) - mount metamodule (root hiding)
+- [Baseband Guard](docs/bbg.md) - partition protection
+- [Networking](docs/networking.md) - WireGuard, BBR, IPSet, CIFS
+- [TMPFS](docs/tmpfs.md) - xattr / POSIX ACLs
+- [BPF](docs/bpf.md) - BTF / eBPF / FUSE-BPF
+- [Ptrace Leak Fix](docs/ptrace.md) - internal to root hiding
+- [Unicode Fix](docs/unicode.md) - internal to root hiding (experimental)
+- [Performance](docs/performance.md) - incl. [NTSync](docs/ntsync.md)
+- [DroidSpaces](docs/droidspaces.md) - container runtime
 
 Full documentation: [docs/index.md](docs/index.md)
 
@@ -52,7 +52,7 @@ Full documentation: [docs/index.md](docs/index.md)
 
 ## Installation
 
-See **[Installation Guide](docs/installation.md)**  [Kernel Flasher](docs/kernelflasher.md) · [Patch boot.img with magiskboot](docs/magiskboot.md).
+See **[Installation Guide](docs/installation.md)** - [Kernel Flasher](docs/kernelflasher.md) · [Patch boot.img with magiskboot](docs/magiskboot.md).
 
 ---
 

+ 1 - 1
docs/bbg.md

@@ -16,4 +16,4 @@ When `use_bbg` is enabled in the build workflow, BBG is included in the kernel b
 
 ## Related
 
-- [index.md](../index.md)  full feature index
+- [index.md](../index.md) - full feature index

+ 1 - 1
docs/bpf.md

@@ -20,4 +20,4 @@ These options are enabled via kernel configuration and are included when the `us
 
 ## Related
 
-- [index.md](../index.md)  full feature index
+- [index.md](../index.md) - full feature index

+ 1 - 1
docs/droidspaces.md

@@ -16,4 +16,4 @@ DroidSpaces-OSS patches are applied during the build workflow when `use_ds` is e
 
 ## Related
 
-- [index.md](../index.md)  full feature index
+- [index.md](../index.md) - full feature index

+ 3 - 3
docs/index.md

@@ -1,4 +1,4 @@
-# Kernel Features  Documentation Index
+# Kernel Features - Documentation Index
 
 Per-feature documentation for the GKI2 kernels built from this repository.
 
@@ -64,6 +64,6 @@ Per-feature documentation for the GKI2 kernels built from this repository.
 
 ---
 
-**Installation**  see [Installation Guide](installation.md) ([Kernel Flasher](kernelflasher.md) · [Patch boot.img with magiskboot](magiskboot.md)).
+**Installation** - see [Installation Guide](installation.md) ([Kernel Flasher](kernelflasher.md) · [Patch boot.img with magiskboot](magiskboot.md)).
 
-**Release Notes**  for build-specific version/commit info, see the [release workflow](https://github.com/WildKernels/GKI_KernelSU_SUSFS/actions/workflows/main.yml) or the releases page.
+**Release Notes** - for build-specific version/commit info, see the [release workflow](https://github.com/WildKernels/GKI_KernelSU_SUSFS/actions/workflows/main.yml) or the releases page.

+ 2 - 2
docs/installation.md

@@ -14,8 +14,8 @@ Choose the method that fits your situation:
 
 Each release artifact is named by **KMI** and **SPL**:
 
-- **KMI**  `android12-5.10`, `android13-5.10`, `android13-5.15`, `android14-5.15`, `android14-6.1`, `android15-6.6`, `android16-6.12`. Must match `uname -r`.
-- **SPL**  monthly security patch level. Pick the build closest to your current SPL.
+- **KMI** - `android12-5.10`, `android13-5.10`, `android13-5.15`, `android14-5.15`, `android14-6.1`, `android15-6.6`, `android16-6.12`. Must match `uname -r`.
+- **SPL** - monthly security patch level. Pick the build closest to your current SPL.
 
 If you don't know which file to download, read the KMI/SPL description in the release notes.
 

+ 7 - 7
docs/kernelflasher.md

@@ -16,8 +16,8 @@
 
 Each release artifact is named by **KMI (Kernel Module Interface)** and **Security Patch Level (SPL)**.
 
-- **KMI**  e.g. `android12-5.10`, `android13-5.10`, `android13-5.15`, `android14-5.15`, `android14-6.1`, `android15-6.6`, `android16-6.12`. Must match your device's current kernel version. Check with `uname -r` or in Settings → About phone → Kernel version.
-- **SPL**  monthly security patch string in the filename. Pick the build closest to your current SPL; newer SPL is generally backwards compatible but read the release notes for breaking changes.
+- **KMI** - e.g. `android12-5.10`, `android13-5.10`, `android13-5.15`, `android14-5.15`, `android14-6.1`, `android15-6.6`, `android16-6.12`. Must match your device's current kernel version. Check with `uname -r` or in Settings → About phone → Kernel version.
+- **SPL** - monthly security patch string in the filename. Pick the build closest to your current SPL; newer SPL is generally backwards compatible but read the release notes for breaking changes.
 
 If you don't know which file to download, carefully read the description of KMI and Security patch level in the release notes before downloading.
 
@@ -32,8 +32,8 @@ This requires the flashing app to have root permissions. On first install from s
 
 ## Supported flashing apps
 
-- [Kernel Flasher](https://github.com/fatalcoder524/KernelFlasher)  recommended, actively maintained
-- [PixelFlasher](https://github.com/badabing2005/PixelFlasher)  alternative with advanced options
+- [Kernel Flasher](https://github.com/fatalcoder524/KernelFlasher) - recommended, actively maintained
+- [PixelFlasher](https://github.com/badabing2005/PixelFlasher) - alternative with advanced options
 
 Both require root to flash a kernel from within Android.
 
@@ -45,9 +45,9 @@ Both require root to flash a kernel from within Android.
 
 ## Troubleshooting
 
-- **Bootloop**  restore your boot backup via fastboot/recovery.
-- **Wrong KMI**  re-flash with the correct KMI variant; KMI mismatch is the most common failure.
-- **Manager shows old version**  ensure you flashed the intended variant and rebooted fully.
+- **Bootloop** - restore your boot backup via fastboot/recovery.
+- **Wrong KMI** - re-flash with the correct KMI variant; KMI mismatch is the most common failure.
+- **Manager shows old version** - ensure you flashed the intended variant and rebooted fully.
 
 ---
 

+ 4 - 4
docs/kernelsu-classic.md

@@ -21,7 +21,7 @@ The KernelSU manager APK is built from `tiann/KernelSU`. The manager version sho
 
 ## Related
 
-- [kernelsu-next.md](kernelsu-next.md)  KernelSU-Next
-- [resukisu.md](resukisu.md)  ReSukiSU
-- [susfs.md](susfs.md)  root hiding add-on
-- [index.md](../index.md)  full feature index
+- [kernelsu-next.md](kernelsu-next.md) - KernelSU-Next
+- [resukisu.md](resukisu.md) - ReSukiSU
+- [susfs.md](susfs.md) - root hiding add-on
+- [index.md](../index.md) - full feature index

+ 4 - 4
docs/kernelsu-next.md

@@ -20,7 +20,7 @@ The KernelSU-Next manager APK is built from the official `KernelSU-Next/KernelSU
 
 ## Related
 
-- [kernelsu-classic.md](kernelsu-classic.md)  classic KernelSU
-- [resukisu.md](resukisu.md)  ReSukiSU
-- [susfs.md](susfs.md)  root hiding add-on
-- [index.md](../index.md)  full feature index
+- [kernelsu-classic.md](kernelsu-classic.md) - classic KernelSU
+- [resukisu.md](resukisu.md) - ReSukiSU
+- [susfs.md](susfs.md) - root hiding add-on
+- [index.md](../index.md) - full feature index

+ 4 - 4
docs/magiskboot.md

@@ -4,8 +4,8 @@ For some devices, the `boot.img` format isn't as common as `lz4`, `gz`, and unco
 
 > [!TIP]
 > It's always recommended to use `magiskboot` to patch images. There are two ways:
-> - [magiskboot (official)](https://github.com/topjohnwu/Magisk/releases)  runs on Android devices (and Linux)
-> - [magiskboot_build](https://github.com/capntrips/magiskboot_build)  cross-built binaries for Windows/macOS/Linux PCs
+> - [magiskboot (official)](https://github.com/topjohnwu/Magisk/releases) - runs on Android devices (and Linux)
+> - [magiskboot_build](https://github.com/capntrips/magiskboot_build) - cross-built binaries for Windows/macOS/Linux PCs
 >
 > The official build of `magiskboot` can only run on Android devices. If you want to run it on a PC, use the second option.
 
@@ -41,7 +41,7 @@ For some devices, the `boot.img` format isn't as common as `lz4`, `gz`, and unco
    ```sh
    ./magiskboot unpack boot.img
    ```
-   You will get a `kernel` file  this is your stock kernel.
+   You will get a `kernel` file - this is your stock kernel.
 7. Replace kernel with the KernelSU Image:
    ```sh
    mv -f Image kernel
@@ -67,7 +67,7 @@ For some devices, the `boot.img` format isn't as common as `lz4`, `gz`, and unco
    ```sh
    ./magiskboot unpack boot.img
    ```
-   You will get a `kernel` file  this is your stock kernel.
+   You will get a `kernel` file - this is your stock kernel.
 5. Replace kernel:
    ```sh
    mv -f Image kernel

+ 10 - 10
docs/networking.md

@@ -15,27 +15,27 @@ This kernel includes a range of networking features and improvements, covering c
 
 ## VPN Support
 
-- **WireGuard**  Built-in VPN support via the WireGuard kernel module.
+- **WireGuard** - Built-in VPN support via the WireGuard kernel module.
 
 ## Firewall & NAT
 
-- **IP Set**  Advanced firewall capabilities via ip_set.
-- **IPv6 NAT**  NAT support for IPv6.
-- **TTL Target**  Network packet manipulation via TTL targeting.
+- **IP Set** - Advanced firewall capabilities via ip_set.
+- **IPv6 NAT** - NAT support for IPv6.
+- **TTL Target** - Network packet manipulation via TTL targeting.
 
 ## Traffic Shaping & Fair Queuing
 
-- **CAKE**  Common Applications Kept Enhanced; a full-featured queue discipline.
-- **fq**  Fair Queue packet scheduler.
-- **fq_codel**  Fair Queuing with Controlled Delay.
+- **CAKE** - Common Applications Kept Enhanced; a full-featured queue discipline.
+- **fq** - Fair Queue packet scheduler.
+- **fq_codel** - Fair Queuing with Controlled Delay.
 
 ## Connection Marking
 
-- **connmark**  Connection marking for packet classification.
+- **connmark** - Connection marking for packet classification.
 
 ## Filesystem Support
 
-- **CIFS**  Network filesystem support for SMB/CIFS sharing.
+- **CIFS** - Network filesystem support for SMB/CIFS sharing.
 
 ## Build Integration
 
@@ -43,4 +43,4 @@ Most networking features are upstream kernel configurations enabled in the kerne
 
 ## Related
 
-- [index.md](../index.md)  full feature index
+- [index.md](../index.md) - full feature index

+ 2 - 2
docs/nomount.md

@@ -22,5 +22,5 @@ The kernel and metamodule revisions must match exactly. The NoMount integration
 
 ## Related
 
-- [kernelsu.md](kernelsu.md)  root implementation
-- [index.md](../index.md)  full feature index
+- [kernelsu.md](kernelsu.md) - root implementation
+- [index.md](../index.md) - full feature index

+ 2 - 2
docs/ntsync.md

@@ -18,5 +18,5 @@ NTSync is enabled via the `use_ntsync` feature flag in the build workflow. It is
 
 ## Related
 
-- [performance.md](performance.md)  performance category
-- [index.md](index.md)  full feature index
+- [performance.md](performance.md) - performance category
+- [index.md](index.md) - full feature index

+ 2 - 2
docs/performance.md

@@ -15,5 +15,5 @@ Performance-related features are enabled via the `use_perf` feature flag in the
 
 ## Related
 
-- [ntsync.md](ntsync.md)  NTSync details
-- [index.md](index.md)  full feature index
+- [ntsync.md](ntsync.md) - NTSync details
+- [index.md](index.md) - full feature index

+ 3 - 3
docs/ptrace.md

@@ -10,7 +10,7 @@ Fixes ptrace info leak on kernels older than 5.16. Internal to root hiding.
 
 On kernels older than 5.16, a ptrace-related information leak may be present. This fix patches the kernel to close that leak, improving security for systems using ptrace.
 
-It is documented as internal to root hiding (SUSFS/KernelSU)  not a standalone top-level feature.
+It is documented as internal to root hiding (SUSFS/KernelSU) - not a standalone top-level feature.
 
 ## Build Integration
 
@@ -18,5 +18,5 @@ The ptrace leak fix is applied as a patch during the build workflow when `use_pt
 
 ## Related
 
-- [susfs.md](susfs.md)  root hiding
-- [index.md](index.md)  full feature index
+- [susfs.md](susfs.md) - root hiding
+- [index.md](index.md) - full feature index

+ 4 - 4
docs/resukisu.md

@@ -21,7 +21,7 @@ The ReSukiSU manager APK is built from `ReSukiSU/ReSukiSU`. The manager version
 
 ## Related
 
-- [kernelsu-next.md](kernelsu-next.md)  KernelSU-Next
-- [kernelsu-classic.md](kernelsu-classic.md)  classic KernelSU
-- [susfs.md](susfs.md)  root hiding add-on
-- [index.md](../index.md)  full feature index
+- [kernelsu-next.md](kernelsu-next.md) - KernelSU-Next
+- [kernelsu-classic.md](kernelsu-classic.md) - classic KernelSU
+- [susfs.md](susfs.md) - root hiding add-on
+- [index.md](../index.md) - full feature index

+ 2 - 2
docs/susfs.md

@@ -22,7 +22,7 @@ SUSFS provides multiple root-hiding and spoofing capabilities:
 | `SPOOF_CMDLINE_OR_BOOTCONFIG` | Spoof `/proc/bootconfig` (GKI) or `/proc/cmdline` (non-GKI) output with a user-defined file. Effective on all processes. |
 | `OPEN_REDIRECT` | Redirect a target path to be opened with another user-defined path. Both paths must exist before they can be added. Requires SELinux permissions for both paths. Effective only on processes with a pre-defined UID scheme. |
 | `SUS_MAP` | Hide mmapped real files from `/proc/<pid>/[maps|smaps|smaps_rollup|map_files|mem|pagemap]`. No anonymous-memory support; does not hide inline/PLT hooks caused by the injected library itself. May not evade strong injection detection. Effective only on zygote-spawned unmounted user app processes with `uid >= 10000`. |
-| `AVC_SPOOF` | Spoof procfs AVC denial logs. Enabled at runtime via the sidex15 module  not a build-time Kconfig option. |
+| `AVC_SPOOF` | Spoof procfs AVC denial logs. Enabled at runtime via the sidex15 module - not a build-time Kconfig option. |
 
 ## Build Integration
 
@@ -32,4 +32,4 @@ SUSFS is always built at the latest branch tip when the root flavor is KernelSU-
 
 ## Related
 
-- [index.md](../index.md)  full feature index
+- [index.md](../index.md) - full feature index

+ 1 - 1
docs/tmpfs.md

@@ -16,4 +16,4 @@ Both features are enabled via kernel configuration options (`CONFIG_TMPFS_XATTR`
 
 ## Related
 
-- [index.md](../index.md)  full feature index
+- [index.md](../index.md) - full feature index

+ 4 - 4
docs/unicode.md

@@ -10,11 +10,11 @@ Prevents path traversal via non-printable Unicode (experimental). Internal to ro
 
 Certain path traversal attacks and detection-evasion techniques can use non-printable Unicode codepoints. The Unicode Fix patches the kernel to mitigate these vectors.
 
-It is documented as internal to root hiding (SUSFS/KernelSU)  not a standalone top-level feature.
+It is documented as internal to root hiding (SUSFS/KernelSU) - not a standalone top-level feature.
 
 ## Status
 
-**Experimental**  use at your own risk.
+**Experimental** - use at your own risk.
 
 ## Build Integration
 
@@ -22,5 +22,5 @@ The Unicode Fix is applied as a patch during the build workflow when `use_unicod
 
 ## Related
 
-- [susfs.md](susfs.md)  root hiding
-- [index.md](index.md)  full feature index
+- [susfs.md](susfs.md) - root hiding
+- [index.md](index.md) - full feature index