Update documentation accordingly.
Link: https://salsa.debian.org/raspi-team/image-specs/-/issues/75
This commit is contained in:
47
README.md
47
README.md
@@ -57,44 +57,49 @@ Otherwise, because some steps of building the image require root privileges,
|
|||||||
you'll need to execute `make` as root.
|
you'll need to execute `make` as root.
|
||||||
|
|
||||||
The argument to `make` is constructed as follows:
|
The argument to `make` is constructed as follows:
|
||||||
`raspi_<model>_<release>.<result-type>`
|
`raspi_<arch>_<release>.<result-type>`
|
||||||
|
|
||||||
Whereby <model\> is one of `1`, `2`, `3` or `4`, <release\> is either
|
Whereby `<arch>` is one of `armhf` or `arm64`, `<release>` is either
|
||||||
`bullseye`, `bookworm`, or `trixie`; and <result-type\> is `img` or `yaml`.
|
`bookworm`, or `trixie`; and `<result-type>` is `img` or `yaml`.
|
||||||
|
|
||||||
Model `1` should be used for the Raspberry Pi 0, 0w and 1, models A and
|
Architecture `armel` is no longer supported in Debian, and that would have been
|
||||||
B. Model `2` for the Raspberry Pi 2 models A and B. Model `3` for all
|
used for the Raspberry Pi 0, 0w and 1, models A and B.
|
||||||
models of the Raspberry Pi 3 and model `4` for all models of the
|
|
||||||
Raspberry Pi 4.
|
Architecture `armhf` is for Raspberry Pi 2 models A and B.
|
||||||
So if you want to build the default image for a Raspberry Pi 3B+ with
|
|
||||||
Bullseye, you can just issue:
|
Architecture `arm64` is for Raspberry Pi 3, Pi 4, and Pi 5 (new in forky),
|
||||||
|
alongside Compute Module 3, Compule Module 4, and Pi 400.
|
||||||
|
|
||||||
|
So if you want to build the default image for a Raspberry Pi 3B+ with Trixie,
|
||||||
|
you can just issue:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
make raspi_3_bullseye.img
|
make raspi_arm64_trixie.img
|
||||||
```
|
```
|
||||||
|
|
||||||
This will first create a `raspi_3_bullseye.yaml` file and then use that
|
This will first create a `raspi_arm64_trixie.yaml` file and then use that
|
||||||
*yaml* recipe to build the image with `vmdb2`.
|
*yaml* recipe to build the image with `vmdb2`.
|
||||||
|
|
||||||
You can also edit the `yaml` file to customize the built image. If you
|
You can also edit the `yaml` file to customize the built image. If you
|
||||||
want to start from the platform-specific recipe, you can issue:
|
want to start from the platform-specific recipe, you can issue:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
make raspi_3_bullseye.yaml
|
make raspi_arm64_trixie.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
The recipe drives [vmdb2](https://vmdb2.liw.fi/), the successor to
|
The recipe drives [vmdb2](https://vmdb2.liw.fi/), the successor to
|
||||||
`vmdebootstrap`. Please refer to [its
|
`vmdebootstrap`. Please refer to [its
|
||||||
documentation](https://vmdb2.liw.fi/documentation/) for further details;
|
documentation](https://vmdb2.liw.fi/documentation/) for further details;
|
||||||
it is quite an easy format to understand.
|
it is quite an easy format to understand.
|
||||||
|
|
||||||
Copy the generated file to a name descriptive enough for you (say,
|
Copy the generated file to a name descriptive enough for you (say,
|
||||||
`my_raspi_bullseye.yaml`). Once you have edited the recipe for your
|
`my_raspi_trixie.yaml`). Once you have edited the recipe for your
|
||||||
specific needs, you can generate the image by issuing the following (as
|
specific needs, you can generate the image by issuing the following (as
|
||||||
root):
|
root):
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
vmdb2 --rootfs-tarball=my_raspi_bullseye.tar.gz --output \
|
vmdb2 --rootfs-tarball=my_raspi_trixie.tar.gz --output \
|
||||||
my_raspi_bullseye.img my_raspi_bullseye.yaml --log my_raspi_bullseye.log
|
my_raspi_trixie.img my_raspi_trixie.yaml --log my_raspi_trixie.log
|
||||||
```
|
```
|
||||||
|
|
||||||
This is, just follow what is done by the `_build_img` target of the
|
This is, just follow what is done by the `_build_img` target of the
|
||||||
@@ -110,25 +115,25 @@ important parts of your system. Double check it's the correct
|
|||||||
device!), copy the image onto the SD card:
|
device!), copy the image onto the SD card:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
bmaptool copy raspi_3_bullseye.img.xz /dev/mmcblk0
|
bmaptool copy raspi_arm64_trixie.img.xz /dev/mmcblk0
|
||||||
```
|
```
|
||||||
|
|
||||||
Alternatively, if you don't have `bmap-tools` installed, you can use
|
Alternatively, if you don't have `bmap-tools` installed, you can use
|
||||||
`dd` with the compressed image:
|
`dd` with the compressed image:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
xzcat raspi_3_bullseye.img.xz | dd of=/dev/mmcblk0 bs=64k oflag=dsync status=progress
|
xzcat raspi_arm64_trixie.img.xz | dd of=/dev/mmcblk0 bs=64k oflag=dsync status=progress
|
||||||
```
|
```
|
||||||
|
|
||||||
Or with the uncompressed image:
|
Or with the uncompressed image:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
dd if=raspi_3_bullseye.img of=/dev/mmcblk0 bs=64k oflag=dsync status=progress
|
dd if=raspi_arm64_trixie.img of=/dev/mmcblk0 bs=64k oflag=dsync status=progress
|
||||||
```
|
```
|
||||||
|
|
||||||
Then, plug the SD card into the Raspberry Pi, and power it up.
|
Then, plug the SD card into the Raspberry Pi, and power it up.
|
||||||
|
|
||||||
The image uses the hostname `rpi0w`, `rpi2`, `rpi3`, or `rpi4` depending on the
|
The image uses the hostname `rpi-armhf` or `rpi-arm64` depending on the
|
||||||
target build. The provided image will allow you to log in with the
|
target build. The provided image will allow you to log in with the
|
||||||
`root` account with no password set, but only logging in at the
|
`root` account with no password set, but only logging in at the
|
||||||
physical console (be it serial or by USB keyboard and HDMI monitor).
|
physical console (be it serial or by USB keyboard and HDMI monitor).
|
||||||
|
|||||||
Reference in New Issue
Block a user