Skip to content

Commit 1ae2089

Browse files
committed
installation/**: grammar/typo/consistency fixes, general updates
closes: #851
1 parent 98ed79d commit 1ae2089

File tree

7 files changed

+51
-56
lines changed

7 files changed

+51
-56
lines changed

src/installation/guides/chroot.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Installation via chroot (x86/x86_64/aarch64)
1+
# Installation via chroot (x86_64/i686/aarch64)
22

33
This guide details the process of manually installing Void via a chroot on an
4-
x86, x86_64 or aarch64 architecture. It is assumed that you have a familiarity
4+
x86_64, i686, or aarch64 architecture. It is assumed that you have a familiarity
55
with Linux, but not necessarily with installing a Linux system via a chroot.
66
This guide can be used to create a "typical" setup, using a single partition on
77
a single SATA/IDE/USB disk. Each step may be modified to create less typical
@@ -41,7 +41,7 @@ for partitioning, but you may wish to use
4141
[gdisk(8)](https://man.voidlinux.org/gdisk.8) (from the package `gptfdisk`) or
4242
[parted(8)](https://man.voidlinux.org/parted.8) instead.
4343

44-
For a UEFI booting system, make sure to create an EFI System Partition (ESP).
44+
For a UEFI system, make sure to create an EFI System Partition (ESP).
4545
The ESP should have the partition type "EFI System" (code `EF00`) and be
4646
formatted as FAT32 using [mkfs.vfat(8)](https://man.voidlinux.org/mkfs.vfat.8).
4747

@@ -96,7 +96,7 @@ variable. A glibc installation, for example, would use:
9696
```
9797

9898
XBPS also needs to know what architecture is being installed. Available options
99-
are `x86_64`, `x86_64-musl`, `i686` for PC architecture computers and `aarch64`.
99+
are `x86_64`, `x86_64-musl`, `i686`, `aarch64`, and `aarch64-musl`.
100100
For example:
101101

102102
```
@@ -105,7 +105,7 @@ For example:
105105

106106
This architecture must be compatible with your current operating system, but
107107
does not need to be the same. If your host is running an x86_64 operating
108-
system, any of the three architectures can be installed (whether the host is
108+
system, x86_64, x86_64-musl, or i686 architectures can be installed (whether the host is
109109
musl or glibc), but an i686 host can only install i686 distributions.
110110

111111
Copy the RSA keys from the installation medium to the target root directory:
@@ -233,7 +233,7 @@ used by your computer's firmware when manually selecting a boot device):
233233

234234
### Troubleshooting GRUB installation
235235

236-
It may be necessary to mount the `efivarfs` filesystem.
236+
On UEFI systems, it may be necessary to mount the `efivarfs` filesystem.
237237

238238
```
239239
[xchroot /mnt] # mount -t efivarfs none /sys/firmware/efi/efivars
@@ -244,7 +244,7 @@ If EFI variables are still not available, add the option `--no-nvram` to the
244244

245245
#### Installing on removable media or non-compliant UEFI systems
246246

247-
Unfortunately, not all systems have a fully standards compliant UEFI
247+
Unfortunately, not all systems have a fully standards-compliant UEFI
248248
implementation. In some cases, it is necessary to "trick" the firmware into
249249
booting by using the default fallback location for the bootloader instead of a
250250
custom one. In that case, or if installing onto a removable disk (such as USB),
@@ -260,6 +260,9 @@ located in `/boot/efi/EFI/Void/grubx64.efi` (its location can be found using
260260
[xchroot /mnt] # cp /boot/efi/EFI/Void/grubx64.efi /boot/efi/EFI/boot/bootx64.efi
261261
```
262262

263+
On i686, these files should be called `grubia32.efi` and `bootia32.efi`. On aarch64,
264+
these files should be called `grubaa64.efi` and `bootaa64.efi`.
265+
263266
## Finalization
264267

265268
Use [xbps-reconfigure(1)](https://man.voidlinux.org/xbps-reconfigure.1) to

src/installation/guides/fde.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Full Disk Encryption
22

3-
**Warning**: Your drive's block device and other information may be different,
4-
so make sure it is correct.
3+
> **Warning**: Your drive's block devices and other information may be different,
4+
> so make sure it is correct instead of copying and pasting directly.
55
66
## Partitioning
77

src/installation/guides/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This section contains guides for more specific or complex use-cases.
44

55
## Section Contents
66

7-
- [Installing Void via chroot (x86 or x86_64)](./chroot.md)
7+
- [Installing Void via chroot (x86_64, i686, or aarch64)](./chroot.md)
88
- [Installing Void with Full Disk Encryption](./fde.md)
99
- [Installing Void on a ZFS Root](./zfs.md)
1010
- [ARM Devices](./arm-devices/index.md)

src/installation/index.md

Lines changed: 31 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,21 @@ section.
66

77
## Base system requirements
88

9-
Void can be installed on very minimalist hardware, though we recommend the
9+
Void can be installed on very low-powered hardware, though we recommend the
1010
following minimums for most installations:
1111

12-
| Architecture | CPU | RAM | Storage |
13-
|--------------|------------------|------|---------|
14-
| x86_64-glibc | x86_64 | 96MB | 700MB |
15-
| x86_64-musl | x86_64 | 96MB | 600MB |
16-
| i686-glibc | Pentium 4 (SSE2) | 96MB | 700MB |
12+
| Architecture | CPU | RAM | Storage |
13+
|--------------|------------------|-------|---------|
14+
| x86_64-glibc | x86_64 | 520MB | 700MB |
15+
| x86_64-musl | x86_64 | 520MB | 600MB |
16+
| i686-glibc | Pentium 4 (SSE2) | 520MB | 700MB |
1717

18-
Note that xfce image installations require more resources.
18+
Note that Xfce installation images require more resources, and more resources
19+
may be required depending on the software being run.
1920

20-
Void is not available for the i386, i486, or i586 architectures.
21+
Void is available on x86_64, i686, aarch64, armv7l, and armv6l architectures.
22+
Both glibc and musl editions are available on all architectures except i686, where only glibc is available.
23+
Void is *not* available for the i386, i486, or i586 architectures.
2124

2225
Before installing musl Void, please read [the "musl" section](./musl.md) of this
2326
Handbook, so that you are aware of software incompatibilities.
@@ -41,26 +44,12 @@ you download. First, there is a `sha256sum.txt` file containing image checksums
4144
to verify the integrity of the downloaded images. Second is the `sha256sum.sig`
4245
file, used to verify the authenticity of the checksums.
4346

44-
It is necessary to verify both the image's integrity and authenticity. It is,
45-
therefore, recommended that you download both files.
46-
47-
### Verifying image integrity
48-
49-
You can verify the integrity of a downloaded file using
50-
[sha256sum(1)](https://man.voidlinux.org/sha256sum.1) with the `sha256sum.txt`
51-
file downloaded above. The following command will check the integrity of only
52-
the image(s) you have downloaded:
53-
54-
```
55-
$ sha256sum -c --ignore-missing sha256sum.txt
56-
void-live-x86_64-musl-20170220.iso: OK
57-
```
58-
59-
This verifies that the image is not corrupt.
47+
It is necessary to verify both the image's integrity and authenticity, so it is
48+
recommended that you download both files.
6049

6150
### Verifying digital signature
6251

63-
Prior to using any image you're strongly encouraged to validate the signatures
52+
Prior to using any image, you're strongly encouraged to validate the signatures
6453
on the image to ensure they haven't been tampered with.
6554

6655
Current images are signed using a minisign key that is specific to the release.
@@ -71,46 +60,49 @@ with your mirror and package signatures. You will also need a copy of
7160
by the `minisign` package.
7261

7362
The `minisign` executable is usually provided by a package of the same name, and
74-
can also be installed on Windows, even without WSL or MinGW.
63+
can also be installed on Windows, even without WSL or MinGW. Binaries are also
64+
[available from minisign's authors](https://jedisct1.github.io/minisign/).
7565

7666
If you are not currently using Void Linux, it will also be necessary to obtain
77-
the appropriate signing key from our Git repository
78-
[here](https://github.com/void-linux/void-packages/tree/master/srcpkgs/void-release-keys/files/).
67+
the appropriate signing key from our [Git
68+
repository](https://github.com/void-linux/void-packages/tree/master/srcpkgs/void-release-keys/files/).
7969

8070
Once you've obtained the key, you can verify your image with the `sha256sum.sig`
8171
and `sha256sum.txt` files. First, you need to verify the authenticity of the
8272
`sha256sum.txt` file.
8373

8474
The following example demonstrates the verification of the `sha256sum.txt` file
85-
for the 20230628 images with `minisign`:
75+
for the 20250202 images with `minisign`:
8676

8777
```
88-
$ minisign -V -p /usr/share/void-release-keys/void-release-20230628.pub -x sha256sum.sig -m sha256sum.txt
78+
$ minisign -V -p /usr/share/void-release-keys/void-release-20250202.pub -x sha256sum.sig -m sha256sum.txt
8979
Signature and comment signature verified
90-
Trusted comment: This key is only valid for images with date 20230628.
80+
Trusted comment: This key is only valid for images with date 20250202.
9181
```
9282

83+
### Verifying image integrity
84+
9385
Finally, you need to verify that the checksum for your image matches the one in
9486
the `sha256sum.txt` file. This can be done with the
9587
[sha256(1)](https://man.voidlinux.org/md5.1) utility from the `outils` package,
96-
as demonstrated below for the 20230628 `x86_64` base image:
88+
as demonstrated below for the 20250202 `x86_64` base image:
9789

9890
```
99-
$ sha256 -C sha256sum.txt void-live-x86_64-20230628-base.iso
100-
(SHA256) void-live-x86_64-20230628-base.iso: OK
91+
$ sha256 -C sha256sum.txt void-live-x86_64-20250202-base.iso
92+
(SHA256) void-live-x86_64-20250202-base.iso: OK
10193
```
10294

10395
Alternatively, if the `sha256` utility isn't available to you, you can use
10496
[sha256sum(1)](https://man.voidlinux.org/sha256sum.1):
10597

10698
```
10799
$ sha256sum -c sha256sum.txt --ignore-missing
108-
void-live-x86_64-20230628-base.iso: OK
100+
void-live-x86_64-20250202-base.iso: OK
109101
```
110102

111103
If neither program is available to you, you can compute the SHA256 hash of the
112-
file and compare it to the value contained in `sha256sum.txt`.
104+
file by hand and compare it to the value contained in `sha256sum.txt`.
113105

114-
If the verification process does not produce the expected "OK" status, do not
115-
use it! Please alert the Void Linux team of where you got the image and how you
116-
verified it, and we will follow up on it.
106+
If the verification process does not produce the expected "OK" status, **do not
107+
use it**! Please alert the Void Linux team of where you got the image and how
108+
you verified it, and we will follow up on it.

src/installation/live-images/guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ To install packages provided on the install image, select `Local`. Otherwise,
5151
you may select `Network` to download the latest packages from the Void
5252
repository.
5353

54-
> **Warning:** If you are installing the desktop environment from the xfce
54+
> **Warning:** If you are installing the desktop environment from the Xfce
5555
> image, you MUST choose `Local` for the source!
5656
5757
## Hostname

src/installation/live-images/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ manually.
1717

1818
## Installer images
1919

20-
Void releases two types of images: base images and xfce images. Linux beginners
21-
are encouraged to try one of the more full-featured xfce images, but more
20+
Void releases two types of images: base images and Xfce images. Linux beginners
21+
are encouraged to try one of the more full-featured Xfce images, but more
2222
advanced users may often prefer to start from a base image to install only the
2323
packages they need.
2424

@@ -30,7 +30,7 @@ update the system, and install additional packages from repositories.
3030

3131
### Xfce image
3232

33-
The xfce image includes a full desktop environment, web browser, and basic
33+
The Xfce image includes a full desktop environment, web browser, and basic
3434
applications configured for that environment. The only difference from the base
3535
images is the additional packages and services installed.
3636

@@ -45,7 +45,7 @@ The following software is included:
4545
- **Other:** Bulk rename, Orage Globaltime, Orage Calendar, Task Manager, Parole
4646
Media Player, Audio Mixer, MIME type editor, Application finder
4747

48-
The install process for the xfce image is the same as the base images, except
48+
The install process for the Xfce image is the same as the base images, except
4949
that you **must** select the `Local` source when installing. If you select
5050
`Network` instead, the installer will download and install the latest version of
5151
the base system, without any additional packages included on the live image.
@@ -80,7 +80,7 @@ If the `Local` installation source is selected in the installer, `espeakup` and
8080
`brltty` will also be installed and enabled on the installed system if enabled
8181
in the live environment.
8282

83-
The xfce image also supports the graphical screenreader
83+
The Xfce image also supports the graphical screenreader
8484
[orca](https://man.voidlinux.org/orca.1). This can be enabled by pressing `Win +
8585
R` and entering `orca -r`. Orca will also be available on the installed system
8686
if the `Local` installation source is selected.

src/installation/musl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ multilib sub-repo.
1313

1414
## Incompatible software
1515

16-
musl practices very strict and minimal standard compliance. Many commonly used
16+
musl practices very strict standards compliance. Many commonly used
1717
platform-specific extensions are not present. Because of this, it is common for
1818
software to need modification to compile and/or function properly. Void
1919
developers work to patch such software and hopefully get portability/correctness

0 commit comments

Comments
 (0)