Add detect/README.md

taiki-e · Sep 19, 2024 · 27cdc16 · 27cdc16
1 parent c5ded94
commit 27cdc16
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 44 deletions.
diff --git a/src/imp/atomic128/README.md b/src/imp/atomic128/README.md
@@ -33,32 +33,4 @@ As 128-bit atomics-related APIs stabilize in the standard library, implementatio
 
 ## Run-time CPU feature detection
 
-[detect](../detect) module has run-time CPU feature detection implementations.
-
-Here is the table of targets that support run-time CPU feature detection and the instruction or API used:
-
-| target_arch | target_os/target_env | instruction/API | features | note |
-| ----------- | -------------------- | --------------- | -------- | ---- |
-| x86_64      | all (except for sgx) | cpuid           | all      | Enabled by default |
-| aarch64     | linux                | getauxval       | all      | Only enabled by default on `*-linux-gnu*`, and `*-linux-musl*"` (default is static linking)/`*-linux-ohos*` (default is dynamic linking) with dynamic linking enabled. |
-| aarch64     | android              | getauxval       | all      | Enabled by default |
-| aarch64     | freebsd              | elf_aux_info    | lse, lse2 | Enabled by default |
-| aarch64     | netbsd               | sysctlbyname    | all      | Enabled by default |
-| aarch64     | openbsd              | sysctl          | all      | Enabled by default |
-| aarch64     | macos/ios/tvos/watchos/visionos | sysctlbyname    | all      | Currently only used in tests (see detect/aarch64_apple.rs). |
-| aarch64     | windows              | IsProcessorFeaturePresent | lse | Enabled by default |
-| aarch64     | fuchsia              | zx_system_get_features | lse | Enabled by default |
-| riscv64     | linux                | riscv_hwprobe   | all      | Currently only used in tests due to LLVM marking zacas as experimental |
-| powerpc64   | linux                | getauxval       | all      | Disabled by default |
-| powerpc64   | freebsd              | elf_aux_info    | all      | Disabled by default |
-| powerpc64   | openbsd              | elf_aux_info    | all      | Disabled by default |
-
-Run-time detection is enabled by default on most targets and can be disabled with `--cfg portable_atomic_no_outline_atomics`.
-
-On some targets, run-time detection is disabled by default mainly for compatibility with older versions of operating systems or incomplete build environments, and can be enabled by `--cfg portable_atomic_outline_atomics`. (When both cfg are enabled, `*_no_*` cfg is preferred.)
-
-For targets not included in the above table, run-time detection is always disabled and works the same as when `--cfg portable_atomic_no_outline_atomics` is set.
-
-See [detect/auxv.rs](../detect/auxv.rs) module-level comments for more details on Linux/Android/FreeBSD/OpenBSD.
-
-See also [docs on `portable_atomic_no_outline_atomics`](https://github.com/taiki-e/portable-atomic/blob/HEAD/README.md#optional-cfg-no-outline-atomics) in the top-level readme.
+See the [`detect` module's readme](../detect/README.md) for run-time CPU feature detection.
diff --git a/src/imp/atomic64/README.md b/src/imp/atomic64/README.md
@@ -17,18 +17,4 @@ On compiler versions or platforms where these are not supported, the fallback im
 
 ## Run-time CPU feature detection
 
-[detect](../detect) module has run-time CPU feature detection implementations.
-
-Here is the table of targets that support run-time CPU feature detection and the instruction or API used:
-
-| target_arch | target_os/target_env | instruction/API | features | note |
-| ----------- | -------------------- | --------------- | -------- | ---- |
-| riscv32     | linux                | riscv_hwprobe   | all      | Currently only used in tests due to LLVM marking zacas as experimental |
-
-Run-time detection is enabled by default on most targets and can be disabled with `--cfg portable_atomic_no_outline_atomics`.
-
-On some targets, run-time detection is disabled by default mainly for compatibility with older versions of operating systems or incomplete build environments, and can be enabled by `--cfg portable_atomic_outline_atomics`. (When both cfg are enabled, `*_no_*` cfg is preferred.)
-
-For targets not included in the above table, run-time detection is always disabled and works the same as when `--cfg portable_atomic_no_outline_atomics` is set.
-
-See also [docs on `portable_atomic_no_outline_atomics`](https://github.com/taiki-e/portable-atomic/blob/HEAD/README.md#optional-cfg-no-outline-atomics) in the top-level readme.
+See the [`detect` module's readme](../detect/README.md) for run-time CPU feature detection.
diff --git a/src/imp/detect/README.md b/src/imp/detect/README.md
@@ -0,0 +1,32 @@
+# Run-time CPU feature detection
+
+This module has run-time CPU feature detection implementations.
+
+Here is the table of targets that support run-time CPU feature detection and the instruction or API used:
+
+| target_arch | target_os/target_env | instruction/API | features | note |
+| ----------- | -------------------- | --------------- | -------- | ---- |
+| x86_64      | all (except for sgx) | cpuid           | all      | Enabled by default |
+| aarch64     | linux                | getauxval       | all      | Only enabled by default on `*-linux-gnu*`, and `*-linux-musl*"` (default is static linking)/`*-linux-ohos*` (default is dynamic linking) with dynamic linking enabled. |
+| aarch64     | android              | getauxval       | all      | Enabled by default |
+| aarch64     | freebsd              | elf_aux_info    | lse, lse2 | Enabled by default |
+| aarch64     | netbsd               | sysctlbyname    | all      | Enabled by default |
+| aarch64     | openbsd              | sysctl          | all      | Enabled by default |
+| aarch64     | macos/ios/tvos/watchos/visionos | sysctlbyname    | all      | Currently only used in tests (see [aarch64_apple.rs](aarch64_apple.rs)). |
+| aarch64     | windows              | IsProcessorFeaturePresent | lse | Enabled by default |
+| aarch64     | fuchsia              | zx_system_get_features | lse | Enabled by default |
+| riscv32     | linux                | riscv_hwprobe   | all      | Currently only used in tests due to LLVM marking zacas as experimental |
+| riscv64     | linux                | riscv_hwprobe   | all      | Currently only used in tests due to LLVM marking zacas as experimental |
+| powerpc64   | linux                | getauxval       | all      | Disabled by default |
+| powerpc64   | freebsd              | elf_aux_info    | all      | Disabled by default |
+| powerpc64   | openbsd              | elf_aux_info    | all      | Disabled by default |
+
+Run-time detection is enabled by default on most targets and can be disabled with `--cfg portable_atomic_no_outline_atomics`.
+
+On some targets, run-time detection is disabled by default mainly for compatibility with older versions of operating systems or incomplete build environments, and can be enabled by `--cfg portable_atomic_outline_atomics`. (When both cfg are enabled, `*_no_*` cfg is preferred.)
+
+For targets not included in the above table, run-time detection is always disabled and works the same as when `--cfg portable_atomic_no_outline_atomics` is set.
+
+See [auxv.rs](auxv.rs) module-level comments for more details on Linux/Android/FreeBSD/OpenBSD.
+
+See also [docs on `portable_atomic_no_outline_atomics`](https://github.com/taiki-e/portable-atomic/blob/HEAD/README.md#optional-cfg-no-outline-atomics) in the top-level readme.