Skip to content

Commit 063dbfd

Browse files
committed
Update readme
1 parent 9e62168 commit 063dbfd

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,25 @@
11
# What is in this fork?
2+
23
This is a minimal initrd for usage with Hocus. UUID based mounts are unreliable when used with conjuction with OverlayBD as most obd images don't have an disk UUID or have the same UUID. This initramfs is designed to mount `virtio-blk` disks by their serial number. To mount an rootfs please use:
34
```
4-
root=SERIAL=<disk_serial>
5+
mountdevice=SERIAL=<disk_serial> mount_target=/
6+
```
7+
Up to 32 boot time mounts are supported:
8+
```
9+
mountdevice=SERIAL=<disk1_serial> mount_target=/
10+
mountdevice=SERIAL=<disk2_serial> mount_target=/mount2
11+
...
12+
mountdevice=SERIAL=<diskN_serial> mount_target=/mountN
513
```
14+
Disks are mounted in the order specified on the kernel cmdline, if a mountpoint does not exist then the target directory including required parent directories will be created. Mount options are customisable:
15+
```
16+
mountdevice=SERIAL=<disk_serial> mount_target=<mount_target> mountflags=<optional_mount_options> mountfstype=<mount_filesystem_type>
17+
```
18+
By specifying `mountfstype` on the command line the OS will boot much faster as the initrd will avoid scanning the disk for the filesystem type.
19+
20+
To build this initrd please run `./docker-build.sh`
621

7-
tiny-initramfs - A minimalistic initramfs implementation
22+
[ORIGINAL README] tiny-initramfs - A minimalistic initramfs implementation
823
========================================================
924

1025
This is a very minimalistic [initramfs](https://en.wikipedia.org/wiki/Initramfs)

0 commit comments

Comments
 (0)