void-linux / void-linux/void-docs

Unify handling of swap space in docs and void-installer

Open
#647 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
217
Forks
212
Avg merge
2d 21h
Merged PRs (30d)
1

Description

Right now the official docs say in chroot.md for swap in the fstab:

UUID=1cb4[...]  swap        swap    rw,noatime,discard      0 0

fde.md says:

/dev/voidvm/swap  swap  swap    defaults              0       0

The void-installer does:

echo "UUID=$uuid none swap sw 0 0" >>$TARGET_FSTAB

Archwiki says:

UUID=device_UUID none swap defaults 0 0

fstab(5) says:

  • for swap, use none for second field

If the discard option is used, then probably the docs + installer should also say/do swapon -d.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the swap examples in chroot.md and fde.md with the swap entry emitted by void-installer, then check the fstab(5) guidance cited in the issue. Unify the documented and installer-generated syntax and clarify how discard should be handled, with matching results in both documentation and installer behavior.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, tooling
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.