Skip to content

Commit

Permalink
docs: Add description for non gki integration
Browse files Browse the repository at this point in the history
  • Loading branch information
tiann committed Jun 1, 2024
1 parent 898e9d4 commit 1f24daa
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 13 deletions.
6 changes: 5 additions & 1 deletion website/docs/guide/how-to-integrate-for-non-gki.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,13 @@ KernelSU uses kprobe to do kernel hooks, if the *kprobe* runs well in your kerne
First, add KernelSU to your kernel source tree:

```sh
curl -LSs "https://github.com/tiann/KernelSU/main/kernel/setup.sh" | bash -
curl -LSs "https://github.com/tiann/KernelSU/main/kernel/setup.sh" | bash -s v0.9.5
```

:::info
[KernelSU 1.0 no longer supports non-GKI kernels](https://github.com/tiann/KernelSU/issues/1705). The last supported version is `v0.9.5`, please make sure to use the correct branch.
:::

Then, you should check if *kprobe* is enabled in your kernel config, if it is not, please add these configs to it:

```txt
Expand Down
16 changes: 4 additions & 12 deletions website/docs/zh_CN/guide/how-to-integrate-for-non-gki.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,12 @@ KernelSU 使用 kprobe 机制来做内核的相关 hook,如果 *kprobe* 可以

首先,把 KernelSU 添加到你的内核源码树,在内核的根目录执行以下命令:

::: code-group

```sh[最新tag(稳定版本)]
curl -LSs "https://github.com/tiann/KernelSU/main/kernel/setup.sh" | bash -
```

```sh[main分支(开发版本)]
curl -LSs "https://github.com/tiann/KernelSU/main/kernel/setup.sh" | bash -s main
```

```sh[指定tag(比如v0.5.2)]
curl -LSs "https://github.com/tiann/KernelSU/main/kernel/setup.sh" | bash -s v0.5.2
```sh
curl -LSs "https://github.com/tiann/KernelSU/main/kernel/setup.sh" | bash -s v0.9.5
```

:::info
[KernelSU 1.0 已经不再支持非 GKI 内核](https://github.com/tiann/KernelSU/issues/1705),最后的支持版本为 `v0.9.5`,请注意使用正确的分支。
:::

然后,你需要检查你的内核是否开启了 *kprobe* 相关的配置,如果没有开启,需要添加以下配置:
Expand Down

0 comments on commit 1f24daa

Please sign in to comment.