docs: updated to reflect changes to support for non-GKI devices.

- Adjusted branch usage instructions and KPM support information
2025-05-15 22:55:18 +08:00
parent d753e1dc48
commit f708e583c3
3 changed files with 104 additions and 34 deletions
--- a/docs/README-en.md
+++ b/docs/README-en.md
@@ -10,32 +10,53 @@ Android device root solution based on [KernelSU](https://github.com/tiann/Kernel
 >
 > However, we will be a separately maintained branch of KSU in the future

- Fully adapted for non-GKI devices (susfs-dev and unsusfs-patched dev branches only)
-
 ## How to add

-Use the susfs-stable or susfs-dev branch (integrated susfs with support for non-GKI devices)
-```
-curl -LSs "https://raw.githubusercontent.com/ShirkNeko/SukiSU-Ultra/main/kernel/setup.sh" | bash -s susfs-dev
-```
-
-Use the main branch
+Using main branching (non-GKI device builds are not supported)
 ```
 curl -LSs "https://raw.githubusercontent.com/ShirkNeko/KernelSU/main/kernel/setup.sh" | bash -s main
 ```

+Using branches that support non-GKI devices
+```
+curl -LSs "https://raw.githubusercontent.com/ShirkNeko/SukiSU-Ultra/main/kernel/setup.sh" | bash -s nongki
+```
+
 ## How to use integrated susfs

 1. Use the susfs-dev branch directly without any patching

-## KPM support
+```
+curl -LSs "https://raw.githubusercontent.com/ShirkNeko/SukiSU-Ultra/main/kernel/setup.sh" | bash -s susfs-dev
+```

- We have removed duplicate KSU functions based on KernelPatch and retained KPM support.
+## KPM Support
+
+- Based on KernelPatch, we have removed duplicates of KSU and kept only KPM support.
 - We will introduce more APatch-compatible functions to ensure the integrity of KPM functionality.

-Open source address: https://github.com/ShirkNeko/SukiSU_KernelPatch_patch
+We will introduce more APatch-compatible functions to ensure the completeness of KPM functionality.
+
+KPM templates: https://github.com/udochina/KPM-Build-Anywhere
+
+> [!Note]
+> 1. `CONFIG_KPM=y` needs to be added.
+> 2. Non-GKI devices need to add `CONFIG_KALLSYMS=y` and `CONFIG_KALLSYMS_ALL=y` as well.
+> 3. Some kernel source code below `4.19` also needs to be backport from `4.19` to the header file `set_memory.h`.
+
+## How to do a system update to retain ROOT
+- After OTA, don't reboot first, go to the manager flashing/patching kernel interface, find `GKI/non_GKI install` and select the Anykernel3 kernel zip file that needs to be flashed, select the slot that is opposite to the current running slot of the system for flashing, and then reboot to retain the GKI mode update （This method is not supported for all non-GKI devices, so please try it yourself. It is the safest way to use TWRP for non-GKI devices.）
+- Or use LKM mode to install to the unused slot (after OTA).
+
+## Compatibility Status
+- KernelSU (versions prior to v1.0.0) officially supports Android GKI 2.0 devices (kernel 5.10+)
+
+- Older kernels (4.4+) are also compatible, but the kernel must be built manually
+
+- KernelSU can support 3.x kernels (3.4-3.18) through additional reverse ports
+
+- Currently supports `arm64-v8a`, `armeabi-v7a (bare)` and some `X86_64`

-KPM template address: https://github.com/udochina/KPM-Build-Anywhere

 ## More links

@@ -59,11 +80,14 @@ Projects compiled based on Sukisu and susfs

 ## Usage

-### GKI
+### Universal GKI

-Please follow this guide.
+Please **all** refer to https://kernelsu.org/zh_CN/guide/installation.html

-https://kernelsu.org/guide/installation.html
+> [!Note]
+> 1. for devices with GKI 2.0 such as Xiaomi, Redmi, Samsung, etc. (excludes kernel-modified manufacturers such as Meizu, OnePlus, Zenith, and oppo)
+> 2. Find the GKI build in [more links](#%E6%9B%B4%E5%A4%9A%E9%93%BE%E6%8E%A5). Find the device kernel version. Then download it and use TWRP or kernel flashing tool to flash the zip file with AnyKernel3 suffix.
+> 3. The .zip archive without suffix is uncompressed, the gz suffix is the compression used by Tenguet models.


 ### OnePlus
@@ -109,4 +133,4 @@ If the above list does not have your name, I will update it as soon as possible,
 - [Magisk](https://github.com/topjohnwu/Magisk): Powerful root utility
 - [genuine](https://github.com/brevent/genuine/): APK v2 Signature Verification
 - [Diamorphine](https://github.com/m0nad/Diamorphine): Some rootkit utilities.
- [KernelPatch](https://github.com/bmax121/KernelPatch): KernelPatch is a key part of the APatch implementation of the kernel module
+- [KernelPatch](https://github.com/bmax121/KernelPatch): KernelPatch is a key part of the APatch implementation of the kernel module
--- a/docs/README-ja.md
+++ b/docs/README-ja.md
@@ -11,22 +11,24 @@
 >
 > ただし、将来的には KSU とは別に管理されるブランチとなる予定です。

- GKI 非対応なデバイスに完全に適応 (susfs-dev と unsusfs-patched dev ブランチのみ)
-
 ## 追加方法

-susfs-stable または susfs-dev ブランチ (GKI 非対応デバイスに対応する統合された susfs) 使用してください。
-```
-curl -LSs "https://raw.githubusercontent.com/ShirkNeko/SukiSU-Ultra/main/kernel/setup.sh" | bash -s susfs-dev
-```
-
-メインブランチを使用する場合
+メイン分岐の使用（GKI デバイス以外のビルドはサポートされていません。）
 ```
 curl -LSs "https://raw.githubusercontent.com/ShirkNeko/KernelSU/main/kernel/setup.sh" | bash -s main
 ```
+
+GKI以外のデバイスをサポートするブランチを使用する
+```
+curl -LSs "https://raw.githubusercontent.com/ShirkNeko/SukiSU-Ultra/main/kernel/setup.sh" | bash -s nongki
+```
+
 ## 統合された susfs の使い方

 1. パッチを当てずに susfs-dev ブランチを直接使用してください。
+```
+curl -LSs "https://raw.githubusercontent.com/ShirkNeko/SukiSU-Ultra/main/kernel/setup.sh" | bash -s susfs-dev
+```

 ## KPM に対応

@@ -37,6 +39,25 @@ curl -LSs "https://raw.githubusercontent.com/ShirkNeko/KernelSU/main/kernel/setu

 KPM テンプレートのアドレス: https://github.com/udochina/KPM-Build-Anywhere

+> [!Note]
+> 1. `CONFIG_KPM=y` が必要である。
+> 2.非 GKI デバイスには `CONFIG_KALLSYMS=y` と `CONFIG_KALLSYMS_ALL=y` も必要です。
+> 3.いくつかのカーネル `4.19` およびそれ以降のソースコードでは、 `4.19` からバックポートされた `set_memory.h` ヘッダーファイルも必要です。
+
+
+## ROOT を保持するシステムアップデートの方法
+- OTAの後、最初に再起動せず、マネージャのフラッシュ/パッチカーネルインターフェイスに移動し、`GKI/non_GKI 取り付け`を見つけ、フラッシュする必要があるAnykernel3カーネルzipファイルを選択し、フラッシュするためにシステムの現在の実行スロットと反対のスロットを選択し、GKIモードアップデートを保持するために再起動します（この方法は、現時点ではすべてのnon_GKIデバイスでサポートされていませんので、各自でお試しください。 (この方法は、すべての非GKIデバイスでサポートされていませんので、ご自身でお試しください)。
+- または、LKMモードを使用して未使用のスロットにインストールします(OTA後)。
+
+## 互換性ステータス
+- KernelSU（v1.0.0より前のバージョン）はAndroid GKI 2.0デバイス（カーネル5.10以上）を公式にサポートしています。
+
+- 古いカーネル（4.4+）も互換性がありますが、カーネルは手動でビルドする必要があります。
+
+- KernelSU は追加のリバースポートを通じて 3.x カーネル (3.4-3.18) をサポートしています。
+
+- 現在は `arm64-v8a`、`armeabi-v7a (bare)`、いくつかの `X86_64` をサポートしています。
+
 ## その他のリンク

 SukiSU と susfs をベースにコンパイルされたプロジェクトです。
@@ -61,12 +82,14 @@ SukiSU と susfs をベースにコンパイルされたプロジェクトです

 ## 使い方

-### GKI
+### ユニバーサルGKI

-このガイドに従ってください。
-
-https://kernelsu.org/ja_JP/guide/installation.html
+https://kernelsu.org/zh_CN/guide/installation.html をご参照ください。

+> [!Note]
+> 1.Xiaomi、Redmi、Samsung などの GKI 2.0 を搭載したデバイス用 (Meizu、Yiga、Zenith、oppo などのマジックカーネルを搭載したメーカーは除く)。
+> 2. [more links](#%E6%9B%B4%E5%A4%9A%E9%93%BE%E6%8E%A5) で GKI ビルドを検索します。 デバイスのカーネルバージョンを検索します。 次に、それをダウンロードし、TWRPまたはカーネルフラッシングツールを使用して、AnyKernel3の接尾辞が付いたzipファイルをフラッシュします。
+> 接尾辞なしの.zipアーカイブは非圧縮で、接尾辞gzはTenguetモデルで使用されている圧縮方法です。
 ### OnePlus

 1. `その他のリンク`の項目に記載されているリンクを開き、デバイス情報を使用してカスタマイズされたカーネルをビルドし、AnyKernel3 の接頭辞を持つ .zip ファイルをフラッシュします。
--- a/docs/README.md
+++ b/docs/README.md
@@ -14,20 +14,24 @@

 在内核源码的根目录下执行以下命令：

-使用 susfs-dev 分支（已集成 susfs，带非 GKI 设备的支持）
-```
-curl -LSs "https://raw.githubusercontent.com/ShirkNeko/SukiSU-Ultra/main/kernel/setup.sh" | bash -s susfs-dev
-```
-
-使用 main 分支
+使用 main 分支 (不支持非GKI设备构建)
 ```
 curl -LSs "https://raw.githubusercontent.com/ShirkNeko/SukiSU-Ultra/main/kernel/setup.sh" | bash -s main
 ```

+使用支持非 GKI 设备的分支
+```
+curl -LSs "https://raw.githubusercontent.com/ShirkNeko/SukiSU-Ultra/main/kernel/setup.sh" | bash -s nongki
+```
+
 ## 如何集成 susfs

 1. 直接使用 susfs-stable 或者 susfs-dev 分支，不需要再集成 susfs

+```
+curl -LSs "https://raw.githubusercontent.com/ShirkNeko/SukiSU-Ultra/main/kernel/setup.sh" | bash -s susfs-dev
+```
+
 ## 钩子方法

 - 此部分引用自 [rsuntk 的钩子方法](https://github.com/rsuntk/KernelSU)
@@ -52,6 +56,25 @@ curl -LSs "https://raw.githubusercontent.com/ShirkNeko/SukiSU-Ultra/main/kernel/

 KPM 模板地址: https://github.com/udochina/KPM-Build-Anywhere

+> [!Note]
+> 1. 需要 `CONFIG_KPM=y`
+> 2. 非GKI设备还需要 `CONFIG_KALLSYMS=y` 和 `CONFIG_KALLSYMS_ALL=y`
+> 3. 部分内核 `4.19` 以下源码还需要从 `4.19` 向后移植头文件 `set_memory.h`
+
+
+## 如何进行系统更新保留ROOT
+- OTA后先不要重启，进入管理器刷写/修补内核界面，找到 `GKI/non_GKI安装` 选择需要刷写的Anykernel3内核压缩文件，选择与现在系统运行槽位相反的槽位进行刷写并重启即可保留GKI模式更新（暂不支持所有非GKI设备使用这种方法，请自行尝试。非GKI设备使用TWRP刷写是最稳妥的）
+- 或者使用LKM模式的安装到未使用的槽位（OTA后）
+
+## 兼容状态
+- KernelSU（v1.0.0 之前版本）正式支持 Android GKI 2.0 设备（内核 5.10+）
+
+- 旧内核（4.4+）也兼容，但必须手动构建内核
+
+- 通过更多的反向移植，KernelSU 可以支持 3.x 内核（3.4-3.18）
+
+- 目前支持 `arm64-v8a` ，`armeabi-v7a (bare)` 和部分 `X86_64`
+
 ## 更多链接

 基于 SukiSU 和 susfs 编译的项目