Просмотр исходного кода

docs: move NTSync into Performance category

TheWildJames 2 недель назад
Родитель
Сommit
a36784a7cc
4 измененных файлов с 18 добавлено и 15 удалено
  1. 1 2
      README.md
  2. 1 6
      docs/index.md
  3. 8 3
      docs/ntsync.md
  4. 8 4
      docs/performance.md

+ 1 - 2
README.md

@@ -39,12 +39,11 @@ By flashing this kernel, **YOU** are choosing to make these modifications. If so
 - [NoMount](docs/nomount.md) — mount metamodule (root hiding)
 - [Baseband Guard](docs/bbg.md) — partition protection
 - [Networking](docs/networking.md) — WireGuard, BBR, IPSet, CIFS
-- [NTSync](docs/ntsync.md) — NT sync primitives
 - [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)
+- [Performance](docs/performance.md) — incl. [NTSync](docs/ntsync.md)
 - [DroidSpaces](docs/droidspaces.md) — container runtime
 
 Full documentation: [docs/index.md](docs/index.md)

+ 1 - 6
docs/index.md

@@ -25,12 +25,6 @@ Per-feature documentation for the GKI2 kernels built from this repository.
 |---------|-------------|--------|
 | Baseband Guard | Lightweight LSM blocking unauthorized writes to critical partitions and device nodes. | [vc-teahouse/Baseband-guard](https://github.com/vc-teahouse/Baseband-guard) |
 
-## Kernel Modules & Compatibility
-
-| Feature | Description | Source |
-|---------|-------------|--------|
-| NTSync | High-performance synchronization primitives compatible with Windows NT kernel API. | Internal |
-
 ## Networking
 
 | Feature | Description | Source |
@@ -59,6 +53,7 @@ Per-feature documentation for the GKI2 kernels built from this repository.
 
 | Feature | Description | Source |
 |---------|-------------|--------|
+| NTSync | High-performance synchronization primitives compatible with Windows NT kernel API. | Internal |
 | Performance Tuning | Kernel configuration and tuning options | Upstream kernel |
 
 ## Container Runtime

+ 8 - 3
docs/ntsync.md

@@ -1,17 +1,22 @@
 # NTSync
 
-NTSync provides high-performance, low-latency synchronization primitives compatible with the Windows NT kernel API.
+High-performance synchronization primitives compatible with Windows NT kernel API. Internal to performance category.
 
-It is included in builds from this repository when the corresponding feature flag is enabled.
+## Source
+
+- **Internal**
 
 ## Purpose
 
 NTSync brings Windows-compatible synchronization primitives (such as those used by NT kernel objects) to the Android kernel, which can be useful for compatibility with software expecting Windows-style synchronization behavior.
 
+It is documented as internal to the performance category.
+
 ## Build Integration
 
 NTSync is enabled via the `use_ntsync` feature flag in the build workflow. It is enabled by default.
 
 ## Related
 
-- [index.md](../index.md) — full feature index
+- [performance.md](performance.md) — performance category
+- [index.md](index.md) — full feature index

+ 8 - 4
docs/performance.md

@@ -1,15 +1,19 @@
 # Performance Tuning
 
-This kernel includes performance-related tuning and options.
+This kernel includes performance-related tuning and options, including NTSync.
 
 ## Features
 
-Performance tuning may include various kernel configuration options and optimizations aimed at improving system responsiveness and throughput.
+| Feature | Description |
+|---------|-------------|
+| NTSync | High-performance synchronization primitives compatible with Windows NT kernel API. Internal to performance category. |
+| Performance Tuning | Kernel configuration and tuning options and optimizations aimed at improving system responsiveness and throughput. |
 
 ## Build Integration
 
-Performance-related features are enabled via the `use_perf` feature flag in the build workflow. This flag is disabled by default.
+Performance-related features are enabled via the `use_perf` feature flag in the build workflow. This flag is disabled by default. NTSync is controlled separately via `use_ntsync` (enabled by default) but documented under performance.
 
 ## Related
 
-- [index.md](../index.md) — full feature index
+- [ntsync.md](ntsync.md) — NTSync details
+- [index.md](index.md) — full feature index