Commit c2a44f15 authored by Thomas Petazzoni's avatar Thomas Petazzoni Committed by Peter Korsgaard
Browse files

initramfs: update help text

parent 93e80147
Loading
Loading
Loading
Loading
+13 −11
Original line number Diff line number Diff line
@@ -2,17 +2,19 @@ config BR2_TARGET_ROOTFS_INITRAMFS
	bool "initramfs for initial ramdisk of linux kernel"
	depends on BR2_LINUX_KERNEL
	help
	  Build a file which is usable for the gen_init_cpio tool
	  at linux kernel build.
	  This file is normally called initramfs_list and can be
	  generated with gen_initramfs_list.sh script from the root
	  directory structure.
	  The file is then used in the kernel build process to generate
	  the cpio filesystem for the initial ramdisk. Make sure that
	  you configure this file in kernel build configuration.
	  The location in the kernel build configuration menu is
	  Device Drivers -> Block devices -> Initramfs source file(s).
	  The configuration variable is CONFIG_INITRAMFS_SOURCE
	  Integrate the root filesystem generated by Buildroot as an
	  initramfs inside the kernel image. This integration will
	  take place automatically.

	  The rootfs.initramfs file generated in the images/ directory
	  is only a text file describing the contents of the initramfs
	  in a format understood by the CONFIG_INITRAMFS_SOURCE kernel
	  configuration option.

	  Note that enabling initramfs together with other filesystem
	  formats doesn't make sense: you would end up having two
	  identical root filesystems, one embedded inside the kernel
	  image, and one separatly.

comment "initramfs requires a Linux kernel to be built"
	depends on !BR2_LINUX_KERNEL