android/SukiSU-Ultra
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: update documentation for the website (#1750)

Browse Source 
Description:

I was originally browsing through project's FAQ on the
[website](https://kernelsu.org/) and noticed a few discrepancies across
the text.<br>I edited them out, and once having finished with the FAQ, I
looked through other website pages as well.

Changes:

- updated documentation for the project's website (English version).

--
P.S. I actually appreciate the partial documentation on GKI and in-depth
Android mechanisms present in it. While there is of course documentation
from Google, it is nice to have guidelines from a more practical
standpoint.
This commit is contained in:
Joseph P
2024-05-21 01:35:51 +00:00
committed by GitHub
parent 9c2e48bb3e
commit 82d965f44c
10 changed files with 144 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
website/docs/guide/how-to-build.md
View File

@@ -2,11 +2,11 @@
First, you should read the Android Official docs for kernel build:
1. [Building Kernels](https://source.android.com/docs/setup/build/building-kernels)
2. [GKI Release Builds](https://source.android.com/docs/core/architecture/kernel/gki-release-builds)
1. [Building Kernels](https://source.android.com/docs/setup/build/building-kernels).
2. [GKI Release Builds](https://source.android.com/docs/core/architecture/kernel/gki-release-builds).
::: warning
This page is for GKI devices, if you use an old kernel, please refer [how to integrate KernelSU for old kernel](how-to-integrate-for-non-gki)
This page is for GKI devices, if you use an old kernel, please refer [how to integrate KernelSU for old kernel](how-to-integrate-for-non-gki).
:::
## Build Kernel
@@ -20,13 +20,13 @@ repo init -m manifest.xml
repo sync
```
The `<kernel_manifest.xml>` is a manifest file which can determine a build uniquely, you can use the manifest to do a re-preducable build. You should download the manifest file from [Google GKI release builds](https://source.android.com/docs/core/architecture/kernel/gki-release-builds)
The `<kernel_manifest.xml>` is a manifest file which can determine a build uniquely, you can use the manifest to do a re-preducable build. You should download the manifest file from [Google GKI release builds](https://source.android.com/docs/core/architecture/kernel/gki-release-builds).
### Build
Please check the [official docs](https://source.android.com/docs/setup/build/building-kernels) first.
For example, we need to build aarch64 kernel image:
For example, to build an aarch64 kernel image:
```sh
LTO=thin BUILD_CONFIG=common/build.config.gki.aarch64 build/build.sh
@@ -41,7 +41,7 @@ tools/bazel build --config=fast //common:kernel_aarch64_dist
```
:::info
For some Android 14 Kernel, to make Wi-Fi/Bluetooth work. It may be necessary to remove all the GKI protected exports:
For some of the Android 14 kernels, to make Wi-Fi/Bluetooth work, it might be necessary to remove all the GKI protected exports:
```sh
rm common/android/abi_gki_protected_exports_*
@@ -50,7 +50,7 @@ rm common/android/abi_gki_protected_exports_*
## Build Kernel with KernelSU
If you can build the kernel successfully, then build KernelSU is so easy, Select any one run in Kernel source root dir:
If you're able to build the kernel successfully, then adding KernelSU support to it is relatively easy. In the root of kernel source directory, run any of the command options listed below:
::: code-group