Skip to content

Commit c9180e2

Browse files
Merge pull request #734 from raspberrypi/develop
Publish community PRs
2 parents b47f68f + ea1a4c5 commit c9180e2

5 files changed

Lines changed: 36 additions & 7 deletions

File tree

‎documentation/asciidoc/computers/config_txt/boot.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ NOTE: Newer firmware supports the loading of multiple `ramfs` files. You should
7373
[[initramfs]]
7474
=== `initramfs`
7575

76+
NOTE: Building and updating `initramfs` is considered an advanced technique that's undertaken only by experienced users. It isn't officially supported by Raspberry Pi and we therefore don't provide instructions for it.
77+
7678
The `initramfs` command specifies both the ramfs filename *and* the memory address to which to load it. It performs the actions of both `ramfsfile` and `ramfsaddr` in one parameter. The address can also be `followkernel` (or `0`) to place it in memory after the kernel image. Example values are: `initramfs initramf.gz 0x00800000` or `initramfs init.gz followkernel`. As with `ramfsfile`, newer firmwares allow the loading of multiple files by comma-separating their names.
7779

7880
NOTE: This option uses different syntax from all the other options, and you should not use the `=` character here.

‎documentation/asciidoc/computers/configuration/reference.adoc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,11 @@ Text-based housekeeping information containing the date and git commit ID of the
5050

5151
==== `initramfs*`
5252

53+
NOTE: Building and updating `initramfs` is considered an advanced technique that's undertaken only by experienced users. It isn't officially supported by Raspberry Pi and we therefore don't provide instructions for it.
54+
5355
Contents of the initial ramdisk. This loads a temporary root file system into memory before the real root file system can be mounted.
5456

55-
Raspberry Pi OS _Bookworm_ includes an `initramfs` file by default. To enable the initial ramdisk, configure it in xref:config_txt.adoc[`config.txt`] with the xref:config_txt.adoc#auto_initramfs[`auto_initramfs`] keyword.
57+
Raspberry Pi OS _Bookworm_ and later include an `initramfs` file by default. To enable the initial ramdisk, configure it in xref:config_txt.adoc[`config.txt`] with the xref:config_txt.adoc#auto_initramfs[`auto_initramfs`] keyword.
5658

5759
Raspberry Pi OS _Trixie_ includes the `auto_initramfs` keyword by default.
5860

‎documentation/asciidoc/computers/linux_kernel/building.adoc‎

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -223,16 +223,29 @@ $ sudo reboot
223223

224224
[TIP]
225225
====
226-
Alternatively, copy the kernel with a different filename (for example, `kernel-myconfig.img`) instead of overwriting the `kernel.img` file. Then, edit `config.txt` in the boot partition to select your kernel:
226+
Alternatively, copy the kernel with a different filename (for example, `kernel-myconfig.img`) instead of overwriting the `$KERNEL.img` file. Then, edit `config.txt` in the boot partition to select your kernel:
227227
228228
[source,ini]
229229
----
230230
kernel=kernel-myconfig.img
231231
----
232232
233233
Combine this approach with a custom `LOCALVERSION` to keep your custom kernel separate from the stock kernel image managed by the system. With this arrangement, you can quickly revert to a stock kernel in the event that your kernel cannot boot.
234+
235+
Raspberry Pi OS Bookworm and later include an `initramfs` by default, enabled by using `auto_initramfs` in `config.txt`.
236+
237+
When `auto_initramfs` is set to `1`, the firmware expects the `initramfs` filename to match the kernel filename by replacing the `kernel` prefix with `initramfs` (and omitting any file extension). For example, `kernel-myconfig.img` looks for `initramfs-myconfig`.
238+
239+
If you don't provide a matching filename, you must specify the ramdisk using an explicit `initramfs` directive without an `=` sign, for example:
240+
241+
[source,ini]
242+
----
243+
initramfs <filename> followkernel
244+
----
234245
====
235246

247+
NOTE: Building and updating `initramfs` is considered an advanced technique that's undertaken only by experienced users. It isn't officially supported by Raspberry Pi and we therefore don't provide instructions for it.
248+
236249
=== Cross-compile the kernel
237250

238251
First, you will need a suitable Linux cross-compilation host. We tend to use Ubuntu; since Raspberry Pi OS is also a Debian distribution, compilation commands are similar.
@@ -459,15 +472,24 @@ $ sudo umount mnt/root
459472

460473
Finally, connect the boot media to your Raspberry Pi and connect it to power to run your freshly-compiled kernel.
461474

462-
463475
[TIP]
464476
====
465-
Alternatively, copy the kernel with a different filename (for example, `kernel-myconfig.img`) instead of overwriting the `kernel.img` file. Then, edit `config.txt` in the boot partition to select your kernel:
477+
Alternatively, copy the kernel with a different filename (for example, `kernel-myconfig.img`) instead of overwriting the `$KERNEL.img` file. Then, edit `config.txt` in the boot partition to select your kernel:
466478
467479
[source,ini]
468480
----
469481
kernel=kernel-myconfig.img
470482
----
471483
472484
Combine this approach with a custom `LOCALVERSION` to keep your custom kernel separate from the stock kernel image managed by the system. With this arrangement, you can quickly revert to a stock kernel in the event that your kernel cannot boot.
473-
====
485+
486+
Raspberry Pi OS Bookworm and later include an `initramfs` by default, enabled by using `auto_initramfs` in `config.txt`.
487+
488+
When `auto_initramfs` is set to `1`, the firmware expects the `initramfs` filename to match the kernel filename by replacing the `kernel` prefix with `initramfs` (and omitting any file extension). For example, `kernel-myconfig.img` looks for `initramfs-myconfig`.
489+
490+
If you don't provide a matching filename, you must specify the ramdisk using an explicit `initramfs` directive without an `=` sign, for example:
491+
492+
[source,ini]
493+
----
494+
initramfs <filename> followkernel
495+
----

‎documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,9 @@ Default: `""` (not set)
475475

476476
The Raspberry Pi Imager application is configured with a JSON file downloaded at startup. By default, Raspberry Pi Imager uses the JSON at https://downloads.raspberrypi.com/os_list_imagingutility_v4.json.
477477

478-
Set `IMAGER_REPO_URL` in the EEPROM configuration to specify the location of the JSON file to use during a network install with the embedded Raspberry Pi Imager.
478+
// Set `IMAGER_REPO_URL` in the EEPROM configuration to specify the location of the JSON file to use during a network install with the embedded Raspberry Pi Imager.
479+
480+
NOTE: Using `IMAGER_REPO_URL` to configure a network install with the embedded Raspberry Pi Imager isn't currently supported because of a https://github.com/raspberrypi/rpi-imager/issues/894[known issue].
479481

480482
You can also change the URL of the JSON file used by the Raspberry Pi Imager application to get it to offer your own images by one of the following methods:
481483

‎documentation/asciidoc/microcontrollers/micropython/what-is-micropython.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
MicroPython is a full implementation of the Python 3 programming language that runs directly on embedded hardware like Raspberry Pi Pico. You get an interactive prompt (the REPL) to execute commands immediately through USB Serial, and a built-in filesystem. The Pico port of MicroPython includes modules for accessing low-level chip-specific hardware.
44

55
* The https://github.com/micropython/micropython/wiki[MicroPython Wiki]
6-
* The https://forum.micropython.org/[MicroPython Forums]
6+
* The https://github.com/orgs/micropython/discussions/[MicroPython Discussions]
7+
* https://discord.com/invite/RB8HZSAExQ[MicroPython's Discord]

0 commit comments

Comments
 (0)