docs: state OS compatibility explicitly (Linux-only) #160

2026-09-21T06:34:20Z

rootiest commented

2026-09-21 06:34:20 +00:00

Summary

Adds an OS Compatibility section to the README and to docs/manual/10-installation.md: this config is Linux-only, developed and tested on an Arch Linux system.
Lists the specific Linux-only calls with no fallback that make macOS/Windows unsupported: systemd-inhibit (wake-lock), zramctl/swapon (swapstat), sbctl/Secure Boot state (sbver), wl-copy/xclip clipboard access (y, p, paste, hist — no pbcopy/clip.exe fallback), and GNU-only stat -c/numfmt flags (sudo-toggle, dng2avif).
Notes git, gpg, tar, and GNU coreutils as baseline packages this config assumes are present on any Linux system it runs on, rather than tracking them in fish-deps — they're base-system utilities, not opt-in software with an install journey.
Adds os/os-compatibility/operating-system/compatibility/linux/macos/mac/windows/wsl keywords to docs/fish-config.index so help config os (and the other keywords) jump straight to the new section.

Test plan

python3 docs/build-manual.py --concat -o docs/fish-config.md then python3 docs/verify-manual.py (84/84, including the index-keyword-resolution check), then reverted the regenerated file since CI regenerates and commits it after merge
fish tests/run-tests.fish (759/759 assertions, 250-file indent lint)

## Summary - Adds an **OS Compatibility** section to the README and to `docs/manual/10-installation.md`: this config is Linux-only, developed and tested on an Arch Linux system. - Lists the specific Linux-only calls with no fallback that make macOS/Windows unsupported: `systemd-inhibit` (`wake-lock`), `zramctl`/`swapon` (`swapstat`), `sbctl`/Secure Boot state (`sbver`), `wl-copy`/`xclip` clipboard access (`y`, `p`, `paste`, `hist` — no `pbcopy`/`clip.exe` fallback), and GNU-only `stat -c`/`numfmt` flags (`sudo-toggle`, `dng2avif`). - Notes `git`, `gpg`, `tar`, and GNU coreutils as baseline packages this config assumes are present on any Linux system it runs on, rather than tracking them in `fish-deps` — they're base-system utilities, not opt-in software with an install journey. - Adds `os`/`os-compatibility`/`operating-system`/`compatibility`/`linux`/`macos`/`mac`/`windows`/`wsl` keywords to `docs/fish-config.index` so `help config os` (and the other keywords) jump straight to the new section. ## Test plan - [x] `python3 docs/build-manual.py --concat -o docs/fish-config.md` then `python3 docs/verify-manual.py` (84/84, including the index-keyword-resolution check), then reverted the regenerated file since CI regenerates and commits it after merge - [x] `fish tests/run-tests.fish` (759/759 assertions, 250-file indent lint)

rootiest added the Kind/Documentation Area/Docs labels 2026-09-21 06:34:20 +00:00

rootiest added 1 commit 2026-09-21 06:34:22 +00:00

docs: state OS compatibility explicitly (Linux-only) 7c59caebce

Adds an OS Compatibility section to the README and the Installation
manual page: developed and tested on Arch Linux, macOS and Windows
unsupported, with the specific Linux-only calls that back that claim
(systemd-inhibit, zramctl/swapon, sbctl, wl-copy/xclip with no
pbcopy/clip.exe fallback, GNU-only stat/numfmt flags) and the baseline
packages (git, gpg, tar, coreutils) assumed present rather than tracked
by fish-deps.

Adds os/os-compatibility/operating-system/compatibility/linux/macos/
mac/windows/wsl keywords to fish-config.index so `help config os` and
friends jump straight to it.

rootiest merged commit 2686415db5 into main

2026-09-21 06:35:37 +00:00

rootiest deleted branch docs/os-compatibility

2026-09-21 06:35:37 +00:00

rootiest referenced this pull request

2026-09-21 06:54:26 +00:00

feat(clipboard): fill the WSL2 clipboard gap with win32yank #161

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: rootiest/fish-config#160