summaryrefslogtreecommitdiffstats
path: root/doc/user_images.inc
diff options
context:
space:
mode:
authorJuergen Borleis <jbe@pengutronix.de>2016-06-09 11:56:52 +0200
committerMichael Olbrich <m.olbrich@pengutronix.de>2016-06-20 15:04:56 +0200
commit50d238522588f8b320da924d82febaf0c2ffc6dc (patch)
tree8648a48232a0ca23ec98a5a57699f26a8dfebd9f /doc/user_images.inc
parentee05281068c95b79d2e50fe30fedb3bebeb4b586 (diff)
downloadptxdist-50d238522588f8b320da924d82febaf0c2ffc6dc.tar.gz
ptxdist-50d238522588f8b320da924d82febaf0c2ffc6dc.tar.xz
Split the user manual section into separate file
...to be able to replace or append the content individually. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
Diffstat (limited to 'doc/user_images.inc')
-rw-r--r--doc/user_images.inc32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/user_images.inc b/doc/user_images.inc
new file mode 100644
index 000000000..2e6d4fa9b
--- /dev/null
+++ b/doc/user_images.inc
@@ -0,0 +1,32 @@
+Creating a Root Filesystem Image
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+After we have built the root filesystem content, we can make an image,
+which can be flashed to the target system or copied on some kind of disk
+media. To do so, we just run
+
+::
+
+ $ ptxdist images
+
+PTXdist now extracts the content of priorly created *\*.ipk* packages to
+a temporary directory and generates an image out of it. PTXdist supports
+following image types:
+
+- **hd.img:** contains bootloader, kernel and root files in an ext2
+- partition. Mostly used for X86 target systems.
+
+- **root.jffs2:** root files inside a jffs2 filesystem.
+
+- **uRamdisk:** a u-boot loadable Ramdisk
+
+- **initrd.gz:** a traditional initrd RAM disk to be used as initrdramfs
+- by the kernel
+
+- **root.ext2:** root files inside an ext2 filesystem.
+
+- **root.squashfs:** root files inside a squashfs filesystem.
+
+- **root.tgz:** root files inside a plain gzip compressed tar ball.
+
+All these files can be found in ``images`` if enabled.